YouTube.js/docs/api/namespaces/YT/classes/Playlist.md

youtubei.js / YT / Playlist

Class: Playlist

Extends

• Feed<IBrowseResponse>

Constructors

new Playlist()

new Playlist(actions, data, already_parsed): Playlist

Parameters

• actions: Actions

• data: ApiResponse | IBrowseResponse

• already_parsed: boolean = false

Returns

Playlist

Overrides

Feed.constructor

Defined in

src/parser/youtube/Playlist.ts:32

Properties

endpoint?

optional endpoint: NavigationEndpoint

Defined in

src/parser/youtube/Playlist.ts:29

---

info

info: object

author

author: Author

can_delete

can_delete: boolean = header.can_delete

can_reorder

can_reorder: boolean = video_list.can_reorder

can_share

can_share: boolean = header.can_share

description?

optional description: string

is_editable

is_editable: boolean = video_list.is_editable

last_updated

last_updated: string

privacy

privacy: string = header.privacy

subtitle

subtitle: null | Text

thumbnails

thumbnails: Thumbnail[]

title?

optional title: string

total_items

total_items: string

type?

readonly optional type: string

views

views: string

Defined in

src/parser/youtube/Playlist.ts:27

---

menu

menu: YTNode

Defined in

src/parser/youtube/Playlist.ts:28

---

messages

messages: ObservedArray<Message>

Defined in

src/parser/youtube/Playlist.ts:30

Accessors

actions

get actions(): Actions

Returns

Actions

Inherited from

Feed.actions

Defined in

src/core/mixins/Feed.ts:181

---

channels

get channels(): ObservedArray<Channel | GridChannel>

Get all the channels in the feed

Returns

ObservedArray<Channel | GridChannel>

Inherited from

Feed.channels

Defined in

src/core/mixins/Feed.ts:126

---

has_continuation

get has_continuation(): boolean

Checks if the feed has continuation.

Returns

boolean

Overrides

Feed.has_continuation

Defined in

src/parser/youtube/Playlist.ts:73

---

items

get items(): ObservedArray<PlaylistVideo | ReelItem | ShortsLockupView>

Returns

ObservedArray<PlaylistVideo | ReelItem | ShortsLockupView>

Defined in

src/parser/youtube/Playlist.ts:69

---

memo

get memo(): Memo

Returns

Memo

Inherited from

Feed.memo

Defined in

src/core/mixins/Feed.ts:137

---

page

get page(): T

Get the original page data

Returns

T

Inherited from

Feed.page

Defined in

src/core/mixins/Feed.ts:188

---

page_contents

get page_contents(): ReloadContinuationItemsCommand | SectionList | MusicQueue | RichGrid

Returns contents from the page.

Returns

ReloadContinuationItemsCommand | SectionList | MusicQueue | RichGrid

Inherited from

Feed.page_contents

Defined in

src/core/mixins/Feed.ts:144

---

playlists

get playlists(): ObservedArray<GridPlaylist | LockupView | Playlist>

Get all playlists in the feed

Returns

ObservedArray<GridPlaylist | LockupView | Playlist>

Inherited from

Feed.playlists

Defined in

src/core/mixins/Feed.ts:133

---

posts

get posts(): ObservedArray<BackstagePost | Post | SharedPost>

Get all the community posts in the feed

Returns

ObservedArray<BackstagePost | Post | SharedPost>

Inherited from

Feed.posts

Defined in

src/core/mixins/Feed.ts:119

---

secondary_contents

get secondary_contents(): null | SectionList | BrowseFeedActions | ProfileColumn | SecondarySearchContainer

Returns secondary contents from the page.

Returns

null | SectionList | BrowseFeedActions | ProfileColumn | SecondarySearchContainer

Inherited from

Feed.secondary_contents

Defined in

src/core/mixins/Feed.ts:169

---

shelves

get shelves(): ObservedArray<ReelShelf | RichShelf | Shelf>

Returns all segments/sections from the page.

Returns

ObservedArray<ReelShelf | RichShelf | Shelf>

Inherited from

Feed.shelves

Defined in

src/core/mixins/Feed.ts:155

---

videos

get videos(): ObservedArray<CompactVideo | GridVideo | PlaylistPanelVideo | PlaylistVideo | ReelItem | ShortsLockupView | Video | WatchCardCompactVideo>

Get all the videos in the feed

Returns

ObservedArray<CompactVideo | GridVideo | PlaylistPanelVideo | PlaylistVideo | ReelItem | ShortsLockupView | Video | WatchCardCompactVideo>

Inherited from

Feed.videos

Defined in

src/core/mixins/Feed.ts:112

Methods

getContinuation()

getContinuation(): Promise<Playlist>

Retrieves next batch of contents and returns a new Feed object.

Returns

Promise<Playlist>

Overrides

Feed.getContinuation

Defined in

src/parser/youtube/Playlist.ts:101

---

getContinuationData()

getContinuationData(): Promise<undefined | IBrowseResponse>

Retrieves continuation data as it is.

Returns

Promise<undefined | IBrowseResponse>

Overrides

Feed.getContinuationData

Defined in

src/parser/youtube/Playlist.ts:82

---

getShelf()

getShelf(title): undefined | ReelShelf | RichShelf | Shelf

Finds shelf by title.

Parameters

• title: string

Returns

undefined | ReelShelf | RichShelf | Shelf

Inherited from

Feed.getShelf

Defined in

src/core/mixins/Feed.ts:162

---

getPlaylistsFromMemo()

static getPlaylistsFromMemo(memo): ObservedArray<GridPlaylist | LockupView | Playlist>

Get all playlists on a given page via memo

Parameters

• memo: Memo

Returns

ObservedArray<GridPlaylist | LockupView | Playlist>

Inherited from

Feed.getPlaylistsFromMemo

Defined in

src/core/mixins/Feed.ts:94

---

getVideosFromMemo()

static getVideosFromMemo(memo): ObservedArray<CompactVideo | GridVideo | PlaylistPanelVideo | PlaylistVideo | ReelItem | ShortsLockupView | Video | WatchCardCompactVideo>

Get all videos on a given page via memo

Parameters

• memo: Memo

Returns

ObservedArray<CompactVideo | GridVideo | PlaylistPanelVideo | PlaylistVideo | ReelItem | ShortsLockupView | Video | WatchCardCompactVideo>

Inherited from

Feed.getVideosFromMemo

Defined in

src/core/mixins/Feed.ts:78