Interface NativeRoomModule

The native room module surface — a factory that constructs a NativeRoomClient.

interface NativeRoomModule {
createRoomClient(options: NativeRoomClientOptions): NativeRoomClient;
describeAvatarVideo?(): Promise<NativeAvatarVideoSupport>;
}

Index

Methods

createRoomClient describeAvatarVideo?

Methods

createRoomClient

createRoomClient(options: NativeRoomClientOptions): NativeRoomClient
Constructs a native room client from resolved options (credentials already resolved upstream). VERIFY against the native LiveKit Node SDK wrapper (createRoomClient vs a Room constructor).
Parameters
- options: NativeRoomClientOptions
Returns NativeRoomClient
- Defined in Providers/LiveKit/src/livekit-native-sdk.ts:252

`Optional`describeAvatarVideo

describeAvatarVideo?(): Promise<NativeAvatarVideoSupport>
Says whether this module's room clients can publish an agent's avatar on this host. The room coordinator asks before it opens a meeting session, so a host that cannot show the avatar never asks the model for it. Optional: a module without it publishes no avatars.

Returns Promise<NativeAvatarVideoSupport>
- Defined in Providers/LiveKit/src/livekit-native-sdk.ts:258