Audio

View source
backend.Audio (Class)
Implements: spec.Audio

Instance Members

unity
load(path: String, ?options: Null<LoadAudioOptions>, _done: Function): Void
Name Type Default
path String
options Null<LoadAudioOptions> (optional)
_done Function
unity
createFromSamplesBuffer(buffer: Float32Array, samples: Int, channels: Int, sampleRate: Float, interleaved: Bool): AudioResource
Name Type
buffer Float32Array
samples Int
channels Int
sampleRate Float
interleaved Bool
Returns
AudioResource
unity
getDuration(audio: AudioResource): Float
Name Type
audio AudioResource
Returns
Float
unity
resumeAudioContext(done: Function): Void
Name Type
done Function
unity
destroy(audio: AudioResource): Void
Name Type
audio AudioResource
unity
mute(audio: AudioResource): AudioHandle
Name Type
audio AudioResource
Returns
AudioHandle
unity
play(audio: AudioResource, ?volume: Float = 0.5, ?pan: Float = 0, ?pitch: Float = 1, ?position: Float = 0, ?loop: Bool = false, ?bus: Int = 0): AudioHandle
Name Type Default
audio AudioResource
volume Float 0.5
pan Float 0
pitch Float 1
position Float 0
loop Bool false
bus Int 0
Returns
AudioHandle
unity
pause(handle: AudioHandle): Void
Name Type
handle AudioHandle
unity
resume(handle: AudioHandle): Void
Name Type
handle AudioHandle
unity
stop(handle: AudioHandle): Void
Name Type
handle AudioHandle
unity
getVolume(handle: AudioHandle): Float
Name Type
handle AudioHandle
Returns
Float
unity
setVolume(handle: AudioHandle, volume: Float): Void
Name Type
handle AudioHandle
volume Float
unity
getPan(handle: AudioHandle): Float
Name Type
handle AudioHandle
Returns
Float
unity
setPan(handle: AudioHandle, pan: Float): Void
Name Type
handle AudioHandle
pan Float
unity
getPitch(handle: AudioHandle): Float
Name Type
handle AudioHandle
Returns
Float
unity
setPitch(handle: AudioHandle, pitch: Float): Void
Name Type
handle AudioHandle
pitch Float
unity
getPosition(handle: AudioHandle): Float
Name Type
handle AudioHandle
Returns
Float
unity
setPosition(handle: AudioHandle, position: Float): Void
Name Type
handle AudioHandle
position Float
unity
supportsHotReloadPath(): Bool
Returns
Bool
unity
addFilter(bus: Int, filter: ceramic.AudioFilter, onReady: Function): Void
Name Type
bus Int
filter ceramic.AudioFilter
onReady Function
unity
removeFilter(bus: Int, filterId: Int): Void
Name Type
bus Int
filterId Int
unity
filterParamsChanged(bus: Int, filterId: Int): Void
Name Type
bus Int
filterId Int
unity
new(): Void

Private Members

unity
audioFiltersLock: ceramic.SpinLock
unity
filterLocksByBus: Array<ceramic.SpinLock>
unity
filterIdsByBus: Array<Array<AudioFilterInfo>>
unity
activeBusFilters: Array<Bool>
unity
busHasFilter: Array<Bool>
unity
busFilterReadyCallbacks: Array<Array<Function>>
unity
postWorkletSyncCallbacks: Array<Function>
unity
nextSamplesBufferIndex: Int
unity
soundExtensions: Array<String>
unity
loadingAudioCallbacks: Map
unity
loadedAudioResources: Map
unity
loadedAudioRetainCount: Map

Metadata

Name Parameters
:hxGen -