Class: Audio::SFMLAudioDriver

Inherits:
DriverBase show all
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

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

Parameters:

  • channel (Symbol) —

    channel to fade

  • duration (Integer) —

    duration of the fade out in ms



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

Parameters:

  • channel (Symbol)

Returns:

  • (Integer) —

    channel audio position in driver's unit



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

Parameters:

  • channel (Symbol)

Returns:

  • (Integer)


3126
3127
# File 'docs/0_Dependencies.rb', line 3126

def get_channel_duration(channel)
end

#mute_channel(channel)

Mute a channel until unmuted

Parameters:

  • channel (Symbol)


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

Parameters:

  • channel (Symbol)
  • duration (Integer) —

    mute duration in driver's time. Here, in seconds.



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)

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

  • position (Integer, nil) (defaults to: nil) —

    optional starting position



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)

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)



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

Parameters:

  • channel (Symbol)
  • position (Integer) —

    audio position in driver's unit



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

Parameters:

  • channel (Symbol) —

    channel to set the volume

  • volume (Integer) —

    volume of the channel (0~100)



3098
3099
# File 'docs/0_Dependencies.rb', line 3098

def set_channel_volume(channel, volume)
end

#stop_channel(channel)

Stop a channel

Parameters:

  • channel (Symbol) —

    channel to stop



3093
3094
# File 'docs/0_Dependencies.rb', line 3093

def stop_channel(channel)
end

#unmute_channel(channel)

Unmute a channel

Parameters:

  • channel (Symbol)


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