hoshimi
    Preparing search index...

    Interface PlayOptions

    The options for playing a track.

    interface PlayOptions {
        endTime?: number;
        filters?: Partial<FilterSettings>;
        noReplace?: boolean;
        paused?: boolean;
        position?: number;
        track?: TrackResolvableStructure;
        voice?: {
            channelId: string;
            endpoint: string;
            sessionId: string;
            token: string;
        };
        volume?: number;
    }

    Hierarchy

    • BasePlayOptions
      • PlayOptions
    Index

    Properties

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

    Properties

    endTime?: number

    The position to end the track.

    filters?: Partial<FilterSettings>

    The filters for the player.

    noReplace?: boolean

    Whether to replace the current track.

    false
    paused?: boolean

    The pause state of the player.

    position?: number

    The position to start the track.

    track?: TrackResolvableStructure

    Track to play.

    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