Interface SoundSourceOptions
interface SoundSourceOptions {
name?: string;
outBus?: PrimaryAudioBus;
outBusAutoDefault?: boolean;
volume?: number;
}
name?: string;
outBus?: PrimaryAudioBus;
outBusAutoDefault?: boolean;
volume?: number;
}
Properties
Optionalname
name?: string
Optional name.
Optionalout
Output bus. Defaults to the engine's main bus unless outBusAutoDefault is false.
Optionalout
outBusAutoDefault?: boolean
Whether the output bus defaults to the engine's main bus when outBus
is not set. Defaults to true for createSoundSourceAsync and false
for createMicrophoneSoundSourceAsync (a mic is usually analyzed, not
played back, to avoid feedback).
Optionalvolume
volume?: number
Initial volume. Defaults to 1.
Options for createSoundSourceAsync and createMicrophoneSoundSourceAsync.