Class AvatarSession

An avatar session provisioned through LiveKit Inference.

Unlike BYOK avatar plugins, this calls the LiveKit Inference gateway with LiveKit credentials; the gateway creates the provider session with LiveKit's wholesale key. Media and RPC still flow in-room over DataStream, exactly as the BYOK plugins do.

Hierarchy (view full)

Constructors

constructor

Accessors

avatarIdentity provider providerSessionId sessionId

Methods

aclose start waitForJoin

Constructors

constructor

Accessors

avatarIdentity

provider

providerSessionId

sessionId

Methods

aclose

start

  • start(agentSession, room, options?): Promise<void>

  • Start the avatar session.

    Subclasses should override this method and call super.start(agentSession, room) at the top of their implementation. Subclasses may widen the return type (e.g. returning a session id), matching the # type: ignore[override] escape hatch used in Python.

    Parameters

    Returns Promise<void>

waitForJoin

  • waitForJoin(timeout?): Promise<void>

  • Wait until the avatar participant has joined the room and published its video track.

    Parameters

    • timeout: {
          timeout?: null | number;
      } = {}

      Timeout in milliseconds. Pass null to wait indefinitely.

      • Optional timeout?: null | number

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructoravatarIdentityproviderproviderSessionIdsessionIdaclosestartwaitForJoin