Class: MuxRuby::UpdateLiveStreamRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateLiveStreamRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MuxRuby::UpdateLiveStreamRequest` 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::UpdateLiveStreamRequest`. 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?(:'passthrough')
    self.passthrough = attributes[:'passthrough']
  end

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

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

  if attributes.key?(:'use_slate_for_standard_latency')
    self.use_slate_for_standard_latency = attributes[:'use_slate_for_standard_latency']
  else
    self.use_slate_for_standard_latency = false
  end

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

  if attributes.key?(:'max_continuous_duration')
    self.max_continuous_duration = attributes[:'max_continuous_duration']
  else
    self.max_continuous_duration = 43200
  end

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

Instance Attribute Details

#latency_mode ⇒ Object

Latency is the time from when the streamer transmits a frame of video to when you see it in the player. Set this as an alternative to setting low latency or reduced latency flags.



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

def latency_mode
  @latency_mode
end

#max_continuous_duration ⇒ Object

The time in seconds a live stream may be continuously active before being disconnected. Defaults to 12 hours.



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

def max_continuous_duration
  @max_continuous_duration
end

#new_asset_settings ⇒ Object

Returns the value of attribute new_asset_settings.



36
37
38
 
# File 'lib/mux_ruby/models/update_live_stream_request.rb', line 36

def new_asset_settings
  @new_asset_settings
end

#passthrough ⇒ Object

Arbitrary user-supplied metadata set for the live stream. Max 255 characters. In order to clear this value, the field should be included with an empty-string value.



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

def passthrough
  @passthrough
end

#reconnect_slate_url ⇒ Object

The URL of the image file that Mux should download and use as slate media during interruptions of the live stream media. This file will be downloaded each time a new recorded asset is created from the live stream. Set this to a blank string to clear the value so that the default slate media will be used.



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

def reconnect_slate_url
  @reconnect_slate_url
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. If not specified directly, Standard Latency streams have a Reconnect Window of 60 seconds; Reduced and Low Latency streams have a default of 0 seconds, or no Reconnect Window. For that reason, we suggest specifying a value other than zero for Reduced and Low Latency streams. Reduced and Low Latency streams with a Reconnect Window greater than zero will insert slate media into the recorded asset while waiting for the streaming software to reconnect or when there are brief interruptions in the live stream media. When using a Reconnect Window setting higher than 60 seconds with a Standard Latency stream, we highly recommend enabling slate with the ‘use_slate_for_standard_latency` option.



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

def reconnect_window
  @reconnect_window
end

#use_slate_for_standard_latency ⇒ Object

By default, Standard Latency live streams do not have slate media inserted while waiting for live streaming software to reconnect to Mux. Setting this to true enables slate insertion on a Standard Latency stream.



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

def use_slate_for_standard_latency
  @use_slate_for_standard_latency
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



74
75
76
 
# File 'lib/mux_ruby/models/update_live_stream_request.rb', line 74

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/mux_ruby/models/update_live_stream_request.rb', line 61

def self.attribute_map
  {
    :'passthrough' => :'passthrough',
    :'latency_mode' => :'latency_mode',
    :'reconnect_window' => :'reconnect_window',
    :'use_slate_for_standard_latency' => :'use_slate_for_standard_latency',
    :'reconnect_slate_url' => :'reconnect_slate_url',
    :'max_continuous_duration' => :'max_continuous_duration',
    :'new_asset_settings' => :'new_asset_settings'
  }
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



249
250
251
 
# File 'lib/mux_ruby/models/update_live_stream_request.rb', line 249

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



92
93
94
95
 
# File 'lib/mux_ruby/models/update_live_stream_request.rb', line 92

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

.openapi_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/mux_ruby/models/update_live_stream_request.rb', line 79

def self.openapi_types
  {
    :'passthrough' => :'String',
    :'latency_mode' => :'String',
    :'reconnect_window' => :'Float',
    :'use_slate_for_standard_latency' => :'Boolean',
    :'reconnect_slate_url' => :'String',
    :'max_continuous_duration' => :'Integer',
    :'new_asset_settings' => :'UpdateLiveStreamNewAssetSettings'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/mux_ruby/models/update_live_stream_request.rb', line 222

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      passthrough == o.passthrough &&
      latency_mode == o.latency_mode &&
      reconnect_window == o.reconnect_window &&
      use_slate_for_standard_latency == o.use_slate_for_standard_latency &&
      reconnect_slate_url == o.reconnect_slate_url &&
      max_continuous_duration == o.max_continuous_duration &&
      new_asset_settings == o.new_asset_settings
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



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

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



350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/mux_ruby/models/update_live_stream_request.rb', line 350

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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/mux_ruby/models/update_live_stream_request.rb', line 256

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


236
237
238
 
# File 'lib/mux_ruby/models/update_live_stream_request.rb', line 236

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



242
243
244
 
# File 'lib/mux_ruby/models/update_live_stream_request.rb', line 242

def hash
  [passthrough, latency_mode, reconnect_window, use_slate_for_standard_latency, reconnect_slate_url, max_continuous_duration, new_asset_settings].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



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/mux_ruby/models/update_live_stream_request.rb', line 149

def list_invalid_properties
  invalid_properties = Array.new
  if !@reconnect_window.nil? && @reconnect_window > 1800
    invalid_properties.push('invalid value for "reconnect_window", must be smaller than or equal to 1800.')
  end

  if !@reconnect_window.nil? && @reconnect_window < 0
    invalid_properties.push('invalid value for "reconnect_window", must be greater than or equal to 0.')
  end

  if !@max_continuous_duration.nil? && @max_continuous_duration > 43200
    invalid_properties.push('invalid value for "max_continuous_duration", must be smaller than or equal to 43200.')
  end

  if !@max_continuous_duration.nil? && @max_continuous_duration < 60
    invalid_properties.push('invalid value for "max_continuous_duration", must be greater than or equal to 60.')
  end

  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



326
327
328
 
# File 'lib/mux_ruby/models/update_live_stream_request.rb', line 326

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



332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/mux_ruby/models/update_live_stream_request.rb', line 332

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



320
321
322
 
# File 'lib/mux_ruby/models/update_live_stream_request.rb', line 320

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



172
173
174
175
176
177
178
179
180
 
# File 'lib/mux_ruby/models/update_live_stream_request.rb', line 172

def valid?
  latency_mode_validator = EnumAttributeValidator.new('String', ["low", "reduced", "standard"])
  return false unless latency_mode_validator.valid?(@latency_mode)
  return false if !@reconnect_window.nil? && @reconnect_window > 1800
  return false if !@reconnect_window.nil? && @reconnect_window < 0
  return false if !@max_continuous_duration.nil? && @max_continuous_duration > 43200
  return false if !@max_continuous_duration.nil? && @max_continuous_duration < 60
  true
end