Class AvatarSession

Base class for avatar plugin sessions.

Plugin implementations should extend this class and call super.start(agentSession, room) first in their own start() method. The base:

Registers AvatarSession.aclose as a job shutdown callback, so avatar resources are released when the job shuts down.
Warns when the avatar session is started after AgentSession.start — in that case the existing audio output will be replaced by the avatar's.

Hierarchy (view full)

voice.AvatarSession
- AvatarSession

Index

Constructors

Methods

Constructors

constructor

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

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/runway/src/avatar.ts:310

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/runway/src/avatar.ts:108