You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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)
20
20
21
21
#### Parameters
22
22
@@ -42,7 +42,7 @@ Defined in: [entities/caption.ts:109](https://github.com/brandonbothell/popyt/bl
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)
46
46
47
47
Whether the audio is a commentary/descriptive (alternate audio tracks), the primary audio track, or unknown.
48
48
@@ -52,7 +52,7 @@ Whether the audio is a commentary/descriptive (alternate audio tracks), the prim
52
52
53
53
> **autoSynced**: `boolean`
54
54
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)
56
56
57
57
Whether or not this caption track has been autosynced to the audio by YouTube.
58
58
@@ -62,7 +62,7 @@ Whether or not this caption track has been autosynced to the audio by YouTube.
62
62
63
63
> **closedCaptions**: `boolean`
64
64
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)
66
66
67
67
Whether or not this caption track is for the deaf/hard of hearing.
68
68
@@ -72,7 +72,7 @@ Whether or not this caption track is for the deaf/hard of hearing.
72
72
73
73
> **data**: `any`
74
74
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)
76
76
77
77
The raw data of this caption track.
78
78
@@ -82,7 +82,7 @@ The raw data of this caption track.
82
82
83
83
> **draft**: `boolean`
84
84
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)
86
86
87
87
Whether or not this caption track is a draft. If so, it won't be shown to users.
88
88
@@ -92,7 +92,7 @@ Whether or not this caption track is a draft. If so, it won't be shown to users.
92
92
93
93
> **easyReader**: `boolean`
94
94
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)
96
96
97
97
Whether or not this caption track is written at a third-grade level (for language learners).
98
98
@@ -102,7 +102,7 @@ Whether or not this caption track is written at a third-grade level (for languag
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)
106
106
107
107
If [Caption.status](./Caption#status) is `failed`, then this is populated with the reason failure.
108
108
@@ -112,7 +112,7 @@ If [Caption.status](./Caption#status) is `failed`, then this is populated with t
112
112
113
113
> **full**: `boolean` = `true`
114
114
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)
116
116
117
117
Whether or not this is a full caption track object.
118
118
@@ -122,7 +122,7 @@ Whether or not this is a full caption track object.
122
122
123
123
> **id**: `string`
124
124
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)
126
126
127
127
The ID of this caption track.
128
128
@@ -132,7 +132,7 @@ The ID of this caption track.
132
132
133
133
> **kind**: `"standard"`\|`"ASR"`\|`"forced"`
134
134
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)
136
136
137
137
The kind of caption track this is (automatic speech recognition, forced due to foreign language, or standard).
138
138
@@ -142,7 +142,7 @@ The kind of caption track this is (automatic speech recognition, forced due to f
142
142
143
143
> **language**: `string`
144
144
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)
146
146
147
147
The language that this caption track is written in.
148
148
@@ -152,7 +152,7 @@ The language that this caption track is written in.
152
152
153
153
> **large**: `boolean`
154
154
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)
156
156
157
157
Whether or not this caption track uses large text for the vision-impaired.
158
158
@@ -162,7 +162,7 @@ Whether or not this caption track uses large text for the vision-impaired.
162
162
163
163
> **lastUpdated**: `Date`
164
164
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)
166
166
167
167
When this caption track was last updated.
168
168
@@ -172,7 +172,7 @@ When this caption track was last updated.
172
172
173
173
> **name**: `string`
174
174
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)
176
176
177
177
The name of this caption track.
178
178
@@ -182,7 +182,7 @@ The name of this caption track.
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)
186
186
187
187
The processing status of the caption track.
188
188
@@ -192,7 +192,7 @@ The processing status of the caption track.
192
192
193
193
> **videoId**: `string`
194
194
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)
196
196
197
197
The ID of the [Video](./Video#) that this caption track is for.
198
198
@@ -202,7 +202,7 @@ The ID of the [Video](./Video#) that this caption track is for.
202
202
203
203
> **youtube**: [`YouTube`](YouTube.md)
204
204
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)
206
206
207
207
The YouTube object that created this caption track object.
208
208
@@ -212,7 +212,7 @@ The YouTube object that created this caption track object.
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)
216
216
217
217
The name of the endpoint used for this entity.
218
218
@@ -222,7 +222,7 @@ The name of the endpoint used for this entity.
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)
226
226
227
227
The fields to request for this entity.
228
228
@@ -232,7 +232,7 @@ The fields to request for this entity.
232
232
233
233
> `static`**part**: `string` = `'snippet'`
234
234
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)
236
236
237
237
The parts to request for this entity.
238
238
@@ -242,7 +242,7 @@ The parts to request for this entity.
242
242
243
243
> **delete**(): `Promise`\<`void`\>
244
244
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)
246
246
247
247
Deletes the caption.
248
248
Must be using an access token with correct scopes.
@@ -257,7 +257,7 @@ Must be using an access token with correct scopes.
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)
261
261
262
262
Downloads this caption's track.
263
263
Must be using an access token with correct scopes.
@@ -286,7 +286,7 @@ The language to download the track in.
286
286
287
287
> **fetch**(): `Promise`\<`Caption`\>
288
288
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)
290
290
291
291
Fetches this caption from the API and reassigns this object to the new caption object.
292
292
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.
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)
306
306
307
307
Updates this caption.
308
308
Must be using an access token with correct scopes.
0 commit comments