Participant

Methods

addEventListener

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

1
addEventListener(event: CCAI.Events.Participant | T, callback: (event: CCAI.Events._ParticipantEvents[T]) => any): void

Parameters

addPlaybackMarker

Adds a Dialogflow speech synthesis playback marker. The CCAI.Events.Participant.MarkerReached event is triggered when the marker is reached.

1
addPlaybackMarker(offset: number, playbackId?: string): void

Parameters

analyzeContent

Adds a message from a participant into the Dialogflow CCAI.

1
analyzeContent(query: CCAI.Vendor.EventInput | CCAI.Vendor.TextInput): void

Parameters

call

Returns the call associated with the participant.

1
call(): Call

id

Returns the participant’s id.

1
id(): string

removeEventListener

Removes a handler for the specified CCAI.Events.Participant event.

1
removeEventListener(event: CCAI.Events.Participant | T, callback?: (event: CCAI.Events._ParticipantEvents[T]) => any): void

Parameters

sendMediaTo

Starts sending media (voice) from the Dialogflow participant to the media unit.

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

Parameters

stopMediaTo

Stops sending voice from the Dialogflow participant to the media unit.

1
stopMediaTo(mediaUnit: VoxMediaUnit): void

Parameters