IVoiceOverManager
Properties
FADE_OUT_DURATION
FADE_OUT_DURATION:
number
Duration, in milliseconds, of the fade out when stopping voiceovers. Must be greater than or equal to zero
Source
src/audio/VoiceOverManager.ts:63
activeVO
activeVO:
undefined|HowlerTrack
The currently playing voiceover
Source
src/audio/VoiceOverManager.ts:86
debug
debug:
boolean
Source
src/audio/VoiceOverManager.ts:65
isPlaying
isPlaying:
boolean
Whether a voiceover is currently playing
Source
src/audio/VoiceOverManager.ts:71
numInQueue
numInQueue:
number
Number of voiceovers in the queue
Source
src/audio/VoiceOverManager.ts:76
queueIds
queueIds:
string[]
Ids of voiceovers in the queue
Source
src/audio/VoiceOverManager.ts:81
Methods
playVO()
playVO(key)
playVO(
key):void
Play a Voiceover or sequence of voiceovers
Parameters
• key: string | (string | number)[]
Id or array of voiceover Ids
Returns
void
Source
src/audio/VoiceOverManager.ts:93
playVO(key, mode)
playVO(
key,mode):void
Play a Voiceover or sequence of voiceovers
Parameters
• key: string | (string | number)[]
Id or array of voiceover Ids
• mode: PlayMode
Audio interruption behaviour. Default is PlayMode.Override
Returns
void
Source
src/audio/VoiceOverManager.ts:103
playVO(key, callback)
playVO(
key,callback):void
Play a Voiceover or sequence of voiceovers
Parameters
• key: string | (string | number)[]
Id or array of voiceover Ids
• callback: Callback
Called after the last voiceover finishes playing, or immediately if no playback occurs
Returns
void
Source
src/audio/VoiceOverManager.ts:110
playVO(key, options)
playVO(
key,options):void
Play a Voiceover or sequence of voiceovers
Parameters
• key: string | (string | number)[]
Id or array of voiceover Ids
• options: Partial<IPlayOptions>
Returns
void
Source
src/audio/VoiceOverManager.ts:119
playVO(key, mode, callback)
playVO(
key,mode,callback):void
Play a Voiceover or sequence of voiceovers
Parameters
• key: string | (string | number)[]
Id or array of voiceover Ids
• mode: PlayMode
Audio interruption behaviour. Default is PlayMode.Override
• callback: Callback
Called after the last voiceover finishes playing, or immediately if no playback occurs
Returns
void
Source
src/audio/VoiceOverManager.ts:128
stopVO()
stopVO():
void
Stop any currently playing VOs, and cancel any queued VOs. Any callbacks (from playVO) will not be called.
Returns
void