Class AvatarSession

constructor

• new AvatarSession(options?): AvatarSession

• Parameters

  • options: AvatarSessionOptions = {}

  Returns AvatarSession

conversationId

avatarIdentity

• get avatarIdentity(): string

• Returns string

provider

• get provider(): string

• Returns string

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>