kazagumo
    Preparing search index...

    Class KazagumoPlayer

    Index

    Constructors

    constructor

    Properties

    data guildId kazagumo loop paused playing queue search shoukaku state textId? voiceId volume

    Accessors

    filters position

    Methods

    connect destroy disconnect getPrevious pause play seek setLoop setTextChannel setVoiceChannel setVolume skip

    Constructors

    Properties

    data: Map<string, any> = ...

    Player's custom data

    guildId: string

    The guild ID of the player

    kazagumo: Kazagumo

    Kazagumo Instance

    loop: "none" | "queue" | "track" = 'none'

    Loop status

    paused: boolean = false

    Paused state of the player

    playing: boolean = false

    Whether the player is playing or not

    queue: KazagumoQueue

    Player's queue

    search: (
        query: string,
        options?: KazagumoSearchOptions,
    ) => Promise<KazagumoSearchResult>

    Search track/s

    shoukaku: Player

    Shoukaku's Player instance

    state: PlayerState = PlayerState.CONNECTING

    Get the current state of the player

    textId?: string

    The text channel ID of the player

    voiceId: string | null

    The voice channel ID of the player

    volume: number = 100

    Player's volume in percentage (default 100%)

    Accessors

    Methods

    • Get the previous track from the queue

      Parameters

      • remove: boolean = false

        Whether to remove the track from the previous list or not. Best to set to true if you want to play it

      Returns KazagumoTrack | undefined

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods