Class: Audio::SFMLAudioDriver
- Inherits:
-
DriverBase
- Object
- DriverBase
- Audio::SFMLAudioDriver
- Defined in:
- docs/0_Dependencies.rb
Overview
Class that manage the SFML audio driver
Constant Summary
Constants inherited from DriverBase
DriverBase::AUDIO_FILENAME_EXTENSIONS
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 ⇒ SFMLAudioDriver
constructor
Create a new SFML Audio 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.
Constructor Details
#initialize ⇒ SFMLAudioDriver
Create a new SFML Audio Driver
3059 3060 |
# File 'docs/0_Dependencies.rb', line 3059 def initialize end |
Instance Method Details
#fade_channel_out(channel, duration)
Fade a channel out
3089 3090 |
# File 'docs/0_Dependencies.rb', line 3089 def fade_channel_out(channel, duration) end |
#get_channel_audio_position(channel) ⇒ Integer
Get a channel audio position
3103 3104 |
# File 'docs/0_Dependencies.rb', line 3103 def get_channel_audio_position(channel) end |
#get_channel_duration(channel) ⇒ Integer
Get a channel duration
3126 3127 |
# File 'docs/0_Dependencies.rb', line 3126 def get_channel_duration(channel) end |
#mute_channel(channel)
Mute a channel until unmuted
3117 3118 |
# File 'docs/0_Dependencies.rb', line 3117 def mute_channel(channel) end |
#mute_channel_for(channel, duration)
Mute a channel for an amount of time
3113 3114 |
# File 'docs/0_Dependencies.rb', line 3113 def mute_channel_for(channel, duration) end |
#play_music(channel, filename, volume, pitch, fade_with_previous, position = nil)
Play a music (looped)
3084 3085 |
# File 'docs/0_Dependencies.rb', line 3084 def play_music(channel, filename, volume, pitch, fade_with_previous, position = nil) end |
#play_sound(channel, filename, volume, pitch)
Play a sound (just once)
3075 3076 |
# File 'docs/0_Dependencies.rb', line 3075 def play_sound(channel, filename, volume, pitch) end |
#release
Release the driver
3065 3066 |
# File 'docs/0_Dependencies.rb', line 3065 def release end |
#reset
Reset the driver
3062 3063 |
# File 'docs/0_Dependencies.rb', line 3062 def reset end |
#set_channel_audio_position(channel, position)
Set a channel audio position
3108 3109 |
# File 'docs/0_Dependencies.rb', line 3108 def set_channel_audio_position(channel, position) end |
#set_channel_volume(channel, volume)
Set a channel volume
3098 3099 |
# File 'docs/0_Dependencies.rb', line 3098 def set_channel_volume(channel, volume) end |
#stop_channel(channel)
Stop a channel
3093 3094 |
# File 'docs/0_Dependencies.rb', line 3093 def stop_channel(channel) end |
#unmute_channel(channel)
Unmute a channel
3121 3122 |
# File 'docs/0_Dependencies.rb', line 3121 def unmute_channel(channel) end |
#update
Update the driver
3068 3069 |
# File 'docs/0_Dependencies.rb', line 3068 def update end |