> ## Documentation Index
> Fetch the complete documentation index at: https://docs.daily.co/llms.txt
> Use this file to discover all available pages before exploring further.

# useTranscription

> Returns information about a meeting's current transcription state, along with helper functions that wrap daily-js transcription related methods.

`useTranscription(params?) : Object`

`useTranscription` can also be used to set up optional callbacks for transcription [events](https://docs.daily.co/reference/daily-js/events/transcription-events.md).

## Parameters (optional)

An object with the following optional properties:

**onTranscriptionError** `Function`

Callback for the [`"transcription-error"`](https://docs.daily.co/reference/daily-js/events/transcription-events#transcription-error) event.

**onTranscriptionMessage** `Function`

Callback for the [`"transcription-message"`](https://docs.daily.co/reference/daily-js/events/transcription-events#transcription-message) event.

**onTranscriptionStarted** `Function`

Callback for the [`"transcription-started"`](https://docs.daily.co/reference/daily-js/events/transcription-events#transcription-started) event.

**onTranscriptionStopped** `Function`

Callback for the [`"transcription-stopped"`](https://docs.daily.co/reference/daily-js/events/transcription-events#transcription-stopped) event.

**onTranscriptionAppData** `Function`

Deprecated 0.18.0 Callback for the [`"app-message"`](https://docs.daily.co/reference/daily-js/events/messaging-events#app-message) event from transcription. This parameter is deprecated; use `onTranscriptionMessage` instead.

## Return value

An object with the following properties:

**error** `boolean`

`true` in the event of a [`"transcription-error"`](https://docs.daily.co/reference/daily-js/events/transcription-events#transcription-error).

**isTranscribing** `boolean`

Returns `true` after transcription has started.

**language** `string`

Returns the language applied for the transcription. Please check Deepgram's [language](https://developers.deepgram.com/documentation/features/language/) docs for details.

**model** `string`

Returns the model applied for transcription. Please check Deepgram's [model](https://developers.deepgram.com/documentation/features/model/) docs for more details.

**profanity\_filter** `boolean`

Returns `true` when profanity filter is enabled. Please check Deepgram's [profanity filter](https://developers.deepgram.com/documentation/features/profanity-filter/) docs for more details.

**redact** `boolean | array`

Returns the redaction applied for transcription. Please check Deepgram's [redaction](https://developers.deepgram.com/documentation/features/redact/) docs for more details.

**startedBy** `string`

Returns the `session_id` for the participant who initiated the transcription.

**startTranscription** `Function`

See `daily-js` [`startTranscription()`](https://docs.daily.co/reference/daily-js/instance-methods/start-transcription).

**stopTranscription** `Function`

See `daily-js` [`stopTranscription()`](https://docs.daily.co/reference/daily-js/instance-methods/stop-transcription).

**tier** `string`

This field is deprecated, use `model` instead.

**transcriptions** `Transcription[]`

Array of `Transcription` object. See [Transcription](https://docs.daily.co/reference/daily-js/instance-methods/start-transcription.md) for more information.

**transcriptionStartDate** `Date`

Timestamp for when the transcription started.

**updatedBy** `string`

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

```json theme={null}
{
  "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

```jsx theme={null}
import { useTranscription } from '@daily-co/daily-react';

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

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

## See also

> [card] daily-js methods
>
> * [startTranscription()](https://docs.daily.co/reference/daily-js/instance-methods/start-transcription.md)
> * [stopTranscription()](https://docs.daily.co/reference/daily-js/instance-methods/stop-transcription.md)

> [card] Events
>
> * [transcription-started](https://docs.daily.co/reference/daily-js/events/transcription-events.md#transcription-started)
> * [transcription-stopped](https://docs.daily.co/reference/daily-js/events/transcription-events.md#transcription-stopped)
> * [transcription-error](https://docs.daily.co/reference/daily-js/events/transcription-events.md#transcription-error)
> * [transcription-message](https://docs.daily.co/reference/daily-js/events/transcription-events.md#transcription-message)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.