Class RealtimeTranscriberOptions

Namespace

AssemblyAI.Realtime

Assembly

AssemblyAI.dll

The options for the real-time transcriber.

public sealed class RealtimeTranscriberOptions

Inheritance

object

RealtimeTranscriberOptions

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Properties

ApiKey

Use your AssemblyAI API key to authenticate with the AssemblyAI real-time transcriber.

public string? ApiKey { set; }

Property Value

string

DisablePartialTranscripts

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

public bool DisablePartialTranscripts { get; set; }

Property Value

bool

Encoding

The encoding of the audio data

public AudioEncoding? Encoding { get; set; }

Property Value

AudioEncoding?

RealtimeUrl

The Streaming STT endpoint to connect to.

public string RealtimeUrl { get; set; }

Property Value

string

SampleRate

The sample rate of the streamed audio. Defaults to 16000.

public uint SampleRate { get; set; }

Property Value

uint

Token

Use a temporary auth token to authenticate with the AssemblyAI real-time transcriber. Learn how to generate a temporary token here.

public string? Token { set; }

Property Value

string

WordBoost

Add up to 2500 characters of custom vocabulary

public IEnumerable<string> WordBoost { get; set; }

Property Value

IEnumerable<string>