Interface AvatarSessionOptions

Options for configuring an AvatarSession.

interface AvatarSessionOptions {
    apiKey?: string;
    apiUrl?: string;
    avatarId?: null | string;
    avatarImage?: null | AvatarImage;
    avatarParticipantIdentity?: string;
    avatarParticipantName?: string;
    connOptions?: APIConnectOptions;
}

Properties

apiKey? apiUrl? avatarId? avatarImage? avatarParticipantIdentity? avatarParticipantName? connOptions?

Properties

Optional apiKey

apiKey?: string

The Hedra API key. Can also be set via HEDRA_API_KEY environment variable.

Optional apiUrl

apiUrl?: string

The Hedra API URL. Defaults to https://api.hedra.com/public/livekit/v1/session or HEDRA_API_URL environment variable.

Optional avatarId

avatarId?: null | string

The avatar ID to use. Either avatarId or avatarImage must be provided.

Optional avatarImage

avatarImage?: null | AvatarImage

A custom avatar image to use. Either avatarId or avatarImage must be provided.

Optional avatarParticipantIdentity

avatarParticipantIdentity?: string

The identity of the avatar participant in the room. Defaults to 'hedra-avatar-agent'.

Optional avatarParticipantName

avatarParticipantName?: string

The name of the avatar participant in the room. Defaults to 'hedra-avatar-agent'.

Optional connOptions

connOptions?: APIConnectOptions

Connection options for API requests.

Settings

Member Visibility

Theme

On This Page

apiKeyapiUrlavatarIdavatarImageavatarParticipantIdentityavatarParticipantNameconnOptions