Class: Audio::DriverBase
Overview
Base class for all audio drivers (mainly definition)
Direct Known Subclasses
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
-
#fade_channel_out(channel, duration)
Fade a channel out.
-
#get_channel_audio_position(channel) ⇒ Integer
Get a channel audio position.
-
#get_channel_duration(channel) ⇒ Integer
Get a channel duration.
-
#mute_channel(channel)
Mute a channel forever.
-
#mute_channel_for(channel, duration)
Mute a channel for an amount of time.
-
#play_music(channel, filename, volume, pitch, fade_with_previous, position = nil)
Play a music (looped).
-
#play_sound(channel, filename, volume, pitch)
Play a sound (just once).
-
#release
Release the driver.
-
#reset
Reset the driver.
-
#set_channel_audio_position(channel, position)
Set a channel audio position.
-
#set_channel_volume(channel, volume)
Set a channel volume.
-
#stop_channel(channel)
Stop a channel.
-
#unmute_channel(channel)
Unmute a channel.
-
#update
Update the driver (must be called every meaningful frames).
Instance Method Details
#fade_channel_out(channel, duration)
Fade a channel out
2852 2853 |
# File 'docs/0_Dependencies.rb', line 2852 def fade_channel_out(channel, duration) end |
#get_channel_audio_position(channel) ⇒ Integer
Get a channel audio position
2866 2867 |
# File 'docs/0_Dependencies.rb', line 2866 def get_channel_audio_position(channel) end |
#get_channel_duration(channel) ⇒ Integer
Get a channel duration
2889 2890 |
# File 'docs/0_Dependencies.rb', line 2889 def get_channel_duration(channel) end |
#mute_channel(channel)
Mute a channel forever
2880 2881 |
# File 'docs/0_Dependencies.rb', line 2880 def mute_channel(channel) end |
#mute_channel_for(channel, duration)
Mute a channel for an amount of time
2876 2877 |
# File 'docs/0_Dependencies.rb', line 2876 def mute_channel_for(channel, duration) end |
#play_music(channel, filename, volume, pitch, fade_with_previous, position = nil)
Play a music (looped)
2847 2848 |
# File 'docs/0_Dependencies.rb', line 2847 def play_music(channel, filename, volume, pitch, fade_with_previous, position = nil) end |
#play_sound(channel, filename, volume, pitch)
Play a sound (just once)
2838 2839 |
# File 'docs/0_Dependencies.rb', line 2838 def play_sound(channel, filename, volume, pitch) end |
#release
Release the driver
2831 2832 |
# File 'docs/0_Dependencies.rb', line 2831 def release end |
#reset
Reset the driver
2828 2829 |
# File 'docs/0_Dependencies.rb', line 2828 def reset end |
#set_channel_audio_position(channel, position)
Set a channel audio position
2871 2872 |
# File 'docs/0_Dependencies.rb', line 2871 def set_channel_audio_position(channel, position) end |
#set_channel_volume(channel, volume)
Set a channel volume
2861 2862 |
# File 'docs/0_Dependencies.rb', line 2861 def set_channel_volume(channel, volume) end |
#stop_channel(channel)
Stop a channel
2856 2857 |
# File 'docs/0_Dependencies.rb', line 2856 def stop_channel(channel) end |
#unmute_channel(channel)
Unmute a channel
2884 2885 |
# File 'docs/0_Dependencies.rb', line 2884 def unmute_channel(channel) end |
#update
Update the driver (must be called every meaningful frames)
2825 2826 |
# File 'docs/0_Dependencies.rb', line 2825 def update end |