Class Song<T>

Class representing a song.

Type Parameters

T = unknown

Index

Constructors

Constructors

constructor

new Song<T>(info, options?): Song<T>
Create a Song
Type Parameters
- T = unknown
Parameters
- info: SongInfo
  Raw song info
- options: ResolveOptions<T> = {}
  Optional data
Returns Song<T>
- Defined in src/struct/Song.ts:106

Properties

`Optional`ageRestricted

ageRestricted?: boolean

Whether or not an age-restricted content

`Optional`dislikes

dislikes?: number

Song dislike count

duration

duration: number

Song duration.

formattedDuration

formattedDuration: string

Formatted duration string (hh:mm:ss, mm:ss or Live).

id

id: string

Song ID.

`Optional`isLive

isLive?: boolean

Indicates if the song is an active live.

`Optional`likes

likes?: number

Song like count

`Optional`name

name?: string

Song name.

plugin

plugin: null | DisTubePlugin

The plugin that created this song

`Optional`reposts

reposts?: number

Song repost (share) count

source

source: string

The source of this song info

stream

stream: {
    playFromSource: true;
    url?: string;
} | {
    playFromSource: false;
    song?: Song<T>;
}

Stream info

Type declaration

playFromSource: true
The stream of this song will be played from source
Optionalurl?: string
Stream URL of this song

Type declaration

playFromSource: false
The stream of this song will be played from another song
Optionalsong?: Song<T>
The song that this song will be played from

`Optional`thumbnail

thumbnail?: string

Song thumbnail.

uploader

uploader: {
name?: string;
url?: string;
}

Song uploader

`Optional`url

url?: string

Song URL.

`Optional`views

views?: number

Song view count

Accessors

member

get member(): undefined | GuildMember
User requested to play this song.

Returns undefined | GuildMember
- Defined in src/struct/Song.ts:146
set member(member): void
Parameters
- member: undefined | GuildMember
Returns void
- Defined in src/struct/Song.ts:150

metadata

get metadata(): T
Optional metadata that can be used to identify the song. This is attached by the DisTube#play method.

Returns T
- Defined in src/struct/Song.ts:165
set metadata(metadata): void
Parameters
- metadata: T
Returns void
- Defined in src/struct/Song.ts:169

playlist

get playlist(): undefined | Playlist<unknown>
The playlist this song belongs to

Returns undefined | Playlist<unknown>
- Defined in src/struct/Song.ts:133
set playlist(playlist): void
Parameters
- playlist: undefined | Playlist<unknown>
Returns void
- Defined in src/struct/Song.ts:137

user

get user(): undefined | User
User requested to play this song.

Returns undefined | User
- Defined in src/struct/Song.ts:157

Methods

toString

toString(): string
Returns string
- Defined in src/struct/Song.ts:173

Class Song<T>

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Song<T>

Properties

OptionalageRestricted

Optionaldislikes

duration

formattedDuration

id

OptionalisLive

Optionallikes

Optionalname

plugin

Optionalreposts

source

stream

Type declaration

playFromSource: true

Optionalurl?: string

Type declaration

playFromSource: false

Optionalsong?: Song<T>

Optionalthumbnail

uploader

Optionalurl

Optionalviews

Accessors

member

Returns undefined | GuildMember

Parameters

Returns void

metadata

Returns T

Parameters

Returns void

playlist

Returns undefined | Playlist<unknown>

Parameters

Returns void

user

Returns undefined | User

Methods

toString

Returns string

Settings

On This Page

`Optional`ageRestricted

`Optional`dislikes

`Optional`isLive

`Optional`likes

`Optional`name

`Optional`reposts

`Optional`url?: string

`Optional`song?: Song<T>

`Optional`thumbnail

`Optional`url

`Optional`views