Member Junction
    Preparing search index...

    Interface MintTokenParams

    Parameters for minting a single access token.

    interface MintTokenParams {
        Attributes?: Record<string, string>;
        CanPublish?: boolean;
        CanPublishData?: boolean;
        CanSubscribe?: boolean;
        CanUpdateOwnMetadata?: boolean;
        DisplayName?: string;
        Identity: string;
        Metadata?: Record<string, unknown>;
        Role?: LiveKitTokenRole;
        RoomName: string;
        TtlSeconds?: number;
    }
    Index

    Properties

    Attributes? CanPublish? CanPublishData? CanSubscribe? CanUpdateOwnMetadata? DisplayName? Identity Metadata? Role? RoomName TtlSeconds?

    Properties

    Attributes?: Record<string, string>

    LiveKit participant attributes the participant carries from the moment it joins (e.g. mj.agentWatches on an agent's bot). Attributes are shared with every participant and announced on change.

    CanPublish?: boolean

    Whether the participant may publish media. Default: true.

    CanPublishData?: boolean

    Whether the participant may publish data-channel messages. Default: true.

    CanSubscribe?: boolean

    Whether the participant may subscribe to others. Default: true.

    CanUpdateOwnMetadata?: boolean

    Whether the participant may change its own name, metadata and attributes. Default: false (LiveKit's default). Agent bots get it, so a bot can say when its avatar was taken down (mj.agentAvatar).

    DisplayName?: string

    The display name to publish.

    Identity: string

    The participant identity to embed (stable, application-assigned).

    Metadata?: Record<string, unknown>

    Extra metadata merged into the participant metadata JSON.

    Role?: LiveKitTokenRole

    The role stamped into participant metadata (drives the UI's agent/host badges).

    RoomName: string

    The room name the token authorizes joining.

    TtlSeconds?: number

    Token lifetime in seconds. Default: 3600 (1 hour).

    Settings

    Member Visibility

    On This Page

    Properties