Skip to content
dill pixel

IPlayOptions

Properties

callback?

optional callback: Callback

Callback when the voiceover completes playing or if the play request is rejected. Not called, however, when the VO is stopped or interrupted by another VO.

Source

src/audio/VoiceOverManager.ts:39

caption?

optional caption: object

Override the data that is sent to the Signals.playCaption signal

args

args: object

Index signature

[key: string]: string

id

id: string

Source

src/audio/VoiceOverManager.ts:28

data?

optional data: any

Source

src/audio/VoiceOverManager.ts:41

mode?

optional mode: PlayMode

Audio interruption behaviour

Source

src/audio/VoiceOverManager.ts:33

priority?

optional priority: number

For fine-grained control, higher priority VOs will interrupt lower-priority ones

Source

src/audio/VoiceOverManager.ts:35

skipCC?

optional skipCC: boolean

If true, do not trigger the Signals.playCaption signal

Source

src/audio/VoiceOverManager.ts:26