Class: MuxRuby::LiveStream

Inherits:
Object
  • Object
show all
Defined in:
lib/mux_ruby/models/live_stream.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LiveStream

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
 
# File 'lib/mux_ruby/models/live_stream.rb', line 139

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MuxRuby::LiveStream` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `MuxRuby::LiveStream`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.key?(:'stream_key')
    self.stream_key = attributes[:'stream_key']
  end

  if attributes.key?(:'active_asset_id')
    self.active_asset_id = attributes[:'active_asset_id']
  end

  if attributes.key?(:'recent_asset_ids')
    if (value = attributes[:'recent_asset_ids']).is_a?(Array)
      self.recent_asset_ids = value
    end
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.key?(:'playback_ids')
    if (value = attributes[:'playback_ids']).is_a?(Array)
      self.playback_ids = value
    end
  end

  if attributes.key?(:'new_asset_settings')
    self.new_asset_settings = attributes[:'new_asset_settings']
  end

  if attributes.key?(:'passthrough')
    self.passthrough = attributes[:'passthrough']
  end

  if attributes.key?(:'audio_only')
    self.audio_only = attributes[:'audio_only']
  end

  if attributes.key?(:'reconnect_window')
    self.reconnect_window = attributes[:'reconnect_window']
  else
    self.reconnect_window = 60
  end

  if attributes.key?(:'reduced_latency')
    self.reduced_latency = attributes[:'reduced_latency']
  end

  if attributes.key?(:'low_latency')
    self.low_latency = attributes[:'low_latency']
  end

  if attributes.key?(:'simulcast_targets')
    if (value = attributes[:'simulcast_targets']).is_a?(Array)
      self.simulcast_targets = value
    end
  end

  if attributes.key?(:'test')
    self.test = attributes[:'test']
  end
end

Instance Attribute Details

#active_asset_id ⇒ Object

The Asset that is currently being created if there is an active broadcast.



28
29
30
 
# File 'lib/mux_ruby/models/live_stream.rb', line 28

def active_asset_id
  @active_asset_id
end

#audio_only ⇒ Object

The live stream only processes the audio track if the value is set to true. Mux drops the video track if broadcasted.



45
46
47
 
# File 'lib/mux_ruby/models/live_stream.rb', line 45

def audio_only
  @audio_only
end

#created_at ⇒ Object

Time the Live Stream was created, defined as a Unix timestamp (seconds since epoch).



22
23
24
 
# File 'lib/mux_ruby/models/live_stream.rb', line 22

def created_at
  @created_at
end

#id ⇒ Object

Unique identifier for the Live Stream. Max 255 characters.



19
20
21
 
# File 'lib/mux_ruby/models/live_stream.rb', line 19

def id
  @id
end

#low_latency ⇒ Object

Latency is the time from when the streamer does something in real life to when you see it happen in the player. Setting this option will enable compatibility with the LL-HLS specification for low-latency streaming. This typically has lower latency than Reduced Latency streams, and cannot be combined with Reduced Latency. Note: Reconnect windows are incompatible with Low Latency and will always be set to zero (0) seconds.



54
55
56
 
# File 'lib/mux_ruby/models/live_stream.rb', line 54

def low_latency
  @low_latency
end

#new_asset_settings ⇒ Object

Returns the value of attribute new_asset_settings.



39
40
41
 
# File 'lib/mux_ruby/models/live_stream.rb', line 39

def new_asset_settings
  @new_asset_settings
end

#passthrough ⇒ Object

Arbitrary metadata set for the asset. Max 255 characters.



42
43
44
 
# File 'lib/mux_ruby/models/live_stream.rb', line 42

def passthrough
  @passthrough
end

#playback_ids ⇒ Object

An array of Playback ID objects. Use these to create HLS playback URLs. See [Play your videos](docs.mux.com/guides/video/play-your-videos) for more details.



37
38
39
 
# File 'lib/mux_ruby/models/live_stream.rb', line 37

def playback_ids
  @playback_ids
end

#recent_asset_ids ⇒ Object

An array of strings with the most recent Assets that were created from this live stream.



31
32
33
 
# File 'lib/mux_ruby/models/live_stream.rb', line 31

def recent_asset_ids
  @recent_asset_ids
end

#reconnect_window ⇒ Object

When live streaming software disconnects from Mux, either intentionally or due to a drop in the network, the Reconnect Window is the time in seconds that Mux should wait for the streaming software to reconnect before considering the live stream finished and completing the recorded asset. Min: 0.1s. Max: 300s (5 minutes).



48
49
50
 
# File 'lib/mux_ruby/models/live_stream.rb', line 48

def reconnect_window
  @reconnect_window
end

#reduced_latency ⇒ Object

Latency is the time from when the streamer does something in real life to when you see it happen in the player. Set this if you want lower latency for your live stream. Note: Reconnect windows are incompatible with Reduced Latency and will always be set to zero (0) seconds. See the [Reduce live stream latency guide](docs.mux.com/guides/video/reduce-live-stream-latency) to understand the tradeoffs.



51
52
53
 
# File 'lib/mux_ruby/models/live_stream.rb', line 51

def reduced_latency
  @reduced_latency
end

#simulcast_targets ⇒ Object

Each Simulcast Target contains configuration details to broadcast (or "restream") a live stream to a third-party streaming service. [See the Stream live to 3rd party platforms guide](docs.mux.com/guides/video/stream-live-to-3rd-party-platforms).



57
58
59
 
# File 'lib/mux_ruby/models/live_stream.rb', line 57

def simulcast_targets
  @simulcast_targets
end

#status ⇒ Object

idle indicates that there is no active broadcast. active indicates that there is an active broadcast and disabled status indicates that no future RTMP streams can be published.



34
35
36
 
# File 'lib/mux_ruby/models/live_stream.rb', line 34

def status
  @status
end

#stream_key ⇒ Object

Unique key used for streaming to a Mux RTMP endpoint. This should be considered as sensitive as credentials, anyone with this stream key can begin streaming.



25
26
27
 
# File 'lib/mux_ruby/models/live_stream.rb', line 25

def stream_key
  @stream_key
end

#test ⇒ Object

True means this live stream is a test live stream. Test live streams can be used to help evaluate the Mux Video APIs for free. There is no limit on the number of test live streams, but they are watermarked with the Mux logo, and limited to 5 minutes. The test live stream is disabled after the stream is active for 5 mins and the recorded asset also deleted after 24 hours.



60
61
62
 
# File 'lib/mux_ruby/models/live_stream.rb', line 60

def test
  @test
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



106
107
108
 
# File 'lib/mux_ruby/models/live_stream.rb', line 106

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/mux_ruby/models/live_stream.rb', line 85

def self.attribute_map
  {
    :'id' => :'id',
    :'created_at' => :'created_at',
    :'stream_key' => :'stream_key',
    :'active_asset_id' => :'active_asset_id',
    :'recent_asset_ids' => :'recent_asset_ids',
    :'status' => :'status',
    :'playback_ids' => :'playback_ids',
    :'new_asset_settings' => :'new_asset_settings',
    :'passthrough' => :'passthrough',
    :'audio_only' => :'audio_only',
    :'reconnect_window' => :'reconnect_window',
    :'reduced_latency' => :'reduced_latency',
    :'low_latency' => :'low_latency',
    :'simulcast_targets' => :'simulcast_targets',
    :'test' => :'test'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



283
284
285
 
# File 'lib/mux_ruby/models/live_stream.rb', line 283

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



132
133
134
135
 
# File 'lib/mux_ruby/models/live_stream.rb', line 132

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/mux_ruby/models/live_stream.rb', line 111

def self.openapi_types
  {
    :'id' => :'String',
    :'created_at' => :'String',
    :'stream_key' => :'String',
    :'active_asset_id' => :'String',
    :'recent_asset_ids' => :'Array<String>',
    :'status' => :'String',
    :'playback_ids' => :'Array<PlaybackID>',
    :'new_asset_settings' => :'CreateAssetRequest',
    :'passthrough' => :'String',
    :'audio_only' => :'Boolean',
    :'reconnect_window' => :'Float',
    :'reduced_latency' => :'Boolean',
    :'low_latency' => :'Boolean',
    :'simulcast_targets' => :'Array<SimulcastTarget>',
    :'test' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/mux_ruby/models/live_stream.rb', line 248

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created_at == o.created_at &&
      stream_key == o.stream_key &&
      active_asset_id == o.active_asset_id &&
      recent_asset_ids == o.recent_asset_ids &&
      status == o.status &&
      playback_ids == o.playback_ids &&
      new_asset_settings == o.new_asset_settings &&
      passthrough == o.passthrough &&
      audio_only == o.audio_only &&
      reconnect_window == o.reconnect_window &&
      reduced_latency == o.reduced_latency &&
      low_latency == o.low_latency &&
      simulcast_targets == o.simulcast_targets &&
      test == o.test
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
 
# File 'lib/mux_ruby/models/live_stream.rb', line 313

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = MuxRuby.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/mux_ruby/models/live_stream.rb', line 384

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/mux_ruby/models/live_stream.rb', line 290

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


270
271
272
 
# File 'lib/mux_ruby/models/live_stream.rb', line 270

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



276
277
278
 
# File 'lib/mux_ruby/models/live_stream.rb', line 276

def hash
  [id, created_at, stream_key, active_asset_id, recent_asset_ids, status, playback_ids, new_asset_settings, passthrough, audio_only, reconnect_window, reduced_latency, low_latency, simulcast_targets, test].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



223
224
225
226
 
# File 'lib/mux_ruby/models/live_stream.rb', line 223

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



360
361
362
 
# File 'lib/mux_ruby/models/live_stream.rb', line 360

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/mux_ruby/models/live_stream.rb', line 366

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



354
355
356
 
# File 'lib/mux_ruby/models/live_stream.rb', line 354

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



230
231
232
233
234
 
# File 'lib/mux_ruby/models/live_stream.rb', line 230

def valid?
  status_validator = EnumAttributeValidator.new('String', ["active", "idle", "disabled"])
  return false unless status_validator.valid?(@status)
  true
end