Class RoomIO

Index

Constructors

Accessors

audioOutput isParticipantAvailable linkedParticipant localParticipant rtcRoom transcriptionOutput

Methods

close setParticipant start unsetParticipant

Constructors

constructor

new RoomIO(__namedParameters): RoomIO
Parameters
- __namedParameters: {
      agentSession: AgentSession<unknown>;
      inputOptions?: Partial<RoomInputOptions>;
      outputOptions?: Partial<RoomOutputOptions>;
      participant?: null | string | RemoteParticipant;
      room: Room;
  }
  - agentSession: AgentSession<unknown>
  - Optional inputOptions?: Partial<RoomInputOptions>
  - Optional outputOptions?: Partial<RoomOutputOptions>
  - Optional participant?: null | string | RemoteParticipant
  - room: Room
Returns RoomIO
- Defined in agents/src/voice/room_io/room_io.ts:177

Accessors

audioOutput

get audioOutput(): undefined | AudioOutput
Returns undefined | AudioOutput
- Defined in agents/src/voice/room_io/room_io.ts:475

isParticipantAvailable

get isParticipantAvailable(): boolean
Returns boolean
- Defined in agents/src/voice/room_io/room_io.ts:491

linkedParticipant

get linkedParticipant(): undefined | RemoteParticipant
Returns undefined | RemoteParticipant
- Defined in agents/src/voice/room_io/room_io.ts:499

localParticipant

get localParticipant(): undefined | Participant
Returns undefined | Participant
- Defined in agents/src/voice/room_io/room_io.ts:507

rtcRoom

get rtcRoom(): Room
Returns Room
- Defined in agents/src/voice/room_io/room_io.ts:495

transcriptionOutput

get transcriptionOutput(): undefined | TextOutput
Returns undefined | TextOutput
- Defined in agents/src/voice/room_io/room_io.ts:483

Methods

close

close(): Promise<void>
Returns Promise<void>
- Defined in agents/src/voice/room_io/room_io.ts:661

setParticipant

setParticipant(participantIdentity): void
Switch to a different participant
Parameters
- participantIdentity: null | string
Returns void
- Defined in agents/src/voice/room_io/room_io.ts:512

start

start(traceContext?): void
traceContext is the parent for the startup spans (wait_for_participant, wait_for_audio_track, publish_audio_output); it is never made current here, since the tasks started below live for the whole session.
Parameters
- Optional traceContext: Context
Returns void
- Defined in agents/src/voice/room_io/room_io.ts:558

unsetParticipant

unsetParticipant(): void
Returns void
- Defined in agents/src/voice/room_io/room_io.ts:543