VoiceOverManager
Voiceover Manager controls voiceover audio playback and guarantees that only one voiceover will ever be playing at a time
Implements
Constructors
new VoiceOverManager()
new VoiceOverManager(
app):VoiceOverManager
Parameters
• app: Application<any>
Returns
Source
src/audio/VoiceOverManager.ts:166
Properties
FADE_OUT_DURATION
FADE_OUT_DURATION:
number=150
Duration, in milliseconds, of the fade out when stopping voiceovers. Must be greater than or equal to zero
Implementation of
IVoiceOverManager.FADE_OUT_DURATION
Source
src/audio/VoiceOverManager.ts:141
debug
debug:
boolean=false
Implementation of
Source
src/audio/VoiceOverManager.ts:143
Accessors
activeVO
getactiveVO():undefined|HowlerTrack
The currently playing voiceover
Returns
undefined | HowlerTrack
Source
src/audio/VoiceOverManager.ts:175
isPlaying
getisPlaying():boolean
Whether a voiceover is currently playing
Returns
boolean
Source
src/audio/VoiceOverManager.ts:182
numInQueue
getnumInQueue():number
Number of voiceovers in the queue
Returns
number
Source
src/audio/VoiceOverManager.ts:186
queueIds
getqueueIds():string[]
Ids of voiceovers in the queue
Returns
string[]
Source
src/audio/VoiceOverManager.ts:190
Methods
playVO()
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 | Callback | IPlayOptions
• callback?: Callback
Returns
void
Implementation of
Source
src/audio/VoiceOverManager.ts:194
stopVO()
stopVO():
void
Stop any currently playing VOs, and cancel any queued VOs. Any callbacks (from playVO) will not be called.
Returns
void