Class Song<T>

Class representing a song.

If Song is added from a YouTube SearchResult or Playlist, some info will be missing to save your resources. It will be filled when emitting DisTube#playSong event.

Missing info: Song#likes, Song#dislikes, Song#streamURL, Song#related, Song#chapters, Song#age_restricted

Type Parameters

T = unknown

Index

Constructors

constructor

new Song<T>(info, options?): Song<T>
Create a Song
Type Parameters
- T = unknown
Parameters
- info: SearchResult | OtherSongInfo | RelatedSong | videoInfo | relatedVideo | {
      author: null | {
          name: string;
          ref: string;
      };
      duration: null | string;
      id: string;
      thumbnail: string;
      title: string;
      url: string;
      url_simple: string;
  }
  Raw info
- options: {
      member?: GuildMember;
      metadata?: T;
      source?: string;
  } = {}
  Optional options
  - Optional member?: GuildMember
  - Optional metadata?: T
  - Optional source?: string
Returns Song<T>
- Defined in src/struct/Song.ts:49

Properties

`Private` `Optional` #member

#member?: GuildMember

`Private` #metadata

#metadata: T

`Private` `Optional` #playlist

#playlist?: Playlist<unknown>

age_restricted

age_restricted: boolean

chapters

chapters: Chapter[]

dislikes

dislikes: number

duration

duration: number

`Optional` formats

formats?: videoFormat[]

`Optional` formattedDuration

formattedDuration?: string

`Optional` id

id?: string

isLive

isLive: boolean

likes

likes: number

`Optional` name

name?: string

related: RelatedSong[]

reposts

reposts: number

source

source: string

`Optional` streamURL

streamURL?: string

`Optional` thumbnail

thumbnail?: string

uploader

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

Type declaration

Optional name?: string
Optional url?: string

url

url: string

views

views: number

Accessors

member

get member(): undefined | GuildMember
User requested.

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

metadata

get metadata(): T
Returns T
- Defined in src/struct/Song.ts:248
set metadata(metadata): void
Parameters
- metadata: T
Returns void
- Defined in src/struct/Song.ts:252

playlist

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

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

user

get user(): undefined | User
User requested.

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

Methods

_patchOther

_patchOther(info): void
Patch data from other source
Parameters
- info: OtherSongInfo
  Video info
Returns void
- Defined in src/struct/Song.ts:187

_patchYouTube

_patchYouTube(i): void
Parameters
- i: SearchResult | videoInfo
Returns void
- Defined in src/struct/Song.ts:88

Class Song<T>

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Optional member?: GuildMember

Optional metadata?: T

Optional source?: string

Returns Song<T>

Properties

Private Optional #member

Private #metadata

Private Optional #playlist

age_restricted

chapters

dislikes

duration

Optional formats

Optional formattedDuration

Optional id

isLive

likes

Optional name

related

reposts

source

Optional streamURL

Optional thumbnail

uploader

Type declaration

Optional name?: string

Optional url?: string

url

views

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

_patchOther

Parameters

Returns void

_patchYouTube

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

`Optional` member?: GuildMember

`Optional` metadata?: T

`Optional` source?: string

`Private` `Optional` #member

`Private` #metadata

`Private` `Optional` #playlist

`Optional` formats

`Optional` formattedDuration

`Optional` id

`Optional` name

`Optional` streamURL

`Optional` thumbnail

`Optional` name?: string

`Optional` url?: string