Class: Audio::DriverBase

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

Overview

Base class for all audio drivers (mainly definition)

Direct Known Subclasses

FMODDriver, SFMLAudioDriver

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

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



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

Parameters:

  • channel (Symbol)

Returns:

  • (Integer) —

    channel audio position in driver's unit



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

Parameters:

  • channel (Symbol)

Returns:

  • (Integer)


2889
2890
# File 'docs/0_Dependencies.rb', line 2889

def get_channel_duration(channel)
end

#mute_channel(channel)

Mute a channel forever

Parameters:

  • channel (Symbol)


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

Parameters:

  • channel (Symbol)
  • duration (Integer) —

    mute duration in driver's 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)

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



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)

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)



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

Parameters:

  • channel (Symbol)
  • position (Integer) —

    audio position in driver's unit



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

Parameters:

  • channel (Symbol) —

    channel to set the volume

  • volume (Integer) —

    volume of the channel (0~100)



2861
2862
# File 'docs/0_Dependencies.rb', line 2861

def set_channel_volume(channel, volume)
end

#stop_channel(channel)

Stop a channel

Parameters:

  • channel (Symbol) —

    channel to stop



2856
2857
# File 'docs/0_Dependencies.rb', line 2856

def stop_channel(channel)
end

#unmute_channel(channel)

Unmute a channel

Parameters:

  • channel (Symbol)


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