Audio API
From FHU Wiki
| Type | Description | |
|---|---|---|
| Audio.muted | Boolean | Determines if the audio is muted or not. |
| Audio.noiseReduction | Boolean | Turn noise reduction on or off. |
| Audio.inputVolume | Float | |
| Audio.inputLevel | Float | Read only value, to get the input level. |
| Audio.objectName | String | |
| Audio.context | String | |
| Audio.devices.input.objectName | String | |
| Audio.devices.objectName | String | |
| Audio.devices.output.objectName | String |
| Audio.playSound(SharedSoundPointer) |
| Audio.playSound(SharedSoundPointer,AudioInjectorOptions) |
| Audio.setStereoInput(bool) |
| Audio.stopInjector(soundPlaying) |
| Audio.isInjectorPlaying(soundPlaying) |
| Audio.devices.deleteLater() |
| Audio.devices.input.canFetchMore(QModelIndex) |
| Audio.devices.input.columnCount() |
| Audio.devices.input.columnCount(QModelIndex) |
| Audio.devices.input.columnsAboutToBeInserted(QModelIndex,int,int) |
| Audio.devices.input.columnsAboutToBeMoved(QModelIndex,int,int,QModelIndex,int) |
| Audio.devices.input.columnsAboutToBeRemoved(QModelIndex,int,int) |
| Audio.devices.input.columnsInserted(QModelIndex,int,int) |
| Audio.devices.input.columnsMoved(QModelIndex,int,int,QModelIndex,int) |
| Audio.devices.input.columnsRemoved(QModelIndex,int,int) |
| Audio.devices.input.data(QModelIndex) |
| Audio.devices.input.data(QModelIndex,int) |
| Audio.devices.input.dataChanged(QModelIndex,QModelIndex) |
| Audio.devices.input.dataChanged(QModelIndex,QModelIndex,QVector<int>) |
| Audio.devices.input.deviceChanged(QAudioDeviceInfo) |
| Audio.devices.input.fetchMore(QModelIndex) |
| Audio.devices.input.flags(QModelIndex) |
| Audio.devices.input.hasChildren() |
| Audio.devices.input.hasChildren(QModelIndex) |
| Audio.devices.input.hasIndex(int,int) |
| Audio.devices.input.hasIndex(int,int,QModelIndex) |
| Audio.devices.input.headerData(int,Qt::Orientation) |
| Audio.devices.input.headerData(int,Qt::Orientation,int) |
| Audio.devices.input.headerDataChanged(Qt::Orientation,int,int) |
| Audio.devices.input.index(int,int) |
| Audio.devices.input.index(int,int,QModelIndex) |
| Audio.devices.input.layoutAboutToBeChanged() |
| Audio.devices.input.layoutAboutToBeChanged(QList<QPersistentModelIndex>) |
| Audio.devices.input.layoutAboutToBeChanged(QList<QPersistentModelIndex>,QAbstractItemModel::LayoutChangeHint) |
| Audio.devices.input.layoutChanged() |
| Audio.devices.input.layoutChanged(QList<QPersistentModelIndex>) |
| Audio.devices.input.layoutChanged(QList<QPersistentModelIndex>,QAbstractItemModel::LayoutChangeHint) |
| Audio.devices.input.match(QModelIndex,int,QVariant) |
| Audio.devices.input.match(QModelIndex,int,QVariant,int) |
| Audio.devices.input.match(QModelIndex,int,QVariant,int,Qt::MatchFlags) |
| Audio.devices.input.modelAboutToBeReset() |
| Audio.devices.input.modelReset() |
| Audio.devices.input.objectNameChanged(QString) |
| Audio.devices.input.parent(QModelIndex) |
| Audio.devices.input.resetInternalData() |
| Audio.devices.input.revert() |
| Audio.devices.input.rowCount() |
| Audio.devices.input.rowCount(QModelIndex) |
| Audio.devices.input.rowsAboutToBeInserted(QModelIndex,int,int) |
| Audio.devices.input.rowsAboutToBeMoved(QModelIndex,int,int,QModelIndex,int) |
| Audio.devices.input.rowsAboutToBeRemoved(QModelIndex,int,int) |
| Audio.devices.input.rowsInserted(QModelIndex,int,int) |
| Audio.devices.input.rowsMoved(QModelIndex,int,int,QModelIndex,int) |
| Audio.devices.input.rowsRemoved(QModelIndex,int,int) |
| Audio.devices.input.setData(QModelIndex,QVariant) |
| Audio.devices.input.setData(QModelIndex,QVariant,int) |
| Audio.devices.input.sibling(int,int,QModelIndex) |
| Audio.devices.input.submit() |
| Audio.devices.nop() |
| Audio.devices.objectNameChanged(QString) |
| Audio.devices.output.canFetchMore(QModelIndex) |
| Audio.devices.output.columnCount() |
| Audio.devices.output.columnCount(QModelIndex) |
| Audio.devices.output.columnsAboutToBeInserted(QModelIndex,int,int) |
| Audio.devices.output.columnsAboutToBeMoved(QModelIndex,int,int,QModelIndex,int) |
| Audio.devices.output.columnsAboutToBeRemoved(QModelIndex,int,int) |
| Audio.devices.output.columnsInserted(QModelIndex,int,int) |
| Audio.devices.output.columnsMoved(QModelIndex,int,int,QModelIndex,int) |
| Audio.devices.output.columnsRemoved(QModelIndex,int,int) |
| Audio.devices.output.data(QModelIndex) |
| Audio.devices.output.data(QModelIndex,int) |
| Audio.devices.output.dataChanged(QModelIndex,QModelIndex) |
| Audio.devices.output.dataChanged(QModelIndex,QModelIndex,QVector<int>) |
| Audio.devices.output.deleteLater() |
| Audio.devices.output.deviceChanged(QAudioDeviceInfo) |
| Audio.devices.output.fetchMore(QModelIndex) |
| Audio.devices.output.flags(QModelIndex) |
| Audio.devices.output.hasChildren() |
| Audio.devices.output.hasChildren(QModelIndex) |
| Audio.devices.output.hasIndex(int,int) |
| Audio.devices.output.hasIndex(int,int,QModelIndex) |
| Audio.devices.output.headerData(int,Qt::Orientation) |
| Audio.devices.output.headerData(int,Qt::Orientation,int) |
| Audio.devices.output.headerDataChanged(Qt::Orientation,int,int) |
| Audio.devices.output.index(int,int) |
| Audio.devices.output.index(int,int,QModelIndex) |
| Audio.devices.output.layoutAboutToBeChanged() |
| Audio.devices.output.layoutAboutToBeChanged(QList<QPersistentModelIndex>) |
| Audio.devices.output.layoutAboutToBeChanged(QList<QPersistentModelIndex>,QAbstractItemModel::LayoutChangeHint) |
| Audio.devices.output.layoutChanged() |
| Audio.devices.output.layoutChanged(QList<QPersistentModelIndex>) |
| Audio.devices.output.layoutChanged(QList<QPersistentModelIndex>,QAbstractItemModel::LayoutChangeHint) |
| Audio.devices.output.match(QModelIndex,int,QVariant) |
| Audio.devices.output.match(QModelIndex,int,QVariant,int) |
| Audio.devices.output.match(QModelIndex,int,QVariant,int,Qt::MatchFlags) |
| Audio.devices.output.modelAboutToBeReset() |
| Audio.devices.output.modelReset() |
| Audio.devices.output.objectNameChanged(QString) |
| Audio.devices.output.parent(QModelIndex) |
| Audio.devices.output.resetInternalData() |
| Audio.devices.output.revert() |
| Audio.devices.output.rowCount() |
| Audio.devices.output.rowCount(QModelIndex) |
| Audio.devices.output.rowsAboutToBeInserted(QModelIndex,int,int) |
| Audio.devices.output.rowsAboutToBeMoved(QModelIndex,int,int,QModelIndex,int) |
| Audio.devices.output.rowsAboutToBeRemoved(QModelIndex,int,int) |
| Audio.devices.output.rowsInserted(QModelIndex,int,int) |
| Audio.devices.output.rowsMoved(QModelIndex,int,int,QModelIndex,int) |
| Audio.devices.output.rowsRemoved(QModelIndex,int,int) |
| Audio.devices.output.setData(QModelIndex,QVariant) |
| Audio.devices.output.setData(QModelIndex,QVariant,int) |
| Audio.devices.output.sibling(int,int,QModelIndex) |
| Audio.devices.output.submit() |
| Audio.noiseReductionChanged(bool) |
| Audio.nop() |
| Audio.playSystemSound(SharedSoundPointer,QVector3D) |
| Audio.setInputDevice(QAudioDeviceInfo) |
| Audio.setOutputDevice(QAudioDeviceInfo) |
| Audio.setReverb(bool) |
| AudioEffectOptions |
| Audio.setReverbOptions(const AudioEffectOptions*) |
| Audio.disconnected() |
| Audio.environmentMuted() |
| Audio.inputReceived(QByteArray) |
| Audio.mutedByMixer() |
| Audio.noiseGateClosed() |
| Audio.noiseGateOpened() |
| Audio.receivedFirstPacket() |
| Audio.contextChanged(QString) |
| Audio.onContextChanged() |
| Audio.objectNameChanged(QString) |
| Audio.inputLevelChanged(float) |
| Audio.inputVolumeChanged(float) |
| Audio.mutedChanged(bool) |
Audio.playSound()
Audio.playSound() triggers playback of an audio file by sending it to the audio mixer. To use this API to play (aka "inject") a sound, the sound file must have been previously loaded using SoundCache.getSound().
If the client is not connected to an audio mixer, no sound will be played unless the localOnly option is invoked (see below.)
Function
Audio.playSound (Sound*, AudioInjectorOptions)
Arguments
Sound* The sound object returned from SoundCache.getSound().
Below are options you can pass to Audio.playSound():
| Option | Description | Values | Default |
|---|---|---|---|
| Volume | Playback volume of sound | from 0.0 to 1.0 | 1.0 |
| Position | Playback position of sound | Valid positional coordinates within the domain | { x: 0, y: 0, z: 0 } |
| Orientation | Playback orientation of sound | As above | { x: 0, y: 0, z: 0, w: 1 } |
| Loop | Repeats sound automatically | Boolean | False |
| Stereo | File is in stereo format | Boolean | False |
| localOnly | injects audio locally rather than via the audio mixer | Boolean | False |
| secondOffset | starting playback point within the soundclip, in seconds | Any number >= 0 | 0 |
| ignorePenumbra | don't subject this sound to the positional lowpass penumbra filter | Boolean | False |
'Stereo' can be overridden by a WAV header or by including ".stereo" in a RAW filename (e.g., Thunderclap.stereo.raw)
Note that 'Position', 'Orientation' and 'IgnorePenumbra' have no effect when 'localOnly' is true. Local sounds are played without any spatialization.
Returns
object: AudioInjector
Examples
To play a sound loaded into the SoundCache as "GunshotSound":
<code>var injector = Audio.playSound(GunshotSound);</code>
This will inject the sound by sending it to the audio mixer. The object returned from a call to Audio.playSound is an 'AudioInjector'. While it is running you can change the options above via the property '.options'. To modify the injector so that the sound plays from a position in the domain with coordinates of x: 10, y: 20, z: 30:h
<code>injector.options = { position: { x: 10, y: 20, z: 30 } }</code>
You can also pass options to Audio.playSound initially with the same name-value pairs.
<code>var options = { loop: true, position: { x: 10, y: 20, z: 30 } }
var injector = Audio.playSound(options);</code>
There are a number of methods you can call on the 'AudioInjector' object to control the playback and get information about its current state.
<code class="java language-java">injector.restart(); // stops playback and restarts from beginning - useful for repeated sounds injector.stop() // stops playback immediately injector.isPlaying(); // true if still playing injector.getLoudness(); // returns the loudness in last frame as a value between 0 and 1.0 injector.finished.connect(function(); // your injector is done playing</code>
Audio.isInjectorPlaying()
Description: isInjectorPlaying returns a boolean value describing the play status of a given AudioInjector.
Example: Using isInjectorPlaying()
Take a look at this snippet of playSoundLoop.js:
<code class="java language-java">//starting the sound
soundPlaying = Audio.playSound(sound, options);
print("Started sound looping.");
Script.update.disconnect(maybePlaySound);
}
}
function scriptEnding() {
//if the injector is playing a sound, Audio.isInjectorPlaying(soundPlaying) returns `true`
if (Audio.isInjectorPlaying(soundPlaying)) {
Audio.stopInjector(soundPlaying);
Entities.deleteEntity(ball);
print("Stopped sound.");
}</code>
Audio.stopInjector()
Description: stopInjector stops the playback of a given AudioInjector.
Example: Using stopInjector()
Take a look at this snippet of playSoundLoop.js:
<code class="java language-java"> function maybePlaySound(deltaTime) {
...
//starting the sound
soundPlaying = Audio.playSound(sound, options);
print("Started sound looping.");
Script.update.disconnect(maybePlaySound);
}
}
function scriptEnding() {
if (Audio.isInjectorPlaying(soundPlaying)) {
//stopping the sound
Audio.stopInjector(soundPlaying);
Entities.deleteEntity(ball);
print("Stopped sound.");
}
...</code>
