-
Notifications
You must be signed in to change notification settings - Fork 180
/
LiveEvent.yml
311 lines (303 loc) · 9.93 KB
/
LiveEvent.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
### YamlMime:TSType
name: LiveEvent
uid: '@azure/arm-mediaservices.LiveEvent'
package: '@azure/arm-mediaservices'
summary: The live event.
fullName: LiveEvent
remarks: ''
isDeprecated: false
type: interface
properties:
- name: created
uid: '@azure/arm-mediaservices.LiveEvent.created'
package: '@azure/arm-mediaservices'
summary: >-
The creation time for the live event
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: created
remarks: ''
isDeprecated: false
syntax:
content: 'created?: Date'
return:
description: ''
type: Date
- name: crossSiteAccessPolicies
uid: '@azure/arm-mediaservices.LiveEvent.crossSiteAccessPolicies'
package: '@azure/arm-mediaservices'
summary: Live event cross site access policies.
fullName: crossSiteAccessPolicies
remarks: ''
isDeprecated: false
syntax:
content: 'crossSiteAccessPolicies?: CrossSiteAccessPolicies'
return:
description: ''
type: <xref uid="@azure/arm-mediaservices.CrossSiteAccessPolicies" />
- name: description
uid: '@azure/arm-mediaservices.LiveEvent.description'
package: '@azure/arm-mediaservices'
summary: A description for the live event.
fullName: description
remarks: ''
isDeprecated: false
syntax:
content: 'description?: string'
return:
description: ''
type: string
- name: encoding
uid: '@azure/arm-mediaservices.LiveEvent.encoding'
package: '@azure/arm-mediaservices'
summary: >-
Encoding settings for the live event. It configures whether a live encoder
is used for the live event and settings for the live encoder if it is
used.
fullName: encoding
remarks: ''
isDeprecated: false
syntax:
content: 'encoding?: LiveEventEncoding'
return:
description: ''
type: <xref uid="@azure/arm-mediaservices.LiveEventEncoding" />
- name: hostnamePrefix
uid: '@azure/arm-mediaservices.LiveEvent.hostnamePrefix'
package: '@azure/arm-mediaservices'
summary: >-
When useStaticHostname is set to true, the hostnamePrefix specifies the
first part of the hostname assigned to the live event preview and ingest
endpoints. The final hostname would be a combination of this prefix, the
media service account name and a short code for the Azure Media Services
data center.
fullName: hostnamePrefix
remarks: ''
isDeprecated: false
syntax:
content: 'hostnamePrefix?: string'
return:
description: ''
type: string
- name: input
uid: '@azure/arm-mediaservices.LiveEvent.input'
package: '@azure/arm-mediaservices'
summary: >-
Live event input settings. It defines how the live event receives input
from a contribution encoder.
fullName: input
remarks: ''
isDeprecated: false
syntax:
content: 'input?: LiveEventInput'
return:
description: ''
type: <xref uid="@azure/arm-mediaservices.LiveEventInput" />
- name: lastModified
uid: '@azure/arm-mediaservices.LiveEvent.lastModified'
package: '@azure/arm-mediaservices'
summary: >-
The last modified time of the live event.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: lastModified
remarks: ''
isDeprecated: false
syntax:
content: 'lastModified?: Date'
return:
description: ''
type: Date
- name: preview
uid: '@azure/arm-mediaservices.LiveEvent.preview'
package: '@azure/arm-mediaservices'
summary: >-
Live event preview settings. Preview allows live event producers to
preview the live streaming content without creating any live output.
fullName: preview
remarks: ''
isDeprecated: false
syntax:
content: 'preview?: LiveEventPreview'
return:
description: ''
type: <xref uid="@azure/arm-mediaservices.LiveEventPreview" />
- name: provisioningState
uid: '@azure/arm-mediaservices.LiveEvent.provisioningState'
package: '@azure/arm-mediaservices'
summary: >-
The provisioning state of the live event.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: provisioningState
remarks: ''
isDeprecated: false
syntax:
content: 'provisioningState?: string'
return:
description: ''
type: string
- name: resourceState
uid: '@azure/arm-mediaservices.LiveEvent.resourceState'
package: '@azure/arm-mediaservices'
summary: >-
The resource state of the live event. See
https://go.microsoft.com/fwlink/?linkid=2139012 for more information.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: resourceState
remarks: ''
isDeprecated: false
syntax:
content: 'resourceState?: string'
return:
description: ''
type: string
- name: streamOptions
uid: '@azure/arm-mediaservices.LiveEvent.streamOptions'
package: '@azure/arm-mediaservices'
summary: >-
The options to use for the LiveEvent. This value is specified at creation
time and cannot be updated. The valid values for the array entry values
are 'Default' and 'LowLatency'.
fullName: streamOptions
remarks: ''
isDeprecated: false
syntax:
content: 'streamOptions?: string[]'
return:
description: ''
type: string[]
- name: systemData
uid: '@azure/arm-mediaservices.LiveEvent.systemData'
package: '@azure/arm-mediaservices'
summary: >-
The system metadata relating to this resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: systemData
remarks: ''
isDeprecated: false
syntax:
content: 'systemData?: SystemData'
return:
description: ''
type: <xref uid="@azure/arm-mediaservices.SystemData" />
- name: transcriptions
uid: '@azure/arm-mediaservices.LiveEvent.transcriptions'
package: '@azure/arm-mediaservices'
summary: >-
Live transcription settings for the live event. See
https://go.microsoft.com/fwlink/?linkid=2133742 for more information about
the live transcription feature.
fullName: transcriptions
remarks: ''
isDeprecated: false
syntax:
content: 'transcriptions?: LiveEventTranscription[]'
return:
description: ''
type: <xref uid="@azure/arm-mediaservices.LiveEventTranscription" />[]
- name: useStaticHostname
uid: '@azure/arm-mediaservices.LiveEvent.useStaticHostname'
package: '@azure/arm-mediaservices'
summary: >-
Specifies whether a static hostname would be assigned to the live event
preview and ingest endpoints. This value can only be updated if the live
event is in Standby state
fullName: useStaticHostname
remarks: ''
isDeprecated: false
syntax:
content: 'useStaticHostname?: boolean'
return:
description: ''
type: boolean
inheritedProperties:
- name: id
uid: '@azure/arm-mediaservices.LiveEvent.id'
package: '@azure/arm-mediaservices'
summary: >-
Fully qualified resource ID for the resource. Ex -
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: id
remarks: ''
isDeprecated: false
syntax:
content: 'id?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[TrackedResource.id](xref:@azure/arm-mediaservices.TrackedResource.id)
- name: location
uid: '@azure/arm-mediaservices.LiveEvent.location'
package: '@azure/arm-mediaservices'
summary: The geo-location where the resource lives
fullName: location
remarks: ''
isDeprecated: false
syntax:
content: 'location: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[TrackedResource.location](xref:@azure/arm-mediaservices.TrackedResource.location)
- name: name
uid: '@azure/arm-mediaservices.LiveEvent.name'
package: '@azure/arm-mediaservices'
summary: >-
The name of the resource
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: name
remarks: ''
isDeprecated: false
syntax:
content: 'name?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[TrackedResource.name](xref:@azure/arm-mediaservices.TrackedResource.name)
- name: tags
uid: '@azure/arm-mediaservices.LiveEvent.tags'
package: '@azure/arm-mediaservices'
summary: Resource tags.
fullName: tags
remarks: ''
isDeprecated: false
syntax:
content: 'tags?: {[propertyName: string]: string}'
return:
description: ''
type: '{[propertyName: string]: string}'
inheritanceDescription: >-
<b>Inherited From</b>
[TrackedResource.tags](xref:@azure/arm-mediaservices.TrackedResource.tags)
- name: type
uid: '@azure/arm-mediaservices.LiveEvent.type'
package: '@azure/arm-mediaservices'
summary: >-
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or
"Microsoft.Storage/storageAccounts"
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: type
remarks: ''
isDeprecated: false
syntax:
content: 'type?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[TrackedResource.type](xref:@azure/arm-mediaservices.TrackedResource.type)
extends: <xref uid="@azure/arm-mediaservices.TrackedResource" />