Interface RoomInputOptions

interface RoomInputOptions {
    audioEnabled: boolean;
    audioNumChannels: number;
    audioSampleRate: number;
    closeOnDisconnect: boolean;
    deleteRoomOnClose: boolean;
    noiseCancellation?: FrameProcessor<AudioFrame> | NoiseCancellationOptions;
    participantIdentity?: string;
    participantKinds?: ParticipantKind[];
    textEnabled: boolean;
    textInputCallback?: TextInputCallback;
    videoEnabled: boolean;
}

Properties

audioEnabled audioNumChannels audioSampleRate closeOnDisconnect deleteRoomOnClose noiseCancellation? participantIdentity? participantKinds? textEnabled textInputCallback? videoEnabled

Properties

audioEnabled

audioEnabled: boolean

If not given, default to True.

audioNumChannels

audioNumChannels: number

audioSampleRate

audioSampleRate: number

closeOnDisconnect

closeOnDisconnect: boolean

Close the AgentSession if the linked participant disconnects with reasons in CLIENT_INITIATED, ROOM_DELETED, or USER_REJECTED.

deleteRoomOnClose

deleteRoomOnClose: boolean

Delete the room when the AgentSession is closed. Default to false.

Optional noiseCancellation

noiseCancellation?: FrameProcessor<AudioFrame> | NoiseCancellationOptions

Optional participantIdentity

participantIdentity?: string

The participant to link to. If not provided, link to the first participant. Can be overridden by the participant argument of RoomIO constructor or set_participant.

Optional participantKinds

participantKinds?: ParticipantKind[]

Participant kinds accepted for auto subscription. If not provided, accept DEFAULT_PARTICIPANT_KINDS

textEnabled

textEnabled: boolean

If not given, default to True.

Optional textInputCallback

textInputCallback?: TextInputCallback

videoEnabled

videoEnabled: boolean

If not given, default to False.

Settings

Member Visibility

Theme

On This Page

audioEnabledaudioNumChannelsaudioSampleRatecloseOnDisconnectdeleteRoomOnClosenoiseCancellationparticipantIdentityparticipantKindstextEnabledtextInputCallbackvideoEnabled