hoshimi
    Preparing search index...

    Interface LavalinkPlayOptions

    The options for playing a track with Lavalink.

    interface LavalinkPlayOptions {
        endTime?: number;
        filters?: Partial<FilterSettings>;
        paused?: boolean;
        position?: number;
        track?: {
            encoded?: string | null;
            info?: TrackInfo | null;
            pluginInfo?: PluginInfo | null;
            userData?: unknown;
        };
        voice?: {
            channelId: string;
            endpoint: string;
            sessionId: string;
            token: string;
        };
        volume?: number;
    }

    Hierarchy

    • BasePlayOptions
      • LavalinkPlayOptions
    Index

    Properties

    endTime? filters? paused? position? track? voice? volume?

    Properties

    endTime?: number

    The position to end the track.

    filters?: Partial<FilterSettings>

    The filters for the player.

    paused?: boolean

    The pause state of the player.

    position?: number

    The position to start the track.

    track?: {
        encoded?: string | null;
        info?: TrackInfo | null;
        pluginInfo?: PluginInfo | null;
        userData?: unknown;
    }

    Track to play.

    Type Declaration

    • Optionalencoded?: string | null

      The base64 encoded track.

    • Optionalinfo?: TrackInfo | null

      The track information.

    • OptionalpluginInfo?: PluginInfo | null

      The plugin information of the track.

    • OptionaluserData?: unknown

      The user data of the track.

    voice?: {
        channelId: string;
        endpoint: string;
        sessionId: string;
        token: string;
    }

    The voice settings for the player.

    Type Declaration

    • channelId: string

      The voice channel id.

    • endpoint: string

      The voice server endpoint.

    • sessionId: string

      The voice server session id.

    • token: string

      The voice server token.

    volume?: number

    The volume of the player.

    Settings

    Member Visibility

    On This Page

    Properties