Class: Azure::MediaServices::Mgmt::V2020_05_01::Models::LiveEvent

Inherits:
TrackedResource show all
Includes:
MsRestAzure
Defined in:
lib/2020-05-01/generated/azure_mgmt_media_services/models/live_event.rb

Overview

The live event.

Instance Attribute Summary collapse

Attributes inherited from TrackedResource

#location, #tags

Attributes inherited from Resource

#id, #name, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#created ⇒ DateTime

Returns The creation time for the live event.

Returns:

  • (DateTime) —

    The creation time for the live event



69
70
71
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/live_event.rb', line 69

def created
  @created
end

#cross_site_access_policies ⇒ CrossSiteAccessPolicies

policies.

Returns:



48
49
50
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/live_event.rb', line 48

def cross_site_access_policies
  @cross_site_access_policies
end

#description ⇒ String

Returns A description for the live event.

Returns:

  • (String) —

    A description for the live event.



16
17
18
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/live_event.rb', line 16

def description
  @description
end

#encoding ⇒ LiveEventEncoding

configures whether a live encoder is used for the live event and settings for the live encoder if it is used.

Returns:



30
31
32
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/live_event.rb', line 30

def encoding
  @encoding
end

#hostname_prefix ⇒ String

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.

Returns:

  • (String) —

    When useStaticHostname is set to true, the



60
61
62
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/live_event.rb', line 60

def hostname_prefix
  @hostname_prefix
end

#input ⇒ LiveEventInput

live event receives input from a contribution encoder.

Returns:



20
21
22
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/live_event.rb', line 20

def input
  @input
end

#last_modified ⇒ DateTime

Returns The last modified time of the live event.

Returns:

  • (DateTime) —

    The last modified time of the live event.



72
73
74
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/live_event.rb', line 72

def last_modified
  @last_modified
end

#preview ⇒ LiveEventPreview

live event producers to preview the live streaming content without creating any live output.

Returns:



25
26
27
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/live_event.rb', line 25

def preview
  @preview
end

#provisioning_state ⇒ String

Returns The provisioning state of the live event.

Returns:

  • (String) —

    The provisioning state of the live event.



38
39
40
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/live_event.rb', line 38

def provisioning_state
  @provisioning_state
end

#resource_state ⇒ LiveEventResourceState

See go.microsoft.com/fwlink/?linkid=2139012 for more information. Possible values include: ‘Stopped’, ‘Allocating’, ‘StandBy’, ‘Starting’, ‘Running’, ‘Stopping’, ‘Deleting’

Returns:



44
45
46
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/live_event.rb', line 44

def resource_state
  @resource_state
end

#stream_options ⇒ Array<StreamOptionsFlag>

LiveEvent. This value is specified at creation time and cannot be updated. The valid values for the array entry values are ‘Default’ and ‘LowLatency’.

Returns:



66
67
68
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/live_event.rb', line 66

def stream_options
  @stream_options
end

#system_data ⇒ SystemData

Returns The system metadata relating to this resource.

Returns:

  • (SystemData) —

    The system metadata relating to this resource.



75
76
77
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/live_event.rb', line 75

def system_data
  @system_data
end

#transcriptions ⇒ Array<LiveEventTranscription>

the live event. See go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature.

Returns:



35
36
37
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/live_event.rb', line 35

def transcriptions
  @transcriptions
end

#use_static_hostname ⇒ Boolean

to the live event preview and ingest endpoints. This value can only be updated if the live event is in Standby state

Returns:

  • (Boolean) —

    Specifies whether a static hostname would be assigned



53
54
55
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/live_event.rb', line 53

def use_static_hostname
  @use_static_hostname
end

Class Method Details

.mapper ⇒ Object

Mapper for LiveEvent class as Ruby Hash. This will be used for serialization/deserialization.



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
 
# File 'lib/2020-05-01/generated/azure_mgmt_media_services/models/live_event.rb', line 82

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'LiveEvent',
    type: {
      name: 'Composite',
      class_name: 'LiveEvent',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        tags: {
          client_side_validation: true,
          required: false,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        location: {
          client_side_validation: true,
          required: true,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.description',
          type: {
            name: 'String'
          }
        },
        input: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.input',
          type: {
            name: 'Composite',
            class_name: 'LiveEventInput'
          }
        },
        preview: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.preview',
          type: {
            name: 'Composite',
            class_name: 'LiveEventPreview'
          }
        },
        encoding: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.encoding',
          type: {
            name: 'Composite',
            class_name: 'LiveEventEncoding'
          }
        },
        transcriptions: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.transcriptions',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'LiveEventTranscriptionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'LiveEventTranscription'
                }
            }
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        },
        resource_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.resourceState',
          type: {
            name: 'String'
          }
        },
        cross_site_access_policies: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.crossSiteAccessPolicies',
          type: {
            name: 'Composite',
            class_name: 'CrossSiteAccessPolicies'
          }
        },
        use_static_hostname: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.useStaticHostname',
          type: {
            name: 'Boolean'
          }
        },
        hostname_prefix: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.hostnamePrefix',
          type: {
            name: 'String'
          }
        },
        stream_options: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.streamOptions',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StreamOptionsFlagElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        created: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.created',
          type: {
            name: 'DateTime'
          }
        },
        last_modified: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.lastModified',
          type: {
            name: 'DateTime'
          }
        },
        system_data: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'systemData',
          type: {
            name: 'Composite',
            class_name: 'SystemData'
          }
        }
      }
    }
  }
end