Class AvatarSession

A Protoface avatar session for LiveKit Agents.

Hierarchy (view full)

voice.AvatarSession
- AvatarSession

Index

Constructors

Accessors

avatarIdentity provider sessionId

Methods

aclose start waitForJoin

Constructors

constructor

new AvatarSession(options?): AvatarSession
Parameters
- options: AvatarSessionOptions = {}
Returns AvatarSession
Overrides AvatarSession.constructor
- Defined in plugins/protoface/src/avatar.ts:69

Accessors

avatarIdentity

get avatarIdentity(): string
Returns string
Overrides voice.AvatarSession.avatarIdentity
- Defined in plugins/protoface/src/avatar.ts:82

provider

get provider(): string
Returns string
Overrides voice.AvatarSession.provider
- Defined in plugins/protoface/src/avatar.ts:86

sessionId

get sessionId(): null | string
Protoface session ID after start() succeeds, otherwise null.

Returns null | string
- Defined in plugins/protoface/src/avatar.ts:91

Methods

aclose

aclose(): Promise<void>
Release any resources owned by this avatar session. Default implementation is a no-op; subclasses can override to perform cleanup.

Returns Promise<void>
Overrides AvatarSession.aclose
- Defined in plugins/protoface/src/avatar.ts:147

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
- agentSession: AgentSession<unknown>
- room: Room
- options: StartOptions = {}
Returns Promise<void>
Overrides AvatarSession.start
- Defined in plugins/protoface/src/avatar.ts:95

waitForJoin

waitForJoin(timeout?): Promise<void>
Wait until the avatar participant has joined the room and published its video track.
Parameters
- Optional timeout: {
  timeout?: null | number;
  }
  Timeout in milliseconds. Pass null to wait indefinitely.
  - Optional timeout?: null | number
Returns Promise<void>
Inherited from AvatarSession.waitForJoin
- Defined in agents/dist/voice/avatar/avatar_session.d.ts:36