Class: MuxRuby::Broadcast

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Broadcast

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

  if attributes.key?(:'layout')
    self.layout = attributes[:'layout']
  else
    self.layout = 'gallery'
  end

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

  if attributes.key?(:'resolution')
    self.resolution = attributes[:'resolution']
  else
    self.resolution = '1920x1080'
  end
end

Instance Attribute Details

#background ⇒ Object

URL of an image to display as the background of the broadcast. Its dimensions should match the provided resolution.



32
33
34
 
# File 'lib/mux_ruby/models/broadcast.rb', line 32

def background
  @background
end

#id ⇒ Object

Unique identifier for the broadcast. Max 255 characters.



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

def id
  @id
end

#layout ⇒ Object

Returns the value of attribute layout.



29
30
31
 
# File 'lib/mux_ruby/models/broadcast.rb', line 29

def layout
  @layout
end

#live_stream_id ⇒ Object

The ID of the live stream that the broadcast will be sent to.



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

def live_stream_id
  @live_stream_id
end

#passthrough ⇒ Object

Arbitrary user-supplied metadata that will be included in the broadcast details and related webhooks. Max: 255 characters.



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

def passthrough
  @passthrough
end

#resolution ⇒ Object

Returns the value of attribute resolution.



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

def resolution
  @resolution
end

#status ⇒ Object

Returns the value of attribute status.



27
28
29
 
# File 'lib/mux_ruby/models/broadcast.rb', line 27

def status
  @status
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



50
51
52
 
# File 'lib/mux_ruby/models/broadcast.rb', line 50

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/mux_ruby/models/broadcast.rb', line 37

def self.attribute_map
  {
    :'id' => :'id',
    :'passthrough' => :'passthrough',
    :'live_stream_id' => :'live_stream_id',
    :'status' => :'status',
    :'layout' => :'layout',
    :'background' => :'background',
    :'resolution' => :'resolution'
  }
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



188
189
190
 
# File 'lib/mux_ruby/models/broadcast.rb', line 188

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



68
69
70
71
 
# File 'lib/mux_ruby/models/broadcast.rb', line 68

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

.openapi_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/mux_ruby/models/broadcast.rb', line 55

def self.openapi_types
  {
    :'id' => :'String',
    :'passthrough' => :'String',
    :'live_stream_id' => :'String',
    :'status' => :'BroadcastStatus',
    :'layout' => :'BroadcastLayout',
    :'background' => :'String',
    :'resolution' => :'BroadcastResolution'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/mux_ruby/models/broadcast.rb', line 161

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      passthrough == o.passthrough &&
      live_stream_id == o.live_stream_id &&
      status == o.status &&
      layout == o.layout &&
      background == o.background &&
      resolution == o.resolution
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



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

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



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/mux_ruby/models/broadcast.rb', line 289

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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/mux_ruby/models/broadcast.rb', line 195

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


175
176
177
 
# File 'lib/mux_ruby/models/broadcast.rb', line 175

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



181
182
183
 
# File 'lib/mux_ruby/models/broadcast.rb', line 181

def hash
  [id, passthrough, live_stream_id, status, layout, background, resolution].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



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/mux_ruby/models/broadcast.rb', line 123

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @live_stream_id.nil?
    invalid_properties.push('invalid value for "live_stream_id", live_stream_id cannot be nil.')
  end

  if @status.nil?
    invalid_properties.push('invalid value for "status", status cannot be nil.')
  end

  if @layout.nil?
    invalid_properties.push('invalid value for "layout", layout cannot be nil.')
  end

  if @resolution.nil?
    invalid_properties.push('invalid value for "resolution", resolution cannot be nil.')
  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



265
266
267
 
# File 'lib/mux_ruby/models/broadcast.rb', line 265

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



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/mux_ruby/models/broadcast.rb', line 271

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



259
260
261
 
# File 'lib/mux_ruby/models/broadcast.rb', line 259

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



150
151
152
153
154
155
156
157
 
# File 'lib/mux_ruby/models/broadcast.rb', line 150

def valid?
  return false if @id.nil?
  return false if @live_stream_id.nil?
  return false if @status.nil?
  return false if @layout.nil?
  return false if @resolution.nil?
  true
end