jirayu_sri/YouTube.js
1
0
Fork 0
mirror of https://github.com/LuanRT/YouTube.js.git synced 2026-06-16 11:02:10 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f87b5af98cc41cf5381ae17ecc9dd0fcaaf83dee
YouTube.js/docs/api/namespaces/YTNodes/classes/VideoCard.md
Luan f87b5af98c chore: gen docs [skip ci]
2025-06-08 13:48:03 -03:00

750 lines
16 KiB
Markdown
Raw Blame History

[youtubei.js](../../../README.md) / [YTNodes](../README.md) / VideoCard
# Class: VideoCard
## Extends
- [`Video`](Video.md)
## Constructors
### new VideoCard()
> **new VideoCard**(`data`): [`VideoCard`](VideoCard.md)
#### Parameters
• **data**: [`RawNode`](../../APIResponseTypes/type-aliases/RawNode.md)
#### Returns
[`VideoCard`](VideoCard.md)
#### Overrides
[`Video`](Video.md).[`constructor`](Video.md#constructors)
#### Defined in
[src/parser/classes/VideoCard.ts:12](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/VideoCard.ts#L12)
## Properties
### additional\_metadatas?
> `optional` **additional\_metadatas**: [`Text`](../../Misc/classes/Text.md)[]
#### Inherited from
[`Video`](Video.md).[`additional_metadatas`](Video.md#additional_metadatas)
#### Defined in
[src/parser/classes/Video.ts:22](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L22)
***
### author
> **author**: [`Author`](../../Misc/classes/Author.md)
#### Inherited from
[`Video`](Video.md).[`author`](Video.md#author)
#### Defined in
[src/parser/classes/Video.ts:26](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L26)
***
### badges
> **badges**: [`MetadataBadge`](MetadataBadge.md)[]
#### Inherited from
[`Video`](Video.md).[`badges`](Video.md#badges)
#### Defined in
[src/parser/classes/Video.ts:27](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L27)
***
### byline\_text?
> `optional` **byline\_text**: [`Text`](../../Misc/classes/Text.md)
#### Overrides
[`Video`](Video.md).[`byline_text`](Video.md#byline_text)
#### Defined in
[src/parser/classes/VideoCard.ts:10](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/VideoCard.ts#L10)
***
### description\_snippet?
> `optional` **description\_snippet**: [`Text`](../../Misc/classes/Text.md)
#### Inherited from
[`Video`](Video.md).[`description_snippet`](Video.md#description_snippet)
#### Defined in
[src/parser/classes/Video.ts:19](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L19)
***
### endpoint?
> `optional` **endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md)
#### Inherited from
[`Video`](Video.md).[`endpoint`](Video.md#endpoint)
#### Defined in
[src/parser/classes/Video.ts:28](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L28)
***
### expandable\_metadata
> **expandable\_metadata**: `null` \| [`ExpandableMetadata`](ExpandableMetadata.md)
#### Inherited from
[`Video`](Video.md).[`expandable_metadata`](Video.md#expandable_metadata)
#### Defined in
[src/parser/classes/Video.ts:21](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L21)
***
### is\_watched
> **is\_watched**: `boolean`
#### Inherited from
[`Video`](Video.md).[`is_watched`](Video.md#is_watched)
#### Defined in
[src/parser/classes/Video.ts:35](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L35)
***
### length\_text?
> `optional` **length\_text**: [`Text`](../../Misc/classes/Text.md)
#### Inherited from
[`Video`](Video.md).[`length_text`](Video.md#length_text)
#### Defined in
[src/parser/classes/Video.ts:33](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L33)
***
### menu
> **menu**: `null` \| [`Menu`](Menu.md)
#### Inherited from
[`Video`](Video.md).[`menu`](Video.md#menu)
#### Defined in
[src/parser/classes/Video.ts:36](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L36)
***
### metadata\_text?
> `optional` **metadata\_text**: [`Text`](../../Misc/classes/Text.md)
#### Defined in
[src/parser/classes/VideoCard.ts:9](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/VideoCard.ts#L9)
***
### published?
> `optional` **published**: [`Text`](../../Misc/classes/Text.md)
#### Inherited from
[`Video`](Video.md).[`published`](Video.md#published)
#### Defined in
[src/parser/classes/Video.ts:29](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L29)
***
### rich\_thumbnail?
> `optional` **rich\_thumbnail**: [`YTNode`](../../Helpers/classes/YTNode.md)
#### Inherited from
[`Video`](Video.md).[`rich_thumbnail`](Video.md#rich_thumbnail)
#### Defined in
[src/parser/classes/Video.ts:25](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L25)
***
### search\_video\_result\_entity\_key?
> `optional` **search\_video\_result\_entity\_key**: `string`
#### Inherited from
[`Video`](Video.md).[`search_video_result_entity_key`](Video.md#search_video_result_entity_key)
#### Defined in
[src/parser/classes/Video.ts:38](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L38)
***
### service\_endpoint?
> `optional` **service\_endpoint**: [`NavigationEndpoint`](NavigationEndpoint.md)
#### Inherited from
[`Video`](Video.md).[`service_endpoint`](Video.md#service_endpoint)
#### Defined in
[src/parser/classes/Video.ts:40](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L40)
***
### service\_endpoints?
> `optional` **service\_endpoints**: [`NavigationEndpoint`](NavigationEndpoint.md)[]
#### Inherited from
[`Video`](Video.md).[`service_endpoints`](Video.md#service_endpoints)
#### Defined in
[src/parser/classes/Video.ts:39](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L39)
***
### short\_view\_count?
> `optional` **short\_view\_count**: [`Text`](../../Misc/classes/Text.md)
#### Inherited from
[`Video`](Video.md).[`short_view_count`](Video.md#short_view_count)
#### Defined in
[src/parser/classes/Video.ts:31](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L31)
***
### show\_action\_menu
> **show\_action\_menu**: `boolean`
#### Inherited from
[`Video`](Video.md).[`show_action_menu`](Video.md#show_action_menu)
#### Defined in
[src/parser/classes/Video.ts:34](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L34)
***
### snippets?
> `optional` **snippets**: `object`[]
#### Inherited from
[`Video`](Video.md).[`snippets`](Video.md#snippets)
#### Defined in
[src/parser/classes/Video.ts:20](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L20)
***
### style?
> `optional` **style**: `"VIDEO_STYLE_TYPE_UNKNOWN"` \| `"VIDEO_STYLE_TYPE_NORMAL"` \| `"VIDEO_STYLE_TYPE_POST"` \| `"VIDEO_STYLE_TYPE_SUB"` \| `"VIDEO_STYLE_TYPE_LIVE_POST"` \| `"VIDEO_STYLE_TYPE_FULL_BLEED_ISOLATED"` \| `"VIDEO_STYLE_TYPE_WITH_EXPANDED_METADATA"`
#### Inherited from
[`Video`](Video.md).[`style`](Video.md#style)
#### Defined in
[src/parser/classes/Video.ts:41](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L41)
***
### thumbnail\_overlays
> **thumbnail\_overlays**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\>
#### Inherited from
[`Video`](Video.md).[`thumbnail_overlays`](Video.md#thumbnail_overlays)
#### Defined in
[src/parser/classes/Video.ts:24](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L24)
***
### thumbnails
> **thumbnails**: [`Thumbnail`](../../Misc/classes/Thumbnail.md)[]
#### Inherited from
[`Video`](Video.md).[`thumbnails`](Video.md#thumbnails)
#### Defined in
[src/parser/classes/Video.ts:23](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L23)
***
### title
> **title**: [`Text`](../../Misc/classes/Text.md)
#### Inherited from
[`Video`](Video.md).[`title`](Video.md#title)
#### Defined in
[src/parser/classes/Video.ts:17](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L17)
***
### type
> `readonly` **type**: `string`
#### Inherited from
[`Video`](Video.md).[`type`](Video.md#type)
#### Defined in
[src/parser/helpers.ts:8](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L8)
***
### untranslated\_title?
> `optional` **untranslated\_title**: [`Text`](../../Misc/classes/Text.md)
#### Inherited from
[`Video`](Video.md).[`untranslated_title`](Video.md#untranslated_title)
#### Defined in
[src/parser/classes/Video.ts:18](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L18)
***
### upcoming?
> `optional` **upcoming**: `Date`
#### Inherited from
[`Video`](Video.md).[`upcoming`](Video.md#upcoming)
#### Defined in
[src/parser/classes/Video.ts:32](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L32)
***
### video\_id
> **video\_id**: `string`
#### Inherited from
[`Video`](Video.md).[`video_id`](Video.md#video_id)
#### Defined in
[src/parser/classes/Video.ts:16](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L16)
***
### view\_count?
> `optional` **view\_count**: [`Text`](../../Misc/classes/Text.md)
#### Inherited from
[`Video`](Video.md).[`view_count`](Video.md#view_count)
#### Defined in
[src/parser/classes/Video.ts:30](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L30)
***
### type
> `static` **type**: `string` = `'VideoCard'`
#### Overrides
[`Video`](Video.md).[`type`](Video.md#type-1)
#### Defined in
[src/parser/classes/VideoCard.ts:7](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/VideoCard.ts#L7)
## Accessors
### best\_thumbnail
> `get` **best\_thumbnail**(): `undefined` \| [`Thumbnail`](../../Misc/classes/Thumbnail.md)
#### Returns
`undefined` \| [`Thumbnail`](../../Misc/classes/Thumbnail.md)
#### Inherited from
[`Video`](Video.md).[`best_thumbnail`](Video.md#best_thumbnail)
#### Defined in
[src/parser/classes/Video.ts:148](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L148)
***
### description
> `get` **description**(): `string`
#### Returns
`string`
#### Inherited from
[`Video`](Video.md).[`description`](Video.md#description)
#### Defined in
[src/parser/classes/Video.ts:119](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L119)
***
### duration
> `get` **duration**(): `object`
#### Returns
`object`
##### seconds
> **seconds**: `number`
##### text
> **text**: `undefined` \| `string` = `length_text`
#### Inherited from
[`Video`](Video.md).[`duration`](Video.md#duration)
#### Defined in
[src/parser/classes/Video.ts:152](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L152)
***
### has\_captions
> `get` **has\_captions**(): `boolean`
#### Returns
`boolean`
#### Inherited from
[`Video`](Video.md).[`has_captions`](Video.md#has_captions)
#### Defined in
[src/parser/classes/Video.ts:144](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L144)
***
### id
> `get` **id**(): `string`
#### Deprecated
Use [`video_id`](Video.md#video_id) instead.
#### Returns
`string`
#### Inherited from
[`Video`](Video.md).[`id`](Video.md#id)
#### Defined in
[src/parser/classes/Video.ts:115](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L115)
***
### is\_4k
> `get` **is\_4k**(): `boolean`
#### Returns
`boolean`
#### Inherited from
[`Video`](Video.md).[`is_4k`](Video.md#is_4k)
#### Defined in
[src/parser/classes/Video.ts:140](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L140)
***
### is\_live
> `get` **is\_live**(): `boolean`
#### Returns
`boolean`
#### Inherited from
[`Video`](Video.md).[`is_live`](Video.md#is_live)
#### Defined in
[src/parser/classes/Video.ts:125](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L125)
***
### is\_premiere
> `get` **is\_premiere**(): `boolean`
#### Returns
`boolean`
#### Inherited from
[`Video`](Video.md).[`is_premiere`](Video.md#is_premiere)
#### Defined in
[src/parser/classes/Video.ts:136](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L136)
***
### is\_upcoming
> `get` **is\_upcoming**(): `undefined` \| `boolean`
#### Returns
`undefined` \| `boolean`
#### Inherited from
[`Video`](Video.md).[`is_upcoming`](Video.md#is_upcoming)
#### Defined in
[src/parser/classes/Video.ts:132](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/classes/Video.ts#L132)
## Methods
### as()
> **as**\<`T`, `K`\>(...`types`): `InstanceType`\<`K`\[`number`\]\>
Cast to one of the given types.
#### Type Parameters
• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md)
• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[]
#### Parameters
• ...**types**: `K`
The types to cast to
#### Returns
`InstanceType`\<`K`\[`number`\]\>
The node cast to one of the given types
#### Throws
If the node is not of the given type
#### Inherited from
[`Video`](Video.md).[`as`](Video.md#as)
#### Defined in
[src/parser/helpers.ts:29](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L29)
***
### hasKey()
> **hasKey**\<`T`, `R`\>(`key`): `this is VideoCard & { [k in string]: R }`
Check for a key without asserting the type.
#### Type Parameters
• **T** *extends* `string`
• **R** = `any`
#### Parameters
• **key**: `T`
The key to check
#### Returns
`this is VideoCard & { [k in string]: R }`
Whether the node has the key
#### Inherited from
[`Video`](Video.md).[`hasKey`](Video.md#haskey)
#### Defined in
[src/parser/helpers.ts:41](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L41)
***
### is()
> **is**\<`T`, `K`\>(...`types`): `this is InstanceType<K[number]>`
Check if the node is of the given type.
#### Type Parameters
• **T** *extends* [`YTNode`](../../Helpers/classes/YTNode.md)
• **K** *extends* [`YTNodeConstructor`](../../Helpers/interfaces/YTNodeConstructor.md)\<`T`\>[]
#### Parameters
• ...**types**: `K`
The type to check
#### Returns
`this is InstanceType<K[number]>`
whether the node is of the given type
#### Inherited from
[`Video`](Video.md).[`is`](Video.md#is)
#### Defined in
[src/parser/helpers.ts:19](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L19)
***
### key()
> **key**\<`T`, `R`\>(`key`): [`Maybe`](../../Helpers/classes/Maybe.md)
Assert that the node has the given key and return it.
#### Type Parameters
• **T** *extends* `string`
• **R** = `any`
#### Parameters
• **key**: `T`
The key to check
#### Returns
[`Maybe`](../../Helpers/classes/Maybe.md)
The value of the key wrapped in a Maybe
#### Throws
If the node does not have the key
#### Inherited from
[`Video`](Video.md).[`key`](Video.md#key)
#### Defined in
[src/parser/helpers.ts:51](https://github.com/LuanRT/YouTube.js/blob/e1650e12979e68b9546bc63989f86b651960a10a/src/parser/helpers.ts#L51)
Reference in New Issue View Git Blame Copy Permalink