Class: MuxRuby::Track

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Track

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#closed_captions ⇒ Object

Indicates the track provides Subtitles for the Deaf or Hard-of-hearing (SDH). This parameter is set for the text type and subtitles text type track.



52
53
54
 
# File 'lib/mux_ruby/models/track.rb', line 52

def closed_captions
  @closed_captions
end

#duration ⇒ Object

The duration in seconds of the track media. This parameter is not set for the text type track. This field is optional and may not be set. The top level duration field of an asset will always be set.



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

def duration
  @duration
end

#id ⇒ Object

Unique identifier for the Track



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

def id
  @id
end

#language_code ⇒ Object

The language code value represents [BCP 47](tools.ietf.org/html/bcp47) specification compliant value. For example, en for English or en-US for the US version of English. This parameter is set for text type and subtitles text type track.



46
47
48
 
# File 'lib/mux_ruby/models/track.rb', line 46

def language_code
  @language_code
end

#max_channel_layout ⇒ Object

Only set for the audio type track.



40
41
42
 
# File 'lib/mux_ruby/models/track.rb', line 40

def max_channel_layout
  @max_channel_layout
end

#max_channels ⇒ Object

The maximum number of audio channels the track supports. Only set for the audio type track.



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

def max_channels
  @max_channels
end

#max_frame_rate ⇒ Object

The maximum frame rate available for the track. Only set for the video type track. This field may return -1 if the frame rate of the input cannot be reliably determined.



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

def max_frame_rate
  @max_frame_rate
end

#max_height ⇒ Object

The maximum height in pixels available for the track. Only set for the video type track.



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

def max_height
  @max_height
end

#max_width ⇒ Object

The maximum width in pixels available for the track. Only set for the video type track.



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

def max_width
  @max_width
end

#name ⇒ Object

The name of the track containing a human-readable description. The hls manifest will associate a subtitle text track with this value. For example, the value is "English" for subtitles text track for the language_code value of en-US. This parameter is set for the text type and subtitles text type track.



49
50
51
 
# File 'lib/mux_ruby/models/track.rb', line 49

def name
  @name
end

#passthrough ⇒ Object

Arbitrary metadata set for the track either when creating the asset or track. This parameter is set for text type and subtitles text type track. Max 255 characters.



55
56
57
 
# File 'lib/mux_ruby/models/track.rb', line 55

def passthrough
  @passthrough
end

#text_type ⇒ Object

This parameter is set only for the text type track.



43
44
45
 
# File 'lib/mux_ruby/models/track.rb', line 43

def text_type
  @text_type
end

#type ⇒ Object

The type of track



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

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



99
100
101
 
# File 'lib/mux_ruby/models/track.rb', line 99

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/mux_ruby/models/track.rb', line 80

def self.attribute_map
  {
    :'id' => :'id',
    :'type' => :'type',
    :'duration' => :'duration',
    :'max_width' => :'max_width',
    :'max_height' => :'max_height',
    :'max_frame_rate' => :'max_frame_rate',
    :'max_channels' => :'max_channels',
    :'max_channel_layout' => :'max_channel_layout',
    :'text_type' => :'text_type',
    :'language_code' => :'language_code',
    :'name' => :'name',
    :'closed_captions' => :'closed_captions',
    :'passthrough' => :'passthrough'
  }
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



280
281
282
 
# File 'lib/mux_ruby/models/track.rb', line 280

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



123
124
125
126
 
# File 'lib/mux_ruby/models/track.rb', line 123

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

.openapi_types ⇒ Object

Attribute type mapping.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/mux_ruby/models/track.rb', line 104

def self.openapi_types
  {
    :'id' => :'String',
    :'type' => :'String',
    :'duration' => :'Float',
    :'max_width' => :'Integer',
    :'max_height' => :'Integer',
    :'max_frame_rate' => :'Float',
    :'max_channels' => :'Integer',
    :'max_channel_layout' => :'String',
    :'text_type' => :'String',
    :'language_code' => :'String',
    :'name' => :'String',
    :'closed_captions' => :'Boolean',
    :'passthrough' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      type == o.type &&
      duration == o.duration &&
      max_width == o.max_width &&
      max_height == o.max_height &&
      max_frame_rate == o.max_frame_rate &&
      max_channels == o.max_channels &&
      max_channel_layout == o.max_channel_layout &&
      text_type == o.text_type &&
      language_code == o.language_code &&
      name == o.name &&
      closed_captions == o.closed_captions &&
      passthrough == o.passthrough
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



310
311
312
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
 
# File 'lib/mux_ruby/models/track.rb', line 310

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



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/mux_ruby/models/track.rb', line 381

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



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/mux_ruby/models/track.rb', line 287

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [id, type, duration, max_width, max_height, max_frame_rate, max_channels, max_channel_layout, text_type, language_code, name, closed_captions, passthrough].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



198
199
200
201
 
# File 'lib/mux_ruby/models/track.rb', line 198

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



357
358
359
 
# File 'lib/mux_ruby/models/track.rb', line 357

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



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/mux_ruby/models/track.rb', line 363

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



351
352
353
 
# File 'lib/mux_ruby/models/track.rb', line 351

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



205
206
207
208
209
210
211
212
213
 
# File 'lib/mux_ruby/models/track.rb', line 205

def valid?
  type_validator = EnumAttributeValidator.new('String', ["video", "audio", "text"])
  return false unless type_validator.valid?(@type)
  max_channel_layout_validator = EnumAttributeValidator.new('String', ["mono", "stereo", "5.2", "7.1"])
  return false unless max_channel_layout_validator.valid?(@max_channel_layout)
  text_type_validator = EnumAttributeValidator.new('String', ["subtitles"])
  return false unless text_type_validator.valid?(@text_type)
  true
end