Playlist
No description provided
Playlist
| Parameter | Type | Optional | Description |
|---|---|---|---|
| player | Player | ❌ | The player |
| data | PlaylistInitData | ❌ | The data |
Properties
public author: any
public description: any
public id: any
public player: any
public rawPlaylist: any
public source: any
public thumbnail: any
public title: any
public tracks: any
public type: any
public url: any
public durationFormatted: any
Formatted estimated duration of this playlist
public estimatedDuration: any
Estimated duration of this playlist
Methods
public [iterator](): Generator<Track<unknown>void | unknown>
public play(channel, options?): Promise<PlayerNodeInitializationResult<T>>
Play this playlist to the given voice channel. If queue exists and another track is being played, this playlist will be added to the queue.
| Parameter | Type | Optional | Description |
|---|---|---|---|
| channel | GuildVoiceChannelResolvable | ❌ | Voice channel on which this playlist shall be played |
| options | PlayerNodeInitializerOptions<T> | ✅ | Node initialization options |
public serialize(): SerializedPlaylist
Serialize this playlist into reconstructable data
public toJSON(withTracks?): PlaylistJSON
JSON representation of this playlist
| Parameter | Type | Optional | Description |
|---|---|---|---|
| withTracks | boolean | ✅ | If it should build json with tracks |
public static fromSerialized(player, data): Playlist
Deserialize this playlist from serialized data
| Parameter | Type | Optional | Description |
|---|---|---|---|
| player | Player | ❌ | Player instance |
| data | SerializedPlaylist | ❌ | Serialized data |