useTranscription

useTranscription(params?) : Object useTranscription can also be used to set up optional callbacks for transcription events.

Parameters (optional)

An object with the following optional properties:

Function

Callback for the "transcription-error" event.

Function

Callback for the "transcription-message" event.

Function

Callback for the "transcription-started" event.

Function

Callback for the "transcription-stopped" event.

Function

Deprecated 0.18.0 Callback for the "app-message" event from transcription. This parameter is deprecated; use onTranscriptionMessage instead.

Return value

An object with the following properties:

boolean

true in the event of a "transcription-error".

boolean

Returns true after transcription has started.

string

Returns the language applied for the transcription. Please check Deepgram’s language docs for details.

string

Returns the model applied for transcription. Please check Deepgram’s model docs for more details.

boolean

Returns true when profanity filter is enabled. Please check Deepgram’s profanity filter docs for more details.

boolean | array

Returns the redaction applied for transcription. Please check Deepgram’s redaction docs for more details.

string

Returns the session_id for the participant who initiated the transcription.

Function

See daily-js startTranscription().

Function

See daily-js stopTranscription().

string

This field is deprecated, use model instead.

Transcription[]

Array of Transcription object. See Transcription for more information.

Date

Timestamp for when the transcription started.

string

Returns the session_id for the participant who updated the transcription most recently.

{
  "error": false,
  "isTranscribing": true,
  "language": "en",
  "model": "nova-2-general",
  "profanity_filter": false,
  "redact": "false",
  "startedBy": "0e92c476-3d2f-4ddc-b814-9447cd7e3b90",
  "startTranscription": <Function>,
  "stopTranscription": <Function>,
  "transcriptions": <Object>,
  "transcriptionStartDate": "Mon Sept 05 2022 10:33:30 GMT+0200 (Central European Summer Time)",
  "updatedBy": "0e92c476-3d2f-4ddc-b814-9447cd7e3b90"
}

Example

import { useTranscription } from '@daily-co/daily-react';

export const useTranscriptionDemo = () => {
  const { isTranscribing } = useTranscription();

  return <div>{!isTranscribing ? 'Not' : ''} transcribing</div>;
};

Components

Hooks

useTranscription

Parameters (optional)

Return value

Example

See also

daily-js methods

Events

​Parameters (optional)

​Return value

​Example

​See also

daily-js methods

Events

Parameters (optional)

Return value

Example

See also