Skip to content

Commit 28b3359

Browse files
release: v8.0.0
1 parent d2c7d68 commit 28b3359

62 files changed

Lines changed: 605 additions & 594 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docusaurus/docs/api/Library-Exports/classes/Caption.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Class: Caption
88

9-
Defined in: [entities/caption.ts:7](https://github.com/brandonbothell/popyt/blob/534e5115ace99d29ee44af4839e9db8f769827fb/src/entities/caption.ts#L7)
9+
Defined in: [entities/caption.ts:7](https://github.com/brandonbothell/popyt/blob/d2c7d6853da78c625d9181889723f4cfa4f59197/src/entities/caption.ts#L7)
1010

1111
A caption track.
1212

@@ -16,7 +16,7 @@ A caption track.
1616

1717
> **new Caption**(`youtube`, `data`, `full?`): `Caption`
1818
19-
Defined in: [entities/caption.ts:109](https://github.com/brandonbothell/popyt/blob/534e5115ace99d29ee44af4839e9db8f769827fb/src/entities/caption.ts#L109)
19+
Defined in: [entities/caption.ts:109](https://github.com/brandonbothell/popyt/blob/d2c7d6853da78c625d9181889723f4cfa4f59197/src/entities/caption.ts#L109)
2020

2121
#### Parameters
2222

@@ -42,7 +42,7 @@ Defined in: [entities/caption.ts:109](https://github.com/brandonbothell/popyt/bl
4242

4343
> **audioType**: `"unknown"` \| `"commentary"` \| `"descriptive"` \| `"primary"`
4444
45-
Defined in: [entities/caption.ts:71](https://github.com/brandonbothell/popyt/blob/534e5115ace99d29ee44af4839e9db8f769827fb/src/entities/caption.ts#L71)
45+
Defined in: [entities/caption.ts:71](https://github.com/brandonbothell/popyt/blob/d2c7d6853da78c625d9181889723f4cfa4f59197/src/entities/caption.ts#L71)
4646

4747
Whether the audio is a commentary/descriptive (alternate audio tracks), the primary audio track, or unknown.
4848

@@ -52,7 +52,7 @@ Whether the audio is a commentary/descriptive (alternate audio tracks), the prim
5252

5353
> **autoSynced**: `boolean`
5454
55-
Defined in: [entities/caption.ts:96](https://github.com/brandonbothell/popyt/blob/534e5115ace99d29ee44af4839e9db8f769827fb/src/entities/caption.ts#L96)
55+
Defined in: [entities/caption.ts:96](https://github.com/brandonbothell/popyt/blob/d2c7d6853da78c625d9181889723f4cfa4f59197/src/entities/caption.ts#L96)
5656

5757
Whether or not this caption track has been autosynced to the audio by YouTube.
5858

@@ -62,7 +62,7 @@ Whether or not this caption track has been autosynced to the audio by YouTube.
6262

6363
> **closedCaptions**: `boolean`
6464
65-
Defined in: [entities/caption.ts:76](https://github.com/brandonbothell/popyt/blob/534e5115ace99d29ee44af4839e9db8f769827fb/src/entities/caption.ts#L76)
65+
Defined in: [entities/caption.ts:76](https://github.com/brandonbothell/popyt/blob/d2c7d6853da78c625d9181889723f4cfa4f59197/src/entities/caption.ts#L76)
6666

6767
Whether or not this caption track is for the deaf/hard of hearing.
6868

@@ -72,7 +72,7 @@ Whether or not this caption track is for the deaf/hard of hearing.
7272

7373
> **data**: `any`
7474
75-
Defined in: [entities/caption.ts:36](https://github.com/brandonbothell/popyt/blob/534e5115ace99d29ee44af4839e9db8f769827fb/src/entities/caption.ts#L36)
75+
Defined in: [entities/caption.ts:36](https://github.com/brandonbothell/popyt/blob/d2c7d6853da78c625d9181889723f4cfa4f59197/src/entities/caption.ts#L36)
7676

7777
The raw data of this caption track.
7878

@@ -82,7 +82,7 @@ The raw data of this caption track.
8282

8383
> **draft**: `boolean`
8484
85-
Defined in: [entities/caption.ts:91](https://github.com/brandonbothell/popyt/blob/534e5115ace99d29ee44af4839e9db8f769827fb/src/entities/caption.ts#L91)
85+
Defined in: [entities/caption.ts:91](https://github.com/brandonbothell/popyt/blob/d2c7d6853da78c625d9181889723f4cfa4f59197/src/entities/caption.ts#L91)
8686

8787
Whether or not this caption track is a draft. If so, it won't be shown to users.
8888

@@ -92,7 +92,7 @@ Whether or not this caption track is a draft. If so, it won't be shown to users.
9292

9393
> **easyReader**: `boolean`
9494
95-
Defined in: [entities/caption.ts:86](https://github.com/brandonbothell/popyt/blob/534e5115ace99d29ee44af4839e9db8f769827fb/src/entities/caption.ts#L86)
95+
Defined in: [entities/caption.ts:86](https://github.com/brandonbothell/popyt/blob/d2c7d6853da78c625d9181889723f4cfa4f59197/src/entities/caption.ts#L86)
9696

9797
Whether or not this caption track is written at a third-grade level (for language learners).
9898

@@ -102,7 +102,7 @@ Whether or not this caption track is written at a third-grade level (for languag
102102

103103
> `optional` **failureReason?**: `"processingFailed"` \| `"unknownFormat"` \| `"unsupportedFormat"`
104104
105-
Defined in: [entities/caption.ts:107](https://github.com/brandonbothell/popyt/blob/534e5115ace99d29ee44af4839e9db8f769827fb/src/entities/caption.ts#L107)
105+
Defined in: [entities/caption.ts:107](https://github.com/brandonbothell/popyt/blob/d2c7d6853da78c625d9181889723f4cfa4f59197/src/entities/caption.ts#L107)
106106

107107
If [Caption.status](./Caption#status) is `failed`, then this is populated with the reason failure.
108108

@@ -112,7 +112,7 @@ If [Caption.status](./Caption#status) is `failed`, then this is populated with t
112112

113113
> **full**: `boolean` = `true`
114114
115-
Defined in: [entities/caption.ts:31](https://github.com/brandonbothell/popyt/blob/534e5115ace99d29ee44af4839e9db8f769827fb/src/entities/caption.ts#L31)
115+
Defined in: [entities/caption.ts:31](https://github.com/brandonbothell/popyt/blob/d2c7d6853da78c625d9181889723f4cfa4f59197/src/entities/caption.ts#L31)
116116

117117
Whether or not this is a full caption track object.
118118

@@ -122,7 +122,7 @@ Whether or not this is a full caption track object.
122122

123123
> **id**: `string`
124124
125-
Defined in: [entities/caption.ts:41](https://github.com/brandonbothell/popyt/blob/534e5115ace99d29ee44af4839e9db8f769827fb/src/entities/caption.ts#L41)
125+
Defined in: [entities/caption.ts:41](https://github.com/brandonbothell/popyt/blob/d2c7d6853da78c625d9181889723f4cfa4f59197/src/entities/caption.ts#L41)
126126

127127
The ID of this caption track.
128128

@@ -132,7 +132,7 @@ The ID of this caption track.
132132

133133
> **kind**: `"standard"` \| `"ASR"` \| `"forced"`
134134
135-
Defined in: [entities/caption.ts:56](https://github.com/brandonbothell/popyt/blob/534e5115ace99d29ee44af4839e9db8f769827fb/src/entities/caption.ts#L56)
135+
Defined in: [entities/caption.ts:56](https://github.com/brandonbothell/popyt/blob/d2c7d6853da78c625d9181889723f4cfa4f59197/src/entities/caption.ts#L56)
136136

137137
The kind of caption track this is (automatic speech recognition, forced due to foreign language, or standard).
138138

@@ -142,7 +142,7 @@ The kind of caption track this is (automatic speech recognition, forced due to f
142142

143143
> **language**: `string`
144144
145-
Defined in: [entities/caption.ts:61](https://github.com/brandonbothell/popyt/blob/534e5115ace99d29ee44af4839e9db8f769827fb/src/entities/caption.ts#L61)
145+
Defined in: [entities/caption.ts:61](https://github.com/brandonbothell/popyt/blob/d2c7d6853da78c625d9181889723f4cfa4f59197/src/entities/caption.ts#L61)
146146

147147
The language that this caption track is written in.
148148

@@ -152,7 +152,7 @@ The language that this caption track is written in.
152152

153153
> **large**: `boolean`
154154
155-
Defined in: [entities/caption.ts:81](https://github.com/brandonbothell/popyt/blob/534e5115ace99d29ee44af4839e9db8f769827fb/src/entities/caption.ts#L81)
155+
Defined in: [entities/caption.ts:81](https://github.com/brandonbothell/popyt/blob/d2c7d6853da78c625d9181889723f4cfa4f59197/src/entities/caption.ts#L81)
156156

157157
Whether or not this caption track uses large text for the vision-impaired.
158158

@@ -162,7 +162,7 @@ Whether or not this caption track uses large text for the vision-impaired.
162162

163163
> **lastUpdated**: `Date`
164164
165-
Defined in: [entities/caption.ts:51](https://github.com/brandonbothell/popyt/blob/534e5115ace99d29ee44af4839e9db8f769827fb/src/entities/caption.ts#L51)
165+
Defined in: [entities/caption.ts:51](https://github.com/brandonbothell/popyt/blob/d2c7d6853da78c625d9181889723f4cfa4f59197/src/entities/caption.ts#L51)
166166

167167
When this caption track was last updated.
168168

@@ -172,7 +172,7 @@ When this caption track was last updated.
172172

173173
> **name**: `string`
174174
175-
Defined in: [entities/caption.ts:66](https://github.com/brandonbothell/popyt/blob/534e5115ace99d29ee44af4839e9db8f769827fb/src/entities/caption.ts#L66)
175+
Defined in: [entities/caption.ts:66](https://github.com/brandonbothell/popyt/blob/d2c7d6853da78c625d9181889723f4cfa4f59197/src/entities/caption.ts#L66)
176176

177177
The name of this caption track.
178178

@@ -182,7 +182,7 @@ The name of this caption track.
182182

183183
> **status**: `"failed"` \| `"serving"` \| `"syncing"`
184184
185-
Defined in: [entities/caption.ts:101](https://github.com/brandonbothell/popyt/blob/534e5115ace99d29ee44af4839e9db8f769827fb/src/entities/caption.ts#L101)
185+
Defined in: [entities/caption.ts:101](https://github.com/brandonbothell/popyt/blob/d2c7d6853da78c625d9181889723f4cfa4f59197/src/entities/caption.ts#L101)
186186

187187
The processing status of the caption track.
188188

@@ -192,7 +192,7 @@ The processing status of the caption track.
192192

193193
> **videoId**: `string`
194194
195-
Defined in: [entities/caption.ts:46](https://github.com/brandonbothell/popyt/blob/534e5115ace99d29ee44af4839e9db8f769827fb/src/entities/caption.ts#L46)
195+
Defined in: [entities/caption.ts:46](https://github.com/brandonbothell/popyt/blob/d2c7d6853da78c625d9181889723f4cfa4f59197/src/entities/caption.ts#L46)
196196

197197
The ID of the [Video](./Video#) that this caption track is for.
198198

@@ -202,7 +202,7 @@ The ID of the [Video](./Video#) that this caption track is for.
202202

203203
> **youtube**: [`YouTube`](YouTube.md)
204204
205-
Defined in: [entities/caption.ts:26](https://github.com/brandonbothell/popyt/blob/534e5115ace99d29ee44af4839e9db8f769827fb/src/entities/caption.ts#L26)
205+
Defined in: [entities/caption.ts:26](https://github.com/brandonbothell/popyt/blob/d2c7d6853da78c625d9181889723f4cfa4f59197/src/entities/caption.ts#L26)
206206

207207
The YouTube object that created this caption track object.
208208

@@ -212,7 +212,7 @@ The YouTube object that created this caption track object.
212212

213213
> `static` **endpoint**: `string` = `'i18nRegions'`
214214
215-
Defined in: [entities/caption.ts:11](https://github.com/brandonbothell/popyt/blob/534e5115ace99d29ee44af4839e9db8f769827fb/src/entities/caption.ts#L11)
215+
Defined in: [entities/caption.ts:11](https://github.com/brandonbothell/popyt/blob/d2c7d6853da78c625d9181889723f4cfa4f59197/src/entities/caption.ts#L11)
216216

217217
The name of the endpoint used for this entity.
218218

@@ -222,7 +222,7 @@ The name of the endpoint used for this entity.
222222

223223
> `static` **fields**: `string` = `'items(kind,id,snippet)'`
224224
225-
Defined in: [entities/caption.ts:21](https://github.com/brandonbothell/popyt/blob/534e5115ace99d29ee44af4839e9db8f769827fb/src/entities/caption.ts#L21)
225+
Defined in: [entities/caption.ts:21](https://github.com/brandonbothell/popyt/blob/d2c7d6853da78c625d9181889723f4cfa4f59197/src/entities/caption.ts#L21)
226226

227227
The fields to request for this entity.
228228

@@ -232,7 +232,7 @@ The fields to request for this entity.
232232

233233
> `static` **part**: `string` = `'snippet'`
234234
235-
Defined in: [entities/caption.ts:16](https://github.com/brandonbothell/popyt/blob/534e5115ace99d29ee44af4839e9db8f769827fb/src/entities/caption.ts#L16)
235+
Defined in: [entities/caption.ts:16](https://github.com/brandonbothell/popyt/blob/d2c7d6853da78c625d9181889723f4cfa4f59197/src/entities/caption.ts#L16)
236236

237237
The parts to request for this entity.
238238

@@ -242,7 +242,7 @@ The parts to request for this entity.
242242

243243
> **delete**(): `Promise`\<`void`\>
244244
245-
Defined in: [entities/caption.ts:180](https://github.com/brandonbothell/popyt/blob/534e5115ace99d29ee44af4839e9db8f769827fb/src/entities/caption.ts#L180)
245+
Defined in: [entities/caption.ts:180](https://github.com/brandonbothell/popyt/blob/d2c7d6853da78c625d9181889723f4cfa4f59197/src/entities/caption.ts#L180)
246246

247247
Deletes the caption.
248248
Must be using an access token with correct scopes.
@@ -257,7 +257,7 @@ Must be using an access token with correct scopes.
257257

258258
> **download**(`format?`, `language?`): `Promise`\<`Buffer`\<`ArrayBufferLike`\>\>
259259
260-
Defined in: [entities/caption.ts:172](https://github.com/brandonbothell/popyt/blob/534e5115ace99d29ee44af4839e9db8f769827fb/src/entities/caption.ts#L172)
260+
Defined in: [entities/caption.ts:172](https://github.com/brandonbothell/popyt/blob/d2c7d6853da78c625d9181889723f4cfa4f59197/src/entities/caption.ts#L172)
261261

262262
Downloads this caption's track.
263263
Must be using an access token with correct scopes.
@@ -286,7 +286,7 @@ The language to download the track in.
286286

287287
> **fetch**(): `Promise`\<`Caption`\>
288288
289-
Defined in: [entities/caption.ts:150](https://github.com/brandonbothell/popyt/blob/534e5115ace99d29ee44af4839e9db8f769827fb/src/entities/caption.ts#L150)
289+
Defined in: [entities/caption.ts:150](https://github.com/brandonbothell/popyt/blob/d2c7d6853da78c625d9181889723f4cfa4f59197/src/entities/caption.ts#L150)
290290

291291
Fetches this caption from the API and reassigns this object to the new caption object.
292292
Only useful if `this.full` is false, or if you want updated caption info.
@@ -302,7 +302,7 @@ Must be using an access token with correct scopes.
302302

303303
> **update**(`track?`, `draft?`): `Promise`\<`Caption`\>
304304
305-
Defined in: [entities/caption.ts:161](https://github.com/brandonbothell/popyt/blob/534e5115ace99d29ee44af4839e9db8f769827fb/src/entities/caption.ts#L161)
305+
Defined in: [entities/caption.ts:161](https://github.com/brandonbothell/popyt/blob/d2c7d6853da78c625d9181889723f4cfa4f59197/src/entities/caption.ts#L161)
306306

307307
Updates this caption.
308308
Must be using an access token with correct scopes.

0 commit comments

Comments
 (0)