1. References
  2. VoxEngine
  3. Cartesia
  4. RealtimeTTSPlayer
Rate this page:

RealtimeTTSPlayer

Methods

addEventListener

Copy URL
addEventListener(event: 
PlayerEvents
, callback: 
Function
): 
void

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.

Parameters

Returns

  • type:

    void

cancelContextRequest

Copy URL
cancelContextRequest(parameters: 
Object
): 
void

Use this to cancel a context, so that no more messages are generated for that context.

Parameters

  • parameters:

    Object

    Object provides the parameters directly to the Cartesia provider Cancel Context Request message. Find more information in the documentation.

Returns

  • type:

    void

clearBuffer

Copy URL
clearBuffer(): 
void

Clear a Cartesia.RealtimeTTSPlayer buffer.

Returns

  • type:

    void

generationRequest

Copy URL
generationRequest(parameters: 
Object
): 
void

Append text to a Cartesia.RealtimeTTSPlayer.Use this to generate speech for a transcript.

Parameters

  • parameters:

    Object

    Object provides the parameters directly to the Cartesia provider Generation Request message. Find more information in the documentation.

Returns

  • type:

    void

id

Copy URL
id(): 
string

Returns the player's id.

Returns

  • type:

    string

pause

Copy URL
pause(): 
void

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

Returns

  • type:

    void

removeEventListener

Copy URL
removeEventListener(event: 
PlayerEvents
, callback: 
Function
): 
void

Removes a handler for the specified PlayerEvents event.

Parameters

Returns

  • type:

    void

resume

Copy URL
resume(): 
void

Resumes playback after the Player.pause method is called.

Returns

  • type:

    void

sendMediaTo

Copy URL
sendMediaTo(mediaUnit: 
VoxMediaUnit
, parameters: 
SendMediaParameters
): 
void

Starts sending media from the player to the media unit.

Parameters

Returns

  • type:

    void

stop

Copy URL
stop(): 
void

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

Returns

  • type:

    void

stopMediaTo

Copy URL
stopMediaTo(mediaUnit: 
VoxMediaUnit
): 
void

Stops sending media from the player to the media unit.

Parameters

  • mediaUnit:

    VoxMediaUnit

    Media unit that does not need to receive media from this conference anymore

Returns

  • type:

    void