Skip to main content
Paid plans only updateTranscription(options) Updates which participants are transcribed for a given transcription instance. If participants are specified or the empty array is passed, any participants that join after this call will not be transcribed unless you call updateTranscription() again to include them.

Parameters

instanceId
string
The UUID of the transcription instance to update. Omit to update the default instance.
participants
string[]
required
Session IDs of the participants to transcribe. Pass an empty array to stop transcribing all participants without ending the transcription session. Pass null to transcribe all participants.

Return value

Returns void.

Examples

// Transcribe only specific participants
await call.updateTranscription({
  instanceId: '00000000-0000-4000-8000-000000000000',
  participants: [
    'd8a14d03-58ef-4b7c-824a-181779ab535a',
    '435fa323-65a1-4654-b788-069936da87a0',
  ],
});

// Transcribe all participants
await call.updateTranscription({participants: null});

See also