Files
YouTube.js/docs/api/classes/Player.md
Luan 74659fd03f chore: add proper documentation (#763)
* chore: generate API ref using `typedoc`

* chore: declutter readme and add links to ytjs.dev

* chore: clean up
2024-09-23 17:32:50 -03:00

5.2 KiB

youtubei.js / 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

Parameters

player_id: string

signature_timestamp: number

sig_sc?: string

nsig_sc?: string

Returns

Player

Defined in

src/core/Player.ts:17

Properties

nsig_sc?

optional nsig_sc: string

Defined in

src/core/Player.ts:13


player_id

player_id: string

Defined in

src/core/Player.ts:11


po_token?

optional po_token: string

Defined in

src/core/Player.ts:15


sig_sc?

optional sig_sc: string

Defined in

src/core/Player.ts:14


sts

sts: number

Defined in

src/core/Player.ts:12

Accessors

url

get url(): string

Returns

string

Defined in

src/core/Player.ts:244


LIBRARY_VERSION

get static LIBRARY_VERSION(): number

Returns

number

Defined in

src/core/Player.ts:248

Methods

cache()

cache(cache?): Promise<void>

Parameters

cache?: ICache

Returns

Promise<void>

Defined in

src/core/Player.ts:200


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


create()

static create(cache, fetch, po_token?): Promise<Player>

Parameters

cache: undefined | ICache

fetch = Platform.shim.fetch

po_token?: string

Returns

Promise<Player>

Defined in

src/core/Player.ts:24


extractNSigSourceCode()

static extractNSigSourceCode(data): undefined | string

Parameters

data: string

Returns

undefined | string

Defined in

src/core/Player.ts:237


extractSigSourceCode()

static extractSigSourceCode(data): string

Parameters

data: string

Returns

string

Defined in

src/core/Player.ts:226


extractSigTimestamp()

static extractSigTimestamp(data): number

Parameters

data: string

Returns

number

Defined in

src/core/Player.ts:222


fromCache()

static fromCache(cache, player_id): Promise<null | Player>

Parameters

cache: ICache

player_id: string

Returns

Promise<null | Player>

Defined in

src/core/Player.ts:170


fromSource()

static fromSource(player_id, sig_timestamp, cache?, sig_sc?, nsig_sc?): Promise<Player>

Parameters

player_id: string

sig_timestamp: number

cache?: ICache

sig_sc?: string

nsig_sc?: string

Returns

Promise<Player>

Defined in

src/core/Player.ts:194