Class: MuxRuby::CreateLiveStreamRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateLiveStreamRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

  if attributes.key?(:'reconnect_window')
    self.reconnect_window = attributes[:'reconnect_window']
  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?(:'reduced_latency')
    self.reduced_latency = attributes[:'reduced_latency']
  end

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

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

Instance Attribute Details

#audio_only ⇒ Object

Force the live stream to only process the audio track when the value is set to true. Mux drops the video track if broadcasted.



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

def audio_only
  @audio_only
end

#new_asset_settings ⇒ Object

Returns the value of attribute new_asset_settings.



20
21
22
 
# File 'lib/mux_ruby/models/create_live_stream_request.rb', line 20

def new_asset_settings
  @new_asset_settings
end

#passthrough ⇒ Object

Returns the value of attribute passthrough.



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

def passthrough
  @passthrough
end

#playback_policy ⇒ Object

Returns the value of attribute playback_policy.



18
19
20
 
# File 'lib/mux_ruby/models/create_live_stream_request.rb', line 18

def playback_policy
  @playback_policy
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. Defaults to 60 seconds on the API if not specified.



23
24
25
 
# File 'lib/mux_ruby/models/create_live_stream_request.rb', line 23

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. Read more here: mux.com/blog/reduced-latency-for-mux-live-streaming-now-available/



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

def reduced_latency
  @reduced_latency
end

#simulcast_targets ⇒ Object

Returns the value of attribute simulcast_targets.



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

def simulcast_targets
  @simulcast_targets
end

#test ⇒ Object

Marks the live stream as a test live stream when the value is set to true. A test live stream can help evaluate the Mux Video APIs without incurring any cost. There is no limit on number of test live streams created. Test live streams 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.



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

def test
  @test
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



53
54
55
 
# File 'lib/mux_ruby/models/create_live_stream_request.rb', line 53

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/mux_ruby/models/create_live_stream_request.rb', line 39

def self.attribute_map
  {
    :'playback_policy' => :'playback_policy',
    :'new_asset_settings' => :'new_asset_settings',
    :'reconnect_window' => :'reconnect_window',
    :'passthrough' => :'passthrough',
    :'audio_only' => :'audio_only',
    :'reduced_latency' => :'reduced_latency',
    :'test' => :'test',
    :'simulcast_targets' => :'simulcast_targets'
  }
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



196
197
198
 
# File 'lib/mux_ruby/models/create_live_stream_request.rb', line 196

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



72
73
74
75
 
# File 'lib/mux_ruby/models/create_live_stream_request.rb', line 72

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

.openapi_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/mux_ruby/models/create_live_stream_request.rb', line 58

def self.openapi_types
  {
    :'playback_policy' => :'Array<PlaybackPolicy>',
    :'new_asset_settings' => :'CreateAssetRequest',
    :'reconnect_window' => :'Float',
    :'passthrough' => :'String',
    :'audio_only' => :'Boolean',
    :'reduced_latency' => :'Boolean',
    :'test' => :'Boolean',
    :'simulcast_targets' => :'Array<CreateSimulcastTargetRequest>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/mux_ruby/models/create_live_stream_request.rb', line 168

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      playback_policy == o.playback_policy &&
      new_asset_settings == o.new_asset_settings &&
      reconnect_window == o.reconnect_window &&
      passthrough == o.passthrough &&
      audio_only == o.audio_only &&
      reduced_latency == o.reduced_latency &&
      test == o.test &&
      simulcast_targets == o.simulcast_targets
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



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

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



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/mux_ruby/models/create_live_stream_request.rb', line 297

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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/mux_ruby/models/create_live_stream_request.rb', line 203

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


183
184
185
 
# File 'lib/mux_ruby/models/create_live_stream_request.rb', line 183

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



189
190
191
 
# File 'lib/mux_ruby/models/create_live_stream_request.rb', line 189

def hash
  [playback_policy, new_asset_settings, reconnect_window, passthrough, audio_only, reduced_latency, test, simulcast_targets].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



131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/mux_ruby/models/create_live_stream_request.rb', line 131

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

  if !@reconnect_window.nil? && @reconnect_window < 0.1
    invalid_properties.push('invalid value for "reconnect_window", must be greater than or equal to 0.1.')
  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



273
274
275
 
# File 'lib/mux_ruby/models/create_live_stream_request.rb', line 273

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



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/mux_ruby/models/create_live_stream_request.rb', line 279

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



267
268
269
 
# File 'lib/mux_ruby/models/create_live_stream_request.rb', line 267

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



146
147
148
149
150
 
# File 'lib/mux_ruby/models/create_live_stream_request.rb', line 146

def valid?
  return false if !@reconnect_window.nil? && @reconnect_window > 300
  return false if !@reconnect_window.nil? && @reconnect_window < 0.1
  true
end