Class RainlinkPlayer

A class for managing player action.

Constructors

constructor

Properties

manager node guildId voiceId textId queue data paused position volume playing loop state deaf mute track functions shardId filter voice

Methods

sendServerUpdate destroy play setLoop search pause resume setPause previous getPrevious skip seek setVolume setMute stop clear setDeaf disconnect setTextChannel setVoiceChannel send

Constructors

constructor

Properties

manager

manager: Rainlink

Main manager class

node

node: RainlinkNode

Player's current using lavalink server

guildId

guildId: string

Player's guild id

voiceId

voiceId: null | string

Player's voice id

textId

textId: string

Player's text id

Readonlyqueue

queue: RainlinkQueue

Player's queue

Readonlydata

data: RainlinkDatabase<unknown>

The temporary database of player, u can set any thing here and us like Map class!

paused

paused: boolean = true

Whether the player is paused or not

position

position: number = 0

Get the current track's position of the player

volume

volume: number

Get the current volume of the player

playing

playing: boolean = false

Whether the player is playing or not

loop

loop: RainlinkLoopMode

Get the current loop mode of the player

state

state: RainlinkPlayerState

Get the current state of the player

deaf

deaf: boolean

Whether the player is deafened or not

mute

mute: boolean

Whether the player is muted or not

track

track: null | string = null

ID of the current track

functions

functions: RainlinkFunctions

All function to extend support driver

shardId

shardId: number

ID of the Shard that contains the guild that contains the connected voice channel

filter

filter: RainlinkFilter

Filter class to set, clear get the current filter data

voice

voice: RainlinkVoice

Voice handler class

Methods

sendServerUpdate

  • sendServerUpdate(): Promise<void>
  • Internal

    Sends server update to lavalink

    Returns Promise<void>

destroy

  • destroy(): Promise<void>
  • Internal

    Destroy the player

    Returns Promise<void>

play

setLoop

search

pause

resume

setPause

  • setPause(mode): Promise<RainlinkPlayer>

  • Pause or resume a track but different method

    Parameters

    • mode: boolean

      Whether to pause or not

    Returns Promise<RainlinkPlayer>

    RainlinkPlayer

previous

  • previous(): Promise<RainlinkPlayer>

  • Play the previous track

    Returns Promise<RainlinkPlayer>

    RainlinkPlayer

getPrevious

  • getPrevious(): RainlinkTrack[]

  • Get all previous track

    Returns RainlinkTrack[]

    RainlinkTrack[]

skip

  • skip(): Promise<RainlinkPlayer>

  • Skip the current track

    Returns Promise<RainlinkPlayer>

    RainlinkPlayer

seek

  • seek(position): Promise<RainlinkPlayer>

  • Seek to another position in track

    Parameters

    • position: number

      Position to seek

    Returns Promise<RainlinkPlayer>

    RainlinkPlayer

setVolume

  • setVolume(volume): Promise<RainlinkPlayer>

  • Set another volume in player

    Parameters

    • volume: number

      Volume to cange

    Returns Promise<RainlinkPlayer>

    RainlinkPlayer

setMute

  • setMute(enable): RainlinkPlayer

  • Set player to mute or unmute

    Parameters

    • enable: boolean

      Enable or not

    Returns RainlinkPlayer

    RainlinkPlayer

stop

  • stop(destroy): Promise<RainlinkPlayer>

  • Stop all avtivities and reset to default

    Parameters

    • destroy: boolean

      Whenever you want to destroy a player or not

    Returns Promise<RainlinkPlayer>

    RainlinkPlayer

clear

  • clear(emitEmpty): void

  • Reset all data to default

    Parameters

    • emitEmpty: boolean

      Whenever emit empty event or not

    Returns void

setDeaf

  • setDeaf(enable): RainlinkPlayer

  • Set player to deaf or undeaf

    Parameters

    • enable: boolean

      Enable or not

    Returns RainlinkPlayer

    RainlinkPlayer

disconnect

  • disconnect(): RainlinkPlayer

  • Disconnect from the voice channel

    Returns RainlinkPlayer

    RainlinkPlayer

setTextChannel

  • setTextChannel(textId): RainlinkPlayer

  • Set text channel

    Parameters

    • textId: string

      Text channel ID

    Returns RainlinkPlayer

    RainlinkPlayer

setVoiceChannel

  • setVoiceChannel(voiceId): RainlinkPlayer

  • Set voice channel and move the player to the voice channel

    Parameters

    • voiceId: string

      Voice channel ID

    Returns RainlinkPlayer

    RainlinkPlayer

send

  • send(data): Promise<RainlinkPlayer>

  • Send custom player update data to lavalink server

    Parameters

    Returns Promise<RainlinkPlayer>

    RainlinkPlayer

Settings

Member Visibility

On This Page

Constructors
Properties
Methods