Interface AvatarVideoOutlet

The room side of the avatar's video: the camera track and the bot's attributes.

interface AvatarVideoOutlet {
    Capture(frame: AvatarVideoFrame): void;
    Publish(width: number, height: number): Promise<void>;
    SetAttributes(attributes: Record<string, string>): Promise<void>;
    Unpublish(): Promise<void>;
}

Implemented by

RtcNodeAvatarOutlet

Index

Methods

Capture Publish SetAttributes Unpublish

Methods

Capture

Capture(frame: AvatarVideoFrame): void
Shows one frame on the published track.
Parameters
- frame: AvatarVideoFrame
Returns void
- Defined in AI/RealtimeBridge/Providers/LiveKitNative/src/avatar-publisher.ts:78

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>
- Defined in AI/RealtimeBridge/Providers/LiveKitNative/src/avatar-publisher.ts:76

SetAttributes

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

Unpublish

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

Returns Promise<void>
- Defined in AI/RealtimeBridge/Providers/LiveKitNative/src/avatar-publisher.ts:80