Member Junction
    Preparing search index...

    Interface StartRoomAudioParams

    Parameters for RoomAudioPlayer.Start.

    interface StartRoomAudioParams {
        ContextUser: UserInfo;
        DisplayName?: string;
        Identity?: string;
        Loop?: boolean;
        Provider?: IMetadataProvider;
        RoomName: string;
        Source: RoomAudioSource;
    }
    Index

    Properties

    ContextUser DisplayName? Identity? Loop? Provider? RoomName Source

    Properties

    ContextUser: UserInfo

    The user the file load (and any announcement synthesis) runs as.

    DisplayName?: string

    The bot's display name in the room. Default 'On hold'.

    Identity?: string

    The bot's participant identity. Default hold-<playback id>.

    Loop?: boolean

    Loop the audio until stopped. Default true; when false the bot leaves the room once the audio ends.

    Provider?: IMetadataProvider

    The metadata provider for the file load. Default: the global provider.

    RoomName: string

    The LiveKit room to play into.

    Source: RoomAudioSource

    What to play.

    Settings

    Member Visibility

    On This Page

    Properties