Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Player

Hierarchy

  • Player

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private Optional connection

connection: VoiceConnection | null

Private options

options: PlayerOptions

Readonly q

q: Q<Track> = new Q<Track>()

Accessors

guildId

  • get guildId(): string

isPaused

  • get isPaused(): boolean

isPlaying

  • get isPlaying(): boolean

  • Whether the queue is not empty and audio is being emitted.

    Returns boolean

position

  • get position(): number

  • The time (in milliseconds) that the track has been playing audio for.

    Returns number

textChannel

  • get textChannel(): TextChannel

  • Text channel that the player is connected to.

    Returns TextChannel

voiceChannel

  • get voiceChannel(): VoiceChannel

  • Voice channel that the player is connected to.

    Returns VoiceChannel

Methods

join

  • join(): Promise<void>

leave

  • leave(): Promise<void>

pause

  • pause(): Promise<void>

play

  • play(query: string, requestor?: GuildMember): Promise<Track>

  • Joins a channel, then plays a track from YouTube. If a track is already playing, it will be queued.

    Parameters

    • query: string

      Term to search YouTube for tracks.

    • Optional requestor: GuildMember

      Guild member who requested to play this track.

    Returns Promise<Track>

Private playTrack

  • playTrack(track: Track, seek?: number): Promise<Track>

resume

  • resume(): Promise<void>

seek

  • seek(position: number): Promise<void>

  • Move position in current playing track.

    Parameters

    • position: number

      Time (in seconds) to seek to.

    Returns Promise<void>

setVolume

  • setVolume(amount: number): Promise<void>

  • Set volume of player.

    Parameters

    • amount: number

      Value from 0 - 1.

    Returns Promise<void>

skip

  • skip(count?: number): Promise<Track>

  • Skip one or more tracks, and return track to play.

    Parameters

    • Default value count: number = 1

      Number of tracks to skip.

    Returns Promise<Track>

stop

  • stop(): Promise<void>

Generated using TypeDoc