Class: Audio::FMODDriver
- Inherits:
-
DriverBase
- Object
- DriverBase
- Audio::FMODDriver
- Defined in:
- docs/0_Dependencies.rb
Overview
Class that manage the FMOD audio driver
Constant Summary collapse
- AUDIO_FILENAME_EXTENSIONS =
List of the Audio extension that are supported
['.ogg', '.mp3', '.wav', '.mid', '.aac', '.wma', '.it', '.xm', '.mod', '.s3m', '.midi', '.flac']
- AUDIO_PRIORITIES =
List of Audio Priorities (if not found => 128)
{bgm: 0, me: 1, bgs: 2, se: 250, cries: 249}
- FADE_IN_TIME =
Time of the audio fade in
250- @@BUG_FMOD_INITIALIZED =
false
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.
-
#initialize ⇒ FMODDriver
constructor
Create a new FMOD driver.
-
#mute_channel(channel)
Mute a channel until unmuted.
-
#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).
Constructor Details
#initialize ⇒ FMODDriver
Create a new FMOD driver
3165 3166 |
# File 'docs/0_Dependencies.rb', line 3165 def initialize end |
Instance Method Details
#fade_channel_out(channel, duration)
Fade a channel out
3195 3196 |
# File 'docs/0_Dependencies.rb', line 3195 def fade_channel_out(channel, duration) end |
#get_channel_audio_position(channel) ⇒ Integer
Get a channel audio position
3209 3210 |
# File 'docs/0_Dependencies.rb', line 3209 def get_channel_audio_position(channel) end |
#get_channel_duration(channel) ⇒ Integer
Get a channel duration
3232 3233 |
# File 'docs/0_Dependencies.rb', line 3232 def get_channel_duration(channel) end |
#mute_channel(channel)
Mute a channel until unmuted
3218 3219 |
# File 'docs/0_Dependencies.rb', line 3218 def mute_channel(channel) end |
#mute_channel_for(channel, duration)
Mute a channel for an amount of time
3223 3224 |
# File 'docs/0_Dependencies.rb', line 3223 def mute_channel_for(channel, duration) end |
#play_music(channel, filename, volume, pitch, fade_with_previous, position = nil)
Play a music (looped)
3190 3191 |
# File 'docs/0_Dependencies.rb', line 3190 def play_music(channel, filename, volume, pitch, fade_with_previous, position = nil) end |
#play_sound(channel, filename, volume, pitch)
Play a sound (just once)
3181 3182 |
# File 'docs/0_Dependencies.rb', line 3181 def play_sound(channel, filename, volume, pitch) end |
#release
Release the driver
3174 3175 |
# File 'docs/0_Dependencies.rb', line 3174 def release end |
#reset
Reset the driver
3171 3172 |
# File 'docs/0_Dependencies.rb', line 3171 def reset end |
#set_channel_audio_position(channel, position)
Set a channel audio position
3214 3215 |
# File 'docs/0_Dependencies.rb', line 3214 def set_channel_audio_position(channel, position) end |
#set_channel_volume(channel, volume)
Set a channel volume
3204 3205 |
# File 'docs/0_Dependencies.rb', line 3204 def set_channel_volume(channel, volume) end |
#stop_channel(channel)
Stop a channel
3199 3200 |
# File 'docs/0_Dependencies.rb', line 3199 def stop_channel(channel) end |
#unmute_channel(channel)
Unmute a channel
3227 3228 |
# File 'docs/0_Dependencies.rb', line 3227 def unmute_channel(channel) end |
#update
Update the driver (must be called every meaningful frames)
3168 3169 |
# File 'docs/0_Dependencies.rb', line 3168 def update end |