mirror of
https://github.com/LuanRT/YouTube.js.git
synced 2026-06-17 19:42:14 +00:00
74659fd03f
* chore: generate API ref using `typedoc` * chore: declutter readme and add links to ytjs.dev * chore: clean up
272 lines
5.2 KiB
Markdown
272 lines
5.2 KiB
Markdown
[youtubei.js](../README.md) / Player
|
|
|
|
# Class: Player
|
|
|
|
Represents YouTube's player script. This is required to decipher signatures.
|
|
|
|
## Constructors
|
|
|
|
### new Player()
|
|
|
|
> **new Player**(`player_id`, `signature_timestamp`, `sig_sc`?, `nsig_sc`?): [`Player`](Player.md)
|
|
|
|
#### Parameters
|
|
|
|
• **player\_id**: `string`
|
|
|
|
• **signature\_timestamp**: `number`
|
|
|
|
• **sig\_sc?**: `string`
|
|
|
|
• **nsig\_sc?**: `string`
|
|
|
|
#### Returns
|
|
|
|
[`Player`](Player.md)
|
|
|
|
#### Defined in
|
|
|
|
[src/core/Player.ts:17](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/Player.ts#L17)
|
|
|
|
## Properties
|
|
|
|
### nsig\_sc?
|
|
|
|
> `optional` **nsig\_sc**: `string`
|
|
|
|
#### Defined in
|
|
|
|
[src/core/Player.ts:13](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/Player.ts#L13)
|
|
|
|
***
|
|
|
|
### player\_id
|
|
|
|
> **player\_id**: `string`
|
|
|
|
#### Defined in
|
|
|
|
[src/core/Player.ts:11](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/Player.ts#L11)
|
|
|
|
***
|
|
|
|
### po\_token?
|
|
|
|
> `optional` **po\_token**: `string`
|
|
|
|
#### Defined in
|
|
|
|
[src/core/Player.ts:15](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/Player.ts#L15)
|
|
|
|
***
|
|
|
|
### sig\_sc?
|
|
|
|
> `optional` **sig\_sc**: `string`
|
|
|
|
#### Defined in
|
|
|
|
[src/core/Player.ts:14](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/Player.ts#L14)
|
|
|
|
***
|
|
|
|
### sts
|
|
|
|
> **sts**: `number`
|
|
|
|
#### Defined in
|
|
|
|
[src/core/Player.ts:12](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/Player.ts#L12)
|
|
|
|
## Accessors
|
|
|
|
### url
|
|
|
|
> `get` **url**(): `string`
|
|
|
|
#### Returns
|
|
|
|
`string`
|
|
|
|
#### Defined in
|
|
|
|
[src/core/Player.ts:244](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/Player.ts#L244)
|
|
|
|
***
|
|
|
|
### LIBRARY\_VERSION
|
|
|
|
> `get` `static` **LIBRARY\_VERSION**(): `number`
|
|
|
|
#### Returns
|
|
|
|
`number`
|
|
|
|
#### Defined in
|
|
|
|
[src/core/Player.ts:248](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/Player.ts#L248)
|
|
|
|
## Methods
|
|
|
|
### cache()
|
|
|
|
> **cache**(`cache`?): `Promise`\<`void`\>
|
|
|
|
#### Parameters
|
|
|
|
• **cache?**: [`ICache`](../namespaces/Types/interfaces/ICache.md)
|
|
|
|
#### Returns
|
|
|
|
`Promise`\<`void`\>
|
|
|
|
#### Defined in
|
|
|
|
[src/core/Player.ts:200](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/Player.ts#L200)
|
|
|
|
***
|
|
|
|
### decipher()
|
|
|
|
> **decipher**(`url`?, `signature_cipher`?, `cipher`?, `this_response_nsig_cache`?): `string`
|
|
|
|
#### Parameters
|
|
|
|
• **url?**: `string`
|
|
|
|
• **signature\_cipher?**: `string`
|
|
|
|
• **cipher?**: `string`
|
|
|
|
• **this\_response\_nsig\_cache?**: `Map`\<`string`, `string`\>
|
|
|
|
#### Returns
|
|
|
|
`string`
|
|
|
|
#### Defined in
|
|
|
|
[src/core/Player.ts:78](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/Player.ts#L78)
|
|
|
|
***
|
|
|
|
### create()
|
|
|
|
> `static` **create**(`cache`, `fetch`, `po_token`?): `Promise`\<[`Player`](Player.md)\>
|
|
|
|
#### Parameters
|
|
|
|
• **cache**: `undefined` \| [`ICache`](../namespaces/Types/interfaces/ICache.md)
|
|
|
|
• **fetch** = `Platform.shim.fetch`
|
|
|
|
• **po\_token?**: `string`
|
|
|
|
#### Returns
|
|
|
|
`Promise`\<[`Player`](Player.md)\>
|
|
|
|
#### Defined in
|
|
|
|
[src/core/Player.ts:24](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/Player.ts#L24)
|
|
|
|
***
|
|
|
|
### extractNSigSourceCode()
|
|
|
|
> `static` **extractNSigSourceCode**(`data`): `undefined` \| `string`
|
|
|
|
#### Parameters
|
|
|
|
• **data**: `string`
|
|
|
|
#### Returns
|
|
|
|
`undefined` \| `string`
|
|
|
|
#### Defined in
|
|
|
|
[src/core/Player.ts:237](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/Player.ts#L237)
|
|
|
|
***
|
|
|
|
### extractSigSourceCode()
|
|
|
|
> `static` **extractSigSourceCode**(`data`): `string`
|
|
|
|
#### Parameters
|
|
|
|
• **data**: `string`
|
|
|
|
#### Returns
|
|
|
|
`string`
|
|
|
|
#### Defined in
|
|
|
|
[src/core/Player.ts:226](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/Player.ts#L226)
|
|
|
|
***
|
|
|
|
### extractSigTimestamp()
|
|
|
|
> `static` **extractSigTimestamp**(`data`): `number`
|
|
|
|
#### Parameters
|
|
|
|
• **data**: `string`
|
|
|
|
#### Returns
|
|
|
|
`number`
|
|
|
|
#### Defined in
|
|
|
|
[src/core/Player.ts:222](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/Player.ts#L222)
|
|
|
|
***
|
|
|
|
### fromCache()
|
|
|
|
> `static` **fromCache**(`cache`, `player_id`): `Promise`\<`null` \| [`Player`](Player.md)\>
|
|
|
|
#### Parameters
|
|
|
|
• **cache**: [`ICache`](../namespaces/Types/interfaces/ICache.md)
|
|
|
|
• **player\_id**: `string`
|
|
|
|
#### Returns
|
|
|
|
`Promise`\<`null` \| [`Player`](Player.md)\>
|
|
|
|
#### Defined in
|
|
|
|
[src/core/Player.ts:170](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/Player.ts#L170)
|
|
|
|
***
|
|
|
|
### fromSource()
|
|
|
|
> `static` **fromSource**(`player_id`, `sig_timestamp`, `cache`?, `sig_sc`?, `nsig_sc`?): `Promise`\<[`Player`](Player.md)\>
|
|
|
|
#### Parameters
|
|
|
|
• **player\_id**: `string`
|
|
|
|
• **sig\_timestamp**: `number`
|
|
|
|
• **cache?**: [`ICache`](../namespaces/Types/interfaces/ICache.md)
|
|
|
|
• **sig\_sc?**: `string`
|
|
|
|
• **nsig\_sc?**: `string`
|
|
|
|
#### Returns
|
|
|
|
`Promise`\<[`Player`](Player.md)\>
|
|
|
|
#### Defined in
|
|
|
|
[src/core/Player.ts:194](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/core/Player.ts#L194)
|