Interface LiveSendRealtimeInputParameters

Parameters for sending realtime input to the live API.

interface LiveSendRealtimeInputParameters {
    activityEnd?: ActivityEnd;
    activityStart?: ActivityStart;
    audio?: Blob;
    audioStreamEnd?: boolean;
    media?: Blob;
    text?: string;
    video?: Blob;
}

Properties

activityEnd? activityStart? audio? audioStreamEnd? media? text? video?

Properties

OptionalactivityEnd

activityEnd?: ActivityEnd

Marks the end of user activity.

OptionalactivityStart

activityStart?: ActivityStart

Marks the start of user activity.

Optionalaudio

audio?: Blob

The realtime audio input stream.

OptionalaudioStreamEnd

audioStreamEnd?: boolean

Indicates that the audio stream has ended, e.g. because the microphone was turned off.

This should only be sent when automatic activity detection is enabled (which is the default).

The client can reopen the stream by sending an audio message.

Optionalmedia

media?: Blob

Realtime input to send to the session.

Optionaltext

text?: string

The realtime text input stream.

Optionalvideo

video?: Blob

The realtime video input stream.

Settings

On This Page

Properties