Audio

snow.modules.openal.Audio defined in ``

class
implements snow.modules.interfaces.Audio
meta: @:keep, @:log_as("openal"), @:allow(snow.modules.openal), @:allow(snow.systems.audio.Audio)

Members

context

context : snow.modules.openal.Context

device

device : snow.modules.openal.Device

Methods

data_from_bytes

data_from_bytes(_id:String, _bytes:snow.api.buffers.Uint8Array, _format:snow.types.AudioFormatType) : snow.api.Promise
Promises an AudioData instance from the given bytes

data_from_load

data_from_load(_path:String, _is_stream:Bool, _format:snow.types.AudioFormatType) : snow.api.Promise
Promises an AudioData instance from the given path

instance_of

instance_of(_handle:snow.types.AudioHandle) : snow.systems.audio.AudioInstance
Get the audio instance of a handle, use with caution.

loop

loop(_source:snow.systems.audio.AudioSource, _volume:Float, _paused:Bool) : snow.types.AudioHandle
Play and loop a sound instance indefinitely. Use stop to end it. Returns a disposable handle

loop_of

loop_of(_handle:snow.types.AudioHandle) : Bool
Get the looping state of a handle

pan

pan(_handle:snow.types.AudioHandle, _pan:Float) : Void
Set the pan of a sound instance.

pan_of

pan_of(_handle:snow.types.AudioHandle) : Float
Get the pan of a sound instance

pause

pause(_handle:snow.types.AudioHandle) : Void

pitch

pitch(_handle:snow.types.AudioHandle, _pitch:Float) : Void
Set the pitch of a sound instance

pitch_of

pitch_of(_handle:snow.types.AudioHandle) : Float
Get the pitch of a sound instance

play

play(_source:snow.systems.audio.AudioSource, _volume:Float, _paused:Bool) : snow.types.AudioHandle
Play an instance of the given audio source, returning a disposable handle

position

position(_handle:snow.types.AudioHandle, _time:Float) : Void
Set the position of a sound instance

position_of

position_of(_handle:snow.types.AudioHandle) : Float
Get the position of a sound instance

resume

resume() : Void

state_of

state_of(_handle:snow.types.AudioHandle) : snow.types.AudioState
Get the playback state of a handle

stop

stop(_handle:snow.types.AudioHandle) : Void

suspend

suspend() : Void

unpause

unpause(_handle:snow.types.AudioHandle) : Void

volume

volume(_handle:snow.types.AudioHandle, _volume:Float) : Void
Set the volume of a sound instance

volume_of

volume_of(_handle:snow.types.AudioHandle) : Float
Get the volume of a sound instance