Class RtcNodeAvatarOutlet

Publishes and feeds the avatar's camera track on one room's local participant.

Implements

AvatarVideoOutlet

Index

Constructors

Methods

Capture Publish SetAttributes Unpublish CanPublishVideo

Constructors

constructor

new RtcNodeAvatarOutlet(
rtc: RtcNodeModule,
participant: RtcLocalParticipant,
): RtcNodeAvatarOutlet
Parameters
- rtc: RtcNodeModule
  The loaded @livekit/rtc-node module.
- participant: RtcLocalParticipant
  The room's local participant (the bot).
Returns RtcNodeAvatarOutlet
- Defined in AI/RealtimeBridge/Providers/LiveKitNative/src/avatar-room-outlet.ts:31

Methods

Capture

Capture(frame: AvatarVideoFrame): void
Shows one frame on the published track.
Parameters
- frame: AvatarVideoFrame
Returns void
Implementation of AvatarVideoOutlet.Capture
- Defined in AI/RealtimeBridge/Providers/LiveKitNative/src/avatar-room-outlet.ts:62

Publish

Publish(width: number, height: number): Promise<void>
Publishes the camera track for frames of this size. Rejects when the room refuses it.
Parameters
- width: number
- height: number
Returns Promise<void>
Implementation of AvatarVideoOutlet.Publish
- Defined in AI/RealtimeBridge/Providers/LiveKitNative/src/avatar-room-outlet.ts:42

SetAttributes

SetAttributes(attributes: Record<string, string>): Promise<void>
Sets the bot's participant attributes.
Parameters
- attributes: Record<string, string>
Returns Promise<void>
Implementation of AvatarVideoOutlet.SetAttributes
- Defined in AI/RealtimeBridge/Providers/LiveKitNative/src/avatar-room-outlet.ts:91

Unpublish

Unpublish(): Promise<void>
Takes the camera track down.

Returns Promise<void>
Implementation of AvatarVideoOutlet.Unpublish
- Defined in AI/RealtimeBridge/Providers/LiveKitNative/src/avatar-room-outlet.ts:78

`Static`CanPublishVideo

CanPublishVideo(rtc: RtcNodeModule): boolean
Whether this module can publish video at all (VideoSource, VideoFrame, LocalVideoTrack).
Parameters
- rtc: RtcNodeModule
Returns boolean
- Defined in AI/RealtimeBridge/Providers/LiveKitNative/src/avatar-room-outlet.ts:37