Player

Represents an instance of an audio player. Can be created by calling the VoxEngine.createTTSPlayer, VoxEngine.createToneScriptPlayer or VoxEngine.createURLPlayer methods.

Extends: BasePlayer

Methods

addMarker

Adds a playback marker. The PlayerEvents.PlaybackMarkerReached event is triggered when the marker is reached.

This method is currently not supported by the ElevenLabs provider.

1
addMarker(offset: number): void

Parameters

Inherited Methods

addEventListener

Inherited from BasePlayer.

Adds a handler for the specified PlayerEvents event. Use only functions as handlers; anything except a function leads to the error and scenario termination when a handler is called.

1
addEventListener(event: PlayerEvents | T, callback: (event: _PlayerEvents[T]) => any): void

Parameters

id

Inherited from BasePlayer.

Returns the player’s id.

1
id(): string

pause

Inherited from BasePlayer.

Pauses playback. To continue the playback use the Player.resume method.

1
pause(): void

removeEventListener

Inherited from BasePlayer.

Removes a handler for the specified PlayerEvents event.

1
removeEventListener(event: PlayerEvents | T, callback?: (event: _PlayerEvents[T]) => any): void

Parameters

resume

Inherited from BasePlayer.

Resumes playback after the Player.pause method is called.

1
resume(): void

sendMediaTo

Inherited from BasePlayer.

Starts sending media from the player to the media unit.

1
sendMediaTo(mediaUnit: VoxMediaUnit, parameters?: SendMediaParameters): void

Parameters

stop

Inherited from BasePlayer.

Stops playback. The current player’s instance is destroyed.

1
stop(): void

stopMediaTo

Inherited from BasePlayer.

Stops sending media from the player to the media unit.

1
stopMediaTo(mediaUnit: VoxMediaUnit): void

Parameters