Constructors
Methods
addEventListener
- addEventListener<EventName extends keyof EventTypes>(
type: EventName,
listener: (ev: CustomEvent<EventTypes[EventName]>) => void,
options?: boolean | AddEventListenerOptions,
): void Type Parameters
- EventName extends keyof EventTypes
Parameters
- type: EventName
- listener: (ev: CustomEvent<EventTypes[EventName]>) => void
Optionaloptions: boolean | AddEventListenerOptions
Returns void
pauseAudioClip
- pauseAudioClip(
path: string,
__namedParameters: { fade?: number },
onlySoundId?: number,
allowIfPauseRequested?: boolean,
): void Parameters
- path: string
- __namedParameters: { fade?: number }
OptionalonlySoundId: numberOptionalallowIfPauseRequested: boolean
Returns void
playAudioClip
- playAudioClip(
path: string,
__namedParameters: {
fade?: number;
loop: boolean;
playId: string;
volume: number;
},
): void Parameters
- path: string
- __namedParameters: { fade?: number; loop: boolean; playId: string; volume: number }
Returns void
removeEventListener
- removeEventListener<EventName extends keyof EventTypes>(
type: EventName,
listener: (ev: CustomEvent<EventTypes[EventName]>) => void,
options?: boolean | EventListenerOptions,
): void Type Parameters
- EventName extends keyof EventTypes
Parameters
- type: EventName
- listener: (ev: CustomEvent<EventTypes[EventName]>) => void
Optionaloptions: boolean | EventListenerOptions
Returns void
setAudioClipVolume
- setAudioClipVolume(
path: string,
__namedParameters: { fade?: number; volume: number },
): void Parameters
- path: string
- __namedParameters: { fade?: number; volume: number }
Returns void
setAudioSink
- setAudioSink(sinkId: string): void
Returns void
setGlobalVolume
- setGlobalVolume(volume: number): void
Returns void
stopAllAudioClips
- stopAllAudioClips(options: { fade?: number }): void
Parameters
- options: { fade?: number }
Returns void
stopAudioClip
- stopAudioClip(
path: string,
__namedParameters: { fade?: number },
onlySoundId?: number,
allowIfStopRequested?: boolean,
): void Parameters
- path: string
- __namedParameters: { fade?: number }
OptionalonlySoundId: numberOptionalallowIfStopRequested: boolean
Returns void