[youtubei.js](../../../README.md) / [YTMusic](../README.md) / TrackInfo # Class: TrackInfo ## Extends - [`MediaInfo`](../../Mixins/classes/MediaInfo.md) ## Constructors ### new TrackInfo() > **new TrackInfo**(`data`, `actions`, `cpn`): [`TrackInfo`](TrackInfo.md) #### Parameters • **data**: [[`ApiResponse`](../../../interfaces/ApiResponse.md), `ApiResponse?`] • **actions**: [`Actions`](../../../classes/Actions.md) • **cpn**: `string` #### Returns [`TrackInfo`](TrackInfo.md) #### Overrides [`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`constructor`](../../Mixins/classes/MediaInfo.md#constructors) #### Defined in [src/parser/ytmusic/TrackInfo.ts:26](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/ytmusic/TrackInfo.ts#L26) ## Properties ### annotations? > `optional` **annotations**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`PlayerAnnotationsExpanded`](../../YTNodes/classes/PlayerAnnotationsExpanded.md)\> #### Inherited from [`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`annotations`](../../Mixins/classes/MediaInfo.md#annotations) #### Defined in [src/core/mixins/MediaInfo.ts:31](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/MediaInfo.ts#L31) *** ### basic\_info > **basic\_info**: `object` #### allow\_ratings? > `optional` **allow\_ratings**: `boolean` #### author? > `optional` **author**: `string` #### category > **category**: `null` \| `string` #### channel > **channel**: `null` \| `object` #### channel\_id? > `optional` **channel\_id**: `string` #### duration? > `optional` **duration**: `number` #### embed > **embed**: `undefined` \| `null` \| `object` #### end\_timestamp > **end\_timestamp**: `null` \| `Date` #### has\_ypc\_metadata > **has\_ypc\_metadata**: `null` \| `boolean` #### id? > `optional` **id**: `string` #### is\_crawlable? > `optional` **is\_crawlable**: `boolean` #### is\_disliked > **is\_disliked**: `undefined` \| `boolean` #### is\_family\_safe > **is\_family\_safe**: `undefined` \| `boolean` = `info.microformat.is_family_safe` #### is\_liked > **is\_liked**: `undefined` \| `boolean` #### is\_live? > `optional` **is\_live**: `boolean` #### is\_live\_content? > `optional` **is\_live\_content**: `boolean` #### is\_live\_dvr\_enabled? > `optional` **is\_live\_dvr\_enabled**: `boolean` #### is\_low\_latency\_live\_stream? > `optional` **is\_low\_latency\_live\_stream**: `boolean` #### is\_owner\_viewing? > `optional` **is\_owner\_viewing**: `boolean` #### is\_post\_live\_dvr? > `optional` **is\_post\_live\_dvr**: `boolean` #### is\_private? > `optional` **is\_private**: `boolean` #### is\_unlisted > **is\_unlisted**: `undefined` \| `boolean` = `info.microformat.is_unlisted` #### is\_upcoming? > `optional` **is\_upcoming**: `boolean` #### keywords? > `optional` **keywords**: `string`[] #### like\_count > **like\_count**: `undefined` \| `number` #### live\_chunk\_readahead? > `optional` **live\_chunk\_readahead**: `number` #### short\_description? > `optional` **short\_description**: `string` #### start\_timestamp > **start\_timestamp**: `null` \| `Date` #### tags > **tags**: `null` \| `string`[] #### thumbnail? > `optional` **thumbnail**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[] #### title? > `optional` **title**: `string` #### url\_canonical > **url\_canonical**: `null` \| `string` #### view\_count > **view\_count**: `undefined` \| `number` #### Inherited from [`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`basic_info`](../../Mixins/classes/MediaInfo.md#basic_info) #### Defined in [src/core/mixins/MediaInfo.ts:30](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/MediaInfo.ts#L30) *** ### captions? > `optional` **captions**: [`PlayerCaptionsTracklist`](../../YTNodes/classes/PlayerCaptionsTracklist.md) #### Inherited from [`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`captions`](../../Mixins/classes/MediaInfo.md#captions) #### Defined in [src/core/mixins/MediaInfo.ts:34](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/MediaInfo.ts#L34) *** ### cards? > `optional` **cards**: [`CardCollection`](../../YTNodes/classes/CardCollection.md) #### Inherited from [`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`cards`](../../Mixins/classes/MediaInfo.md#cards) #### Defined in [src/core/mixins/MediaInfo.ts:35](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/MediaInfo.ts#L35) *** ### current\_video\_endpoint? > `optional` **current\_video\_endpoint**: [`NavigationEndpoint`](../../YTNodes/classes/NavigationEndpoint.md) #### Defined in [src/parser/ytmusic/TrackInfo.ts:23](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/ytmusic/TrackInfo.ts#L23) *** ### endscreen? > `optional` **endscreen**: [`Endscreen`](../../YTNodes/classes/Endscreen.md) #### Inherited from [`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`endscreen`](../../Mixins/classes/MediaInfo.md#endscreen) #### Defined in [src/core/mixins/MediaInfo.ts:33](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/MediaInfo.ts#L33) *** ### playability\_status? > `optional` **playability\_status**: [`IPlayabilityStatus`](../../APIResponseTypes/interfaces/IPlayabilityStatus.md) #### Inherited from [`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`playability_status`](../../Mixins/classes/MediaInfo.md#playability_status) #### Defined in [src/core/mixins/MediaInfo.ts:37](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/MediaInfo.ts#L37) *** ### player\_config? > `optional` **player\_config**: [`IPlayerConfig`](../../APIResponseTypes/interfaces/IPlayerConfig.md) #### Inherited from [`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`player_config`](../../Mixins/classes/MediaInfo.md#player_config) #### Defined in [src/core/mixins/MediaInfo.ts:38](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/MediaInfo.ts#L38) *** ### player\_overlays? > `optional` **player\_overlays**: [`PlayerOverlay`](../../YTNodes/classes/PlayerOverlay.md) #### Defined in [src/parser/ytmusic/TrackInfo.ts:24](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/ytmusic/TrackInfo.ts#L24) *** ### storyboards? > `optional` **storyboards**: [`PlayerLiveStoryboardSpec`](../../YTNodes/classes/PlayerLiveStoryboardSpec.md) \| [`PlayerStoryboardSpec`](../../YTNodes/classes/PlayerStoryboardSpec.md) #### Inherited from [`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`storyboards`](../../Mixins/classes/MediaInfo.md#storyboards) #### Defined in [src/core/mixins/MediaInfo.ts:32](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/MediaInfo.ts#L32) *** ### streaming\_data? > `optional` **streaming\_data**: [`IStreamingData`](../../APIResponseTypes/interfaces/IStreamingData.md) #### Inherited from [`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`streaming_data`](../../Mixins/classes/MediaInfo.md#streaming_data) #### Defined in [src/core/mixins/MediaInfo.ts:36](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/MediaInfo.ts#L36) *** ### tabs? > `optional` **tabs**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Tab`](../../YTNodes/classes/Tab.md)\> #### Defined in [src/parser/ytmusic/TrackInfo.ts:22](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/ytmusic/TrackInfo.ts#L22) ## Accessors ### actions > `get` **actions**(): [`Actions`](../../../classes/Actions.md) Actions instance. #### Returns [`Actions`](../../../classes/Actions.md) #### Inherited from [`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`actions`](../../Mixins/classes/MediaInfo.md#actions) #### Defined in [src/core/mixins/MediaInfo.ts:223](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/MediaInfo.ts#L223) *** ### available\_tabs > `get` **available\_tabs**(): `string`[] #### Returns `string`[] #### Defined in [src/parser/ytmusic/TrackInfo.ts:126](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/ytmusic/TrackInfo.ts#L126) *** ### cpn > `get` **cpn**(): `string` Content Playback Nonce. #### Returns `string` #### Inherited from [`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`cpn`](../../Mixins/classes/MediaInfo.md#cpn) #### Defined in [src/core/mixins/MediaInfo.ts:230](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/MediaInfo.ts#L230) *** ### page > `get` **page**(): [[`IPlayerResponse`](../../APIResponseTypes/type-aliases/IPlayerResponse.md), `INextResponse?`] Original parsed InnerTube response. #### Returns [[`IPlayerResponse`](../../APIResponseTypes/type-aliases/IPlayerResponse.md), `INextResponse?`] #### Inherited from [`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`page`](../../Mixins/classes/MediaInfo.md#page) #### Defined in [src/core/mixins/MediaInfo.ts:237](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/MediaInfo.ts#L237) ## Methods ### addToWatchHistory() > **addToWatchHistory**(): `Promise`\<`Response`\> Adds the song to the watch history. #### Returns `Promise`\<`Response`\> #### Overrides [`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`addToWatchHistory`](../../Mixins/classes/MediaInfo.md#addtowatchhistory) #### Defined in [src/parser/ytmusic/TrackInfo.ts:122](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/ytmusic/TrackInfo.ts#L122) *** ### chooseFormat() > **chooseFormat**(`options`): [`Format`](../../Misc/classes/Format.md) Selects the format that best matches the given options. #### Parameters • **options**: [`FormatOptions`](../../Types/interfaces/FormatOptions.md) Options #### Returns [`Format`](../../Misc/classes/Format.md) #### Inherited from [`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`chooseFormat`](../../Mixins/classes/MediaInfo.md#chooseformat) #### Defined in [src/core/mixins/MediaInfo.ts:149](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/MediaInfo.ts#L149) *** ### download() > **download**(`options`): `Promise`\<`ReadableStream`\<`Uint8Array`\>\> Downloads the video. #### Parameters • **options**: [`DownloadOptions`](../../Types/interfaces/DownloadOptions.md) = `{}` Download options. #### Returns `Promise`\<`ReadableStream`\<`Uint8Array`\>\> #### Inherited from [`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`download`](../../Mixins/classes/MediaInfo.md#download) #### Defined in [src/core/mixins/MediaInfo.ts:157](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/MediaInfo.ts#L157) *** ### getLyrics() > **getLyrics**(): `Promise`\<`undefined` \| [`MusicDescriptionShelf`](../../YTNodes/classes/MusicDescriptionShelf.md)\> Retrieves lyrics. #### Returns `Promise`\<`undefined` \| [`MusicDescriptionShelf`](../../YTNodes/classes/MusicDescriptionShelf.md)\> #### Defined in [src/parser/ytmusic/TrackInfo.ts:114](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/ytmusic/TrackInfo.ts#L114) *** ### getRelated() > **getRelated**(): `Promise`\<[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MusicCarouselShelf`](../../YTNodes/classes/MusicCarouselShelf.md) \| [`MusicDescriptionShelf`](../../YTNodes/classes/MusicDescriptionShelf.md)\>\> Retrieves related content. #### Returns `Promise`\<[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`MusicCarouselShelf`](../../YTNodes/classes/MusicCarouselShelf.md) \| [`MusicDescriptionShelf`](../../YTNodes/classes/MusicDescriptionShelf.md)\>\> #### Defined in [src/parser/ytmusic/TrackInfo.ts:106](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/ytmusic/TrackInfo.ts#L106) *** ### getStreamingInfo() > **getStreamingInfo**(`url_transformer`?, `format_filter`?): `StreamingInfo` Get a cleaned up representation of the adaptive_formats #### Parameters • **url\_transformer?**: [`URLTransformer`](../../Types/type-aliases/URLTransformer.md) • **format\_filter?**: [`FormatFilter`](../../Types/type-aliases/FormatFilter.md) #### Returns `StreamingInfo` #### Inherited from [`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`getStreamingInfo`](../../Mixins/classes/MediaInfo.md#getstreaminginfo) #### Defined in [src/core/mixins/MediaInfo.ts:132](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/MediaInfo.ts#L132) *** ### getTab() > **getTab**(`title_or_page_type`): `Promise`\<[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`Message`](../../YTNodes/classes/Message.md)\> Retrieves contents of the given tab. #### Parameters • **title\_or\_page\_type**: `string` #### Returns `Promise`\<[`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\> \| [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`Message`](../../YTNodes/classes/Message.md)\> #### Defined in [src/parser/ytmusic/TrackInfo.ts:45](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/ytmusic/TrackInfo.ts#L45) *** ### getTranscript() > **getTranscript**(): `Promise`\<[`TranscriptInfo`](../../YT/classes/TranscriptInfo.md)\> Retrieves the video's transcript. #### Returns `Promise`\<[`TranscriptInfo`](../../YT/classes/TranscriptInfo.md)\> #### Inherited from [`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`getTranscript`](../../Mixins/classes/MediaInfo.md#gettranscript) #### Defined in [src/core/mixins/MediaInfo.ts:170](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/MediaInfo.ts#L170) *** ### getUpNext() > **getUpNext**(`automix`): `Promise`\<[`PlaylistPanel`](../../YTNodes/classes/PlaylistPanel.md)\> Retrieves up next. #### Parameters • **automix**: `boolean` = `true` #### Returns `Promise`\<[`PlaylistPanel`](../../YTNodes/classes/PlaylistPanel.md)\> #### Defined in [src/parser/ytmusic/TrackInfo.ts:74](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/ytmusic/TrackInfo.ts#L74) *** ### toDash() > **toDash**(`url_transformer`?, `format_filter`?, `options`?): `Promise`\<`string`\> Generates a DASH manifest from the streaming data. #### Parameters • **url\_transformer?**: [`URLTransformer`](../../Types/type-aliases/URLTransformer.md) Function to transform the URLs. • **format\_filter?**: [`FormatFilter`](../../Types/type-aliases/FormatFilter.md) Function to filter the formats. • **options?**: `DashOptions` = `...` Additional options to customise the manifest generation #### Returns `Promise`\<`string`\> DASH manifest #### Inherited from [`MediaInfo`](../../Mixins/classes/MediaInfo.md).[`toDash`](../../Mixins/classes/MediaInfo.md#todash) #### Defined in [src/core/mixins/MediaInfo.ts:97](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/mixins/MediaInfo.ts#L97)