Class: Audio::DriverBase

Inherits:
Object show all
Defined in:
docs/0_Dependencies.rb

Overview

Base class for all audio drivers (mainly definition)

Direct Known Subclasses

FMODDriver, SFMLAudioDriver

Constant Summary collapse

AUDIO_FILENAME_EXTENSIONS =

List of the Audio extension that are supported

['.ogg', '.mp3', '.wav', '.flac']
@@logged_audio_filenames = 
[]

Instance Method Summary collapse

Instance Method Details

#fade_channel_out(channel, duration)

Fade a channel out

Parameters:

  • channel (Symbol) —

    channel to fade

  • duration (Integer) —

    duration of the fade out in ms



2574
2575
 
# File 'docs/0_Dependencies.rb', line 2574

def fade_channel_out(channel, duration)
end

#get_channel_audio_position(channel) ⇒ Integer

Get a channel audio position

Parameters:

  • channel (Symbol)

Returns:

  • (Integer) —

    channel audio position in driver’s unit



2588
2589
 
# File 'docs/0_Dependencies.rb', line 2588

def get_channel_audio_position(channel)
end

#get_channel_duration(channel) ⇒ Integer

Get a channel duration

Parameters:

  • channel (Symbol)

Returns:

  • (Integer) 


2607
2608
 
# File 'docs/0_Dependencies.rb', line 2607

def get_channel_duration(channel)
end

#mute_channel_for(channel, duration)

Mute a channel for an amount of time

Parameters:

  • channel (Symbol)
  • duration (Integer) —

    mute duration in driver’s time



2598
2599
 
# File 'docs/0_Dependencies.rb', line 2598

def mute_channel_for(channel, duration)
end

#play_music(channel, filename, volume, pitch, fade_with_previous)

Play a music (looped)

Parameters:

  • channel (Symbol) —

    channel for the music (:bgm, :bgs)

  • filename (String) —

    name of the sound

  • volume (Integer) —

    volume of the sound (0~100)

  • pitch (Integer) —

    pitch of the sound (50~150)

  • fade_with_previous (Boolean) —

    if the previous music should be faded with this one



2569
2570
 
# File 'docs/0_Dependencies.rb', line 2569

def play_music(channel, filename, volume, pitch, fade_with_previous)
end

#play_sound(channel, filename, volume, pitch)

Play a sound (just once)

Parameters:

  • channel (Symbol) —

    channel for the sound (:se, :me)

  • filename (String) —

    name of the sound

  • volume (Integer) —

    volume of the sound (0~100)

  • pitch (Integer) —

    pitch of the sound (50~150)



2561
2562
 
# File 'docs/0_Dependencies.rb', line 2561

def play_sound(channel, filename, volume, pitch)
end

#release

Release the driver



2554
2555
 
# File 'docs/0_Dependencies.rb', line 2554

def release
end

#reset

Reset the driver



2551
2552
 
# File 'docs/0_Dependencies.rb', line 2551

def reset
end

#set_channel_audio_position(channel, position)

Set a channel audio position

Parameters:

  • channel (Symbol)
  • position (Integer) —

    audio position in driver’s unit



2593
2594
 
# File 'docs/0_Dependencies.rb', line 2593

def set_channel_audio_position(channel, position)
end

#set_channel_volume(channel, volume)

Set a channel volume

Parameters:

  • channel (Symbol) —

    channel to set the volume

  • volume (Integer) —

    volume of the channel (0~100)



2583
2584
 
# File 'docs/0_Dependencies.rb', line 2583

def set_channel_volume(channel, volume)
end

#stop_channel(channel)

Stop a channel

Parameters:

  • channel (Symbol) —

    channel to stop



2578
2579
 
# File 'docs/0_Dependencies.rb', line 2578

def stop_channel(channel)
end

#unmute_channel(channel)

Unmute a channel

Parameters:

  • channel (Symbol) 


2602
2603
 
# File 'docs/0_Dependencies.rb', line 2602

def unmute_channel(channel)
end

#update

Update the driver (must be called every meaningful frames)



2548
2549
 
# File 'docs/0_Dependencies.rb', line 2548

def update
end