-
Notifications
You must be signed in to change notification settings - Fork 181
/
Tracks.yml
409 lines (401 loc) · 15.5 KB
/
Tracks.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
### YamlMime:TSType
name: Tracks
uid: '@azure/arm-mediaservices.Tracks'
package: '@azure/arm-mediaservices'
summary: Interface representing a Tracks.
fullName: Tracks
remarks: ''
isDeprecated: false
type: interface
methods:
- name: >-
beginCreateOrUpdate(string, string, string, string, AssetTrack,
TracksCreateOrUpdateOptionalParams)
uid: '@azure/arm-mediaservices.Tracks.beginCreateOrUpdate'
package: '@azure/arm-mediaservices'
summary: Create or update a Track in the asset
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginCreateOrUpdate(resourceGroupName: string, accountName:
string, assetName: string, trackName: string, parameters: AssetTrack,
options?: TracksCreateOrUpdateOptionalParams):
Promise<PollerLike<PollOperationState<TracksCreateOrUpdateResponse>,
TracksCreateOrUpdateResponse>>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group within the Azure subscription.
- id: accountName
type: string
description: The Media Services account name.
- id: assetName
type: string
description: The Asset name.
- id: trackName
type: string
description: The Asset Track name.
- id: parameters
type: <xref uid="@azure/arm-mediaservices.AssetTrack" />
description: The request parameters
- id: options
type: >-
<xref
uid="@azure/arm-mediaservices.TracksCreateOrUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.PollerLike" /><<xref
uid="@azure/core-lro.PollOperationState" /><<xref
uid="@azure/arm-mediaservices.TracksCreateOrUpdateResponse" />>,
<xref uid="@azure/arm-mediaservices.TracksCreateOrUpdateResponse"
/>>>
- name: >-
beginCreateOrUpdateAndWait(string, string, string, string, AssetTrack,
TracksCreateOrUpdateOptionalParams)
uid: '@azure/arm-mediaservices.Tracks.beginCreateOrUpdateAndWait'
package: '@azure/arm-mediaservices'
summary: Create or update a Track in the asset
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginCreateOrUpdateAndWait(resourceGroupName: string,
accountName: string, assetName: string, trackName: string, parameters:
AssetTrack, options?: TracksCreateOrUpdateOptionalParams):
Promise<TracksCreateOrUpdateResponse>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group within the Azure subscription.
- id: accountName
type: string
description: The Media Services account name.
- id: assetName
type: string
description: The Asset name.
- id: trackName
type: string
description: The Asset Track name.
- id: parameters
type: <xref uid="@azure/arm-mediaservices.AssetTrack" />
description: The request parameters
- id: options
type: >-
<xref
uid="@azure/arm-mediaservices.TracksCreateOrUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref
uid="@azure/arm-mediaservices.TracksCreateOrUpdateResponse" />>
- name: beginDelete(string, string, string, string, TracksDeleteOptionalParams)
uid: '@azure/arm-mediaservices.Tracks.beginDelete'
package: '@azure/arm-mediaservices'
summary: Deletes a Track in the asset
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginDelete(resourceGroupName: string, accountName: string,
assetName: string, trackName: string, options?:
TracksDeleteOptionalParams):
Promise<PollerLike<PollOperationState<TracksDeleteHeaders>,
TracksDeleteHeaders>>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group within the Azure subscription.
- id: accountName
type: string
description: The Media Services account name.
- id: assetName
type: string
description: The Asset name.
- id: trackName
type: string
description: The Asset Track name.
- id: options
type: <xref uid="@azure/arm-mediaservices.TracksDeleteOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.PollerLike" /><<xref
uid="@azure/core-lro.PollOperationState" /><<xref
uid="@azure/arm-mediaservices.TracksDeleteHeaders" />>, <xref
uid="@azure/arm-mediaservices.TracksDeleteHeaders" />>>
- name: >-
beginDeleteAndWait(string, string, string, string,
TracksDeleteOptionalParams)
uid: '@azure/arm-mediaservices.Tracks.beginDeleteAndWait'
package: '@azure/arm-mediaservices'
summary: Deletes a Track in the asset
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginDeleteAndWait(resourceGroupName: string, accountName:
string, assetName: string, trackName: string, options?:
TracksDeleteOptionalParams): Promise<TracksDeleteHeaders>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group within the Azure subscription.
- id: accountName
type: string
description: The Media Services account name.
- id: assetName
type: string
description: The Asset name.
- id: trackName
type: string
description: The Asset Track name.
- id: options
type: <xref uid="@azure/arm-mediaservices.TracksDeleteOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/arm-mediaservices.TracksDeleteHeaders"
/>>
- name: >-
beginUpdate(string, string, string, string, AssetTrack,
TracksUpdateOptionalParams)
uid: '@azure/arm-mediaservices.Tracks.beginUpdate'
package: '@azure/arm-mediaservices'
summary: Updates an existing Track in the asset
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginUpdate(resourceGroupName: string, accountName: string,
assetName: string, trackName: string, parameters: AssetTrack, options?:
TracksUpdateOptionalParams):
Promise<PollerLike<PollOperationState<TracksUpdateResponse>,
TracksUpdateResponse>>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group within the Azure subscription.
- id: accountName
type: string
description: The Media Services account name.
- id: assetName
type: string
description: The Asset name.
- id: trackName
type: string
description: The Asset Track name.
- id: parameters
type: <xref uid="@azure/arm-mediaservices.AssetTrack" />
description: The request parameters
- id: options
type: <xref uid="@azure/arm-mediaservices.TracksUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.PollerLike" /><<xref
uid="@azure/core-lro.PollOperationState" /><<xref
uid="@azure/arm-mediaservices.TracksUpdateResponse" />>, <xref
uid="@azure/arm-mediaservices.TracksUpdateResponse" />>>
- name: >-
beginUpdateAndWait(string, string, string, string, AssetTrack,
TracksUpdateOptionalParams)
uid: '@azure/arm-mediaservices.Tracks.beginUpdateAndWait'
package: '@azure/arm-mediaservices'
summary: Updates an existing Track in the asset
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginUpdateAndWait(resourceGroupName: string, accountName:
string, assetName: string, trackName: string, parameters: AssetTrack,
options?: TracksUpdateOptionalParams): Promise<TracksUpdateResponse>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group within the Azure subscription.
- id: accountName
type: string
description: The Media Services account name.
- id: assetName
type: string
description: The Asset name.
- id: trackName
type: string
description: The Asset Track name.
- id: parameters
type: <xref uid="@azure/arm-mediaservices.AssetTrack" />
description: The request parameters
- id: options
type: <xref uid="@azure/arm-mediaservices.TracksUpdateOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/arm-mediaservices.TracksUpdateResponse"
/>>
- name: >-
beginUpdateTrackData(string, string, string, string,
TracksUpdateTrackDataOptionalParams)
uid: '@azure/arm-mediaservices.Tracks.beginUpdateTrackData'
package: '@azure/arm-mediaservices'
summary: >-
Update the track data. Call this API after any changes are made to the
track data stored in the
asset container. For example, you have modified the WebVTT captions file
in the Azure blob storage
container for the asset, viewers will not see the new version of the
captions unless this API is
called. Note, the changes may not be reflected immediately. CDN cache may
also need to be purged if
applicable.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginUpdateTrackData(resourceGroupName: string, accountName:
string, assetName: string, trackName: string, options?:
TracksUpdateTrackDataOptionalParams):
Promise<PollerLike<PollOperationState<TracksUpdateTrackDataHeaders>,
TracksUpdateTrackDataHeaders>>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group within the Azure subscription.
- id: accountName
type: string
description: The Media Services account name.
- id: assetName
type: string
description: The Asset name.
- id: trackName
type: string
description: The Asset Track name.
- id: options
type: >-
<xref
uid="@azure/arm-mediaservices.TracksUpdateTrackDataOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref uid="@azure/core-lro.PollerLike" /><<xref
uid="@azure/core-lro.PollOperationState" /><<xref
uid="@azure/arm-mediaservices.TracksUpdateTrackDataHeaders" />>,
<xref uid="@azure/arm-mediaservices.TracksUpdateTrackDataHeaders"
/>>>
- name: >-
beginUpdateTrackDataAndWait(string, string, string, string,
TracksUpdateTrackDataOptionalParams)
uid: '@azure/arm-mediaservices.Tracks.beginUpdateTrackDataAndWait'
package: '@azure/arm-mediaservices'
summary: >-
Update the track data. Call this API after any changes are made to the
track data stored in the
asset container. For example, you have modified the WebVTT captions file
in the Azure blob storage
container for the asset, viewers will not see the new version of the
captions unless this API is
called. Note, the changes may not be reflected immediately. CDN cache may
also need to be purged if
applicable.
remarks: ''
isDeprecated: false
syntax:
content: >-
function beginUpdateTrackDataAndWait(resourceGroupName: string,
accountName: string, assetName: string, trackName: string, options?:
TracksUpdateTrackDataOptionalParams):
Promise<TracksUpdateTrackDataHeaders>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group within the Azure subscription.
- id: accountName
type: string
description: The Media Services account name.
- id: assetName
type: string
description: The Asset name.
- id: trackName
type: string
description: The Asset Track name.
- id: options
type: >-
<xref
uid="@azure/arm-mediaservices.TracksUpdateTrackDataOptionalParams"
/>
description: The options parameters.
return:
description: ''
type: >-
Promise<<xref
uid="@azure/arm-mediaservices.TracksUpdateTrackDataHeaders" />>
- name: get(string, string, string, string, TracksGetOptionalParams)
uid: '@azure/arm-mediaservices.Tracks.get'
package: '@azure/arm-mediaservices'
summary: Get the details of a Track in the Asset
remarks: ''
isDeprecated: false
syntax:
content: >-
function get(resourceGroupName: string, accountName: string, assetName:
string, trackName: string, options?: TracksGetOptionalParams):
Promise<AssetTrack>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group within the Azure subscription.
- id: accountName
type: string
description: The Media Services account name.
- id: assetName
type: string
description: The Asset name.
- id: trackName
type: string
description: The Asset Track name.
- id: options
type: <xref uid="@azure/arm-mediaservices.TracksGetOptionalParams" />
description: The options parameters.
return:
description: ''
type: Promise<<xref uid="@azure/arm-mediaservices.AssetTrack" />>
- name: list(string, string, string, TracksListOptionalParams)
uid: '@azure/arm-mediaservices.Tracks.list'
package: '@azure/arm-mediaservices'
summary: Lists the Tracks in the asset
remarks: ''
isDeprecated: false
syntax:
content: >-
function list(resourceGroupName: string, accountName: string, assetName:
string, options?: TracksListOptionalParams):
PagedAsyncIterableIterator<AssetTrack, AssetTrack[], PageSettings>
parameters:
- id: resourceGroupName
type: string
description: The name of the resource group within the Azure subscription.
- id: accountName
type: string
description: The Media Services account name.
- id: assetName
type: string
description: The Asset name.
- id: options
type: <xref uid="@azure/arm-mediaservices.TracksListOptionalParams" />
description: The options parameters.
return:
description: ''
type: >-
<xref uid="@azure/core-paging.PagedAsyncIterableIterator" /><<xref
uid="@azure/arm-mediaservices.AssetTrack" />, <xref
uid="@azure/arm-mediaservices.AssetTrack" />[], <xref
uid="@azure/core-paging.PageSettings" />>