chore: update docs

This commit is contained in:
Luan
2025-07-22 16:39:38 -03:00
parent 5b84100979
commit 67ae82be3b
139 changed files with 859 additions and 819 deletions

View File

@@ -2,7 +2,7 @@
# Class: CacheManager
Defined in: [src/utils/CacheManager.ts:14](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/CacheManager.ts#L14)
Defined in: [src/utils/CacheManager.ts:14](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/CacheManager.ts#L14)
A "proper" cache for storing segments.
@@ -12,7 +12,7 @@ A "proper" cache for storing segments.
> **new CacheManager**(`maxSizeMB`, `maxAgeSeconds`): `CacheManager`
Defined in: [src/utils/CacheManager.ts:23](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/CacheManager.ts#L23)
Defined in: [src/utils/CacheManager.ts:23](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/CacheManager.ts#L23)
#### Parameters
@@ -34,7 +34,7 @@ Defined in: [src/utils/CacheManager.ts:23](https://github.com/LuanRT/googlevideo
> **dispose**(): `void`
Defined in: [src/utils/CacheManager.ts:156](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/CacheManager.ts#L156)
Defined in: [src/utils/CacheManager.ts:159](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/CacheManager.ts#L159)
#### Returns
@@ -46,7 +46,7 @@ Defined in: [src/utils/CacheManager.ts:156](https://github.com/LuanRT/googlevide
> **getCacheEntries**(): `object`
Defined in: [src/utils/CacheManager.ts:29](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/CacheManager.ts#L29)
Defined in: [src/utils/CacheManager.ts:29](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/CacheManager.ts#L29)
#### Returns
@@ -66,7 +66,7 @@ Defined in: [src/utils/CacheManager.ts:29](https://github.com/LuanRT/googlevideo
> **getInitSegment**(`key`): `undefined` \| `Uint8Array`
Defined in: [src/utils/CacheManager.ts:63](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/CacheManager.ts#L63)
Defined in: [src/utils/CacheManager.ts:66](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/CacheManager.ts#L66)
#### Parameters
@@ -84,7 +84,7 @@ Defined in: [src/utils/CacheManager.ts:63](https://github.com/LuanRT/googlevideo
> **getSegment**(`key`): `undefined` \| `Uint8Array`
Defined in: [src/utils/CacheManager.ts:81](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/CacheManager.ts#L81)
Defined in: [src/utils/CacheManager.ts:84](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/CacheManager.ts#L84)
#### Parameters
@@ -102,7 +102,7 @@ Defined in: [src/utils/CacheManager.ts:81](https://github.com/LuanRT/googlevideo
> **setInitSegment**(`key`, `data`): `void`
Defined in: [src/utils/CacheManager.ts:36](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/CacheManager.ts#L36)
Defined in: [src/utils/CacheManager.ts:39](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/CacheManager.ts#L39)
#### Parameters
@@ -124,7 +124,7 @@ Defined in: [src/utils/CacheManager.ts:36](https://github.com/LuanRT/googlevideo
> **setSegment**(`key`, `data`): `void`
Defined in: [src/utils/CacheManager.ts:51](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/CacheManager.ts#L51)
Defined in: [src/utils/CacheManager.ts:54](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/CacheManager.ts#L54)
#### Parameters

View File

@@ -2,7 +2,7 @@
# Class: EventEmitterLike
Defined in: [src/utils/EventEmitterLike.ts:22](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/EventEmitterLike.ts#L22)
Defined in: [src/utils/EventEmitterLike.ts:22](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/EventEmitterLike.ts#L22)
## Extends
@@ -18,7 +18,7 @@ Defined in: [src/utils/EventEmitterLike.ts:22](https://github.com/LuanRT/googlev
> **new EventEmitterLike**(): `EventEmitterLike`
Defined in: [src/utils/EventEmitterLike.ts:25](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/EventEmitterLike.ts#L25)
Defined in: [src/utils/EventEmitterLike.ts:25](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/EventEmitterLike.ts#L25)
#### Returns
@@ -106,7 +106,7 @@ Dispatches a synthetic event event to target and returns true if either event's
> **emit**(`type`, ...`args`): `void`
Defined in: [src/utils/EventEmitterLike.ts:29](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/EventEmitterLike.ts#L29)
Defined in: [src/utils/EventEmitterLike.ts:29](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/EventEmitterLike.ts#L29)
#### Parameters
@@ -128,7 +128,7 @@ Defined in: [src/utils/EventEmitterLike.ts:29](https://github.com/LuanRT/googlev
> **off**(`type`, `listener`): `void`
Defined in: [src/utils/EventEmitterLike.ts:59](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/EventEmitterLike.ts#L59)
Defined in: [src/utils/EventEmitterLike.ts:59](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/EventEmitterLike.ts#L59)
#### Parameters
@@ -150,7 +150,7 @@ Defined in: [src/utils/EventEmitterLike.ts:59](https://github.com/LuanRT/googlev
> **on**(`type`, `listener`): `void`
Defined in: [src/utils/EventEmitterLike.ts:34](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/EventEmitterLike.ts#L34)
Defined in: [src/utils/EventEmitterLike.ts:34](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/EventEmitterLike.ts#L34)
#### Parameters
@@ -172,7 +172,7 @@ Defined in: [src/utils/EventEmitterLike.ts:34](https://github.com/LuanRT/googlev
> **once**(`type`, `listener`): `void`
Defined in: [src/utils/EventEmitterLike.ts:46](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/EventEmitterLike.ts#L46)
Defined in: [src/utils/EventEmitterLike.ts:46](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/EventEmitterLike.ts#L46)
#### Parameters
@@ -194,7 +194,7 @@ Defined in: [src/utils/EventEmitterLike.ts:46](https://github.com/LuanRT/googlev
> **removeAllListeners**(`type?`): `void`
Defined in: [src/utils/EventEmitterLike.ts:67](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/EventEmitterLike.ts#L67)
Defined in: [src/utils/EventEmitterLike.ts:67](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/EventEmitterLike.ts#L67)
#### Parameters

View File

@@ -2,7 +2,19 @@
# Class: Logger
Defined in: [src/utils/Logger.ts:10](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/Logger.ts#L10)
Defined in: [src/utils/Logger.ts:23](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/Logger.ts#L23)
Singleton logger utility.
Allows enabling or disabling specific log levels (`ERROR`, `WARN`, `INFO`, `DEBUG`)
at runtime. Supports logging with tags and message arguments.
Usage:
```ts
const logger = Logger.getInstance();
logger.setLogLevels(LogLevel.ERROR, LogLevel.INFO);
logger.error('MyTag', 'An error occurred');
```
## Constructors
@@ -20,7 +32,7 @@ Defined in: [src/utils/Logger.ts:10](https://github.com/LuanRT/googlevideo/blob/
> **debug**(`tag`, ...`messages`): `void`
Defined in: [src/utils/Logger.ts:82](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/Logger.ts#L82)
Defined in: [src/utils/Logger.ts:95](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/Logger.ts#L95)
#### Parameters
@@ -42,7 +54,7 @@ Defined in: [src/utils/Logger.ts:82](https://github.com/LuanRT/googlevideo/blob/
> **error**(`tag`, ...`messages`): `void`
Defined in: [src/utils/Logger.ts:70](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/Logger.ts#L70)
Defined in: [src/utils/Logger.ts:83](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/Logger.ts#L83)
#### Parameters
@@ -64,7 +76,7 @@ Defined in: [src/utils/Logger.ts:70](https://github.com/LuanRT/googlevideo/blob/
> **getLogLevels**(): `Set`\<[`LogLevel`](../enumerations/LogLevel.md)\>
Defined in: [src/utils/Logger.ts:46](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/Logger.ts#L46)
Defined in: [src/utils/Logger.ts:59](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/Logger.ts#L59)
Gets the current set of active log levels.
@@ -80,7 +92,7 @@ A new Set containing the active LogLevel enums.
> **info**(`tag`, ...`messages`): `void`
Defined in: [src/utils/Logger.ts:78](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/Logger.ts#L78)
Defined in: [src/utils/Logger.ts:91](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/Logger.ts#L91)
#### Parameters
@@ -102,7 +114,7 @@ Defined in: [src/utils/Logger.ts:78](https://github.com/LuanRT/googlevideo/blob/
> **setLogLevels**(...`levels`): `void`
Defined in: [src/utils/Logger.ts:27](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/Logger.ts#L27)
Defined in: [src/utils/Logger.ts:40](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/Logger.ts#L40)
Sets the active log levels.
Call with LogLevel.NONE or no arguments to turn off all logging.
@@ -125,7 +137,7 @@ Use LogLevel.ALL to enable all log levels.
> **warn**(`tag`, ...`messages`): `void`
Defined in: [src/utils/Logger.ts:74](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/Logger.ts#L74)
Defined in: [src/utils/Logger.ts:87](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/Logger.ts#L87)
#### Parameters
@@ -147,7 +159,7 @@ Defined in: [src/utils/Logger.ts:74](https://github.com/LuanRT/googlevideo/blob/
> `static` **getInstance**(): `Logger`
Defined in: [src/utils/Logger.ts:14](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/Logger.ts#L14)
Defined in: [src/utils/Logger.ts:27](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/Logger.ts#L27)
#### Returns

View File

@@ -2,7 +2,7 @@
# Class: RequestMetadataManager
Defined in: [src/utils/RequestMetadataManager.ts:6](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/RequestMetadataManager.ts#L6)
Defined in: [src/utils/RequestMetadataManager.ts:6](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/RequestMetadataManager.ts#L6)
Manages request metadata objects.
@@ -12,7 +12,7 @@ Manages request metadata objects.
> **new RequestMetadataManager**(): `RequestMetadataManager`
Defined in: [src/utils/RequestMetadataManager.ts:12](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/RequestMetadataManager.ts#L12)
Defined in: [src/utils/RequestMetadataManager.ts:12](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/RequestMetadataManager.ts#L12)
#### Returns
@@ -24,7 +24,7 @@ Defined in: [src/utils/RequestMetadataManager.ts:12](https://github.com/LuanRT/g
> **metadataMap**: `Map`\<`string`, [`SabrRequestMetadata`](../../sabr-streaming-adapter/interfaces/SabrRequestMetadata.md)\>
Defined in: [src/utils/RequestMetadataManager.ts:7](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/RequestMetadataManager.ts#L7)
Defined in: [src/utils/RequestMetadataManager.ts:7](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/RequestMetadataManager.ts#L7)
## Methods
@@ -32,7 +32,7 @@ Defined in: [src/utils/RequestMetadataManager.ts:7](https://github.com/LuanRT/go
> **getRequestMetadata**(`url`, `del`): `undefined` \| [`SabrRequestMetadata`](../../sabr-streaming-adapter/interfaces/SabrRequestMetadata.md)
Defined in: [src/utils/RequestMetadataManager.ts:17](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/RequestMetadataManager.ts#L17)
Defined in: [src/utils/RequestMetadataManager.ts:17](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/RequestMetadataManager.ts#L17)
#### Parameters
@@ -54,7 +54,7 @@ Defined in: [src/utils/RequestMetadataManager.ts:17](https://github.com/LuanRT/g
> **setRequestMetadata**(`url`, `context`): `void`
Defined in: [src/utils/RequestMetadataManager.ts:37](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/RequestMetadataManager.ts#L37)
Defined in: [src/utils/RequestMetadataManager.ts:37](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/RequestMetadataManager.ts#L37)
#### Parameters

View File

@@ -2,7 +2,7 @@
# Class: SabrAdapterError
Defined in: [src/utils/EventEmitterLike.ts:15](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/EventEmitterLike.ts#L15)
Defined in: [src/utils/EventEmitterLike.ts:15](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/EventEmitterLike.ts#L15)
## Extends
@@ -14,7 +14,7 @@ Defined in: [src/utils/EventEmitterLike.ts:15](https://github.com/LuanRT/googlev
> **new SabrAdapterError**(`message`, `code?`): `SabrAdapterError`
Defined in: [src/utils/EventEmitterLike.ts:16](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/EventEmitterLike.ts#L16)
Defined in: [src/utils/EventEmitterLike.ts:16](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/EventEmitterLike.ts#L16)
#### Parameters
@@ -40,7 +40,7 @@ Defined in: [src/utils/EventEmitterLike.ts:16](https://github.com/LuanRT/googlev
> `optional` **code**: `string`
Defined in: [src/utils/EventEmitterLike.ts:16](https://github.com/LuanRT/googlevideo/blob/cc730b4dbadc5ae882d6aa28d716e442943577fa/src/utils/EventEmitterLike.ts#L16)
Defined in: [src/utils/EventEmitterLike.ts:16](https://github.com/LuanRT/googlevideo/blob/5b84100979befab767d819a9606dde964d469341/src/utils/EventEmitterLike.ts#L16)
***