Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MusicPlaylist

Hierarchy

  • MusicPlaylist

Index

Constructors

Properties

author: Author[]

Array of authors of the playlist. For example, a YouTube channel or SoundCloud user profile

duration: number

Duration of all the tracks in seconds

durationTimestamp: string

Duration of all the tracks in timestamp (e.g. 12:34)

isAlbum: boolean

Is the playlist an album?

metadata: { collaborative?: boolean; id?: string; queuedBy?: any }

Type declaration

  • Optional collaborative?: boolean

    Is the playlist collaborative/editable by other users on the platform?

  • Optional id?: string

    ID of the playlist on the platform

  • Optional queuedBy?: any

    A reference to the user that queued the playlist - Can be set via MusicPlaylist.setQueuedBy or modified manually

name: string

Name of the playlist

originalData?: any

Original data retreieved from request to service's API. There for debug and if theres any metadata not included in MusicTrack itself.

service: Service

The service providing the playlist

thumbnail?: string

Thumbnail of the playlist

tracks: MusicTrack[]

Array of MusicTracks in playlist

url: string

Friendly URL of the playlist

Methods

  • Set who queued the playlist, for example the user's Discord ID. This will also set who queued all the tracks.

    Parameters

    • queuedBy: any

    Returns MusicPlaylist

Generated using TypeDoc