Type Alias RealtimeServiceParams

RealtimeServiceParams: {
    disablePartialTranscripts?: undefined | boolean;
    enableExtraSessionInformation?: undefined | boolean;
    encoding?: undefined | AudioEncoding;
    endUtteranceSilenceThreshold?: undefined | number;
    realtimeUrl?: undefined | string;
    sampleRate?: undefined | number;
    wordBoost?: undefined | string[];
}

Type declaration

  • OptionaldisablePartialTranscripts?: undefined | boolean

    Disable partial transcripts. Set to true to not receive partial transcripts. Defaults to false.

    Default Value

    false
  • OptionalenableExtraSessionInformation?: undefined | boolean

    Enable extra session information. Set to true to receive the session_information message before the session ends. Defaults to false.

    Default Value

    true

    Deprecated

    This parameter is now ignored and will be removed. Session information will always be sent.

  • Optionalencoding?: undefined | AudioEncoding

    The encoding of the audio data

  • OptionalendUtteranceSilenceThreshold?: undefined | number

    The duration of the end utterance silence threshold in milliseconds

  • OptionalrealtimeUrl?: undefined | string

    The WebSocket URL that the RealtimeTranscriber connects to

  • OptionalsampleRate?: undefined | number

    The sample rate of the streamed audio

  • OptionalwordBoost?: undefined | string[]

    Add up to 2500 characters of custom vocabulary

Deprecated

Use RealtimeTranscriberParams instead

Settings

Member Visibility