Class: Audio::SFMLAudioDriver

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

Constant Summary

Constants inherited from DriverBase

DriverBase::AUDIO_FILENAME_EXTENSIONS

Instance Method Summary collapse

Constructor Details

#initialize ⇒ SFMLAudioDriver

Create a new SFML Audio Driver



2765
2766
 
# File 'docs/0_Dependencies.rb', line 2765

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



2794
2795
 
# File 'docs/0_Dependencies.rb', line 2794

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



2808
2809
 
# File 'docs/0_Dependencies.rb', line 2808

def get_channel_audio_position(channel)
end

#get_channel_duration(channel) ⇒ Integer

Get a channel duration

Parameters:

  • channel (Symbol)

Returns:

  • (Integer) 


2827
2828
 
# File 'docs/0_Dependencies.rb', line 2827

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



2818
2819
 
# File 'docs/0_Dependencies.rb', line 2818

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



2789
2790
 
# File 'docs/0_Dependencies.rb', line 2789

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)



2781
2782
 
# File 'docs/0_Dependencies.rb', line 2781

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

#release

Release the driver



2771
2772
 
# File 'docs/0_Dependencies.rb', line 2771

def release
end

#reset

Reset the driver



2768
2769
 
# File 'docs/0_Dependencies.rb', line 2768

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



2813
2814
 
# File 'docs/0_Dependencies.rb', line 2813

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)



2803
2804
 
# File 'docs/0_Dependencies.rb', line 2803

def set_channel_volume(channel, volume)
end

#stop_channel(channel)

Stop a channel

Parameters:

  • channel (Symbol) —

    channel to stop



2798
2799
 
# File 'docs/0_Dependencies.rb', line 2798

def stop_channel(channel)
end

#unmute_channel(channel)

Unmute a channel

Parameters:

  • channel (Symbol) 


2822
2823
 
# File 'docs/0_Dependencies.rb', line 2822

def unmute_channel(channel)
end

#update

Update the driver



2774
2775
 
# File 'docs/0_Dependencies.rb', line 2774

def update
end