Class: MuxRuby::CreateTrackRequest

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateTrackRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/mux_ruby/models/create_track_request.rb', line 98

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

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



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

def closed_captions
  @closed_captions
end

#language_code ⇒ Object

The language code value must be a valid BCP 47 specification compliant value. For example, en for English or en-US for the US version of English.



26
27
28
 
# File 'lib/mux_ruby/models/create_track_request.rb', line 26

def language_code
  @language_code
end

#name ⇒ Object

The name of the track containing a human-readable description. This value must be unique within each group of ‘text` or `audio` track types. The HLS manifest will associate the `text` or `audio` track with this value. For example, set the value to "English" for subtitles text track with `language_code` as en-US. If this parameter is not included, Mux will auto-populate a value based on the `language_code` value.



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

def name
  @name
end

#passthrough ⇒ Object

Arbitrary user-supplied metadata set for the track either when creating the asset or track.



35
36
37
 
# File 'lib/mux_ruby/models/create_track_request.rb', line 35

def passthrough
  @passthrough
end

#text_type ⇒ Object

Returns the value of attribute text_type.



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

def text_type
  @text_type
end

#type ⇒ Object

Returns the value of attribute type.



21
22
23
 
# File 'lib/mux_ruby/models/create_track_request.rb', line 21

def type
  @type
end

#url ⇒ Object

The URL of the file that Mux should download and use. * For ‘audio` tracks, the URL is the location of the audio file for Mux to download, for example an M4A, WAV, or MP3 file. Mux supports most audio file formats and codecs, but for fastest processing, you should [use standard inputs wherever possible](docs.mux.com/guides/video/minimize-processing-time). * For `text` tracks, the URL is the location of subtitle/captions file. Mux supports [SubRip Text (SRT)](en.wikipedia.org/wiki/SubRip) and [Web Video Text Tracks](www.w3.org/TR/webvtt1/) formats for ingesting Subtitles and Closed Captions.



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

def url
  @url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'url' => :'url',
    :'type' => :'type',
    :'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



226
227
228
 
# File 'lib/mux_ruby/models/create_track_request.rb', line 226

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



91
92
93
94
 
# File 'lib/mux_ruby/models/create_track_request.rb', line 91

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'url' => :'String',
    :'type' => :'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



199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/mux_ruby/models/create_track_request.rb', line 199

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      url == o.url &&
      type == o.type &&
      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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/mux_ruby/models/create_track_request.rb', line 256

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



327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/mux_ruby/models/create_track_request.rb', line 327

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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/mux_ruby/models/create_track_request.rb', line 233

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


213
214
215
 
# File 'lib/mux_ruby/models/create_track_request.rb', line 213

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



219
220
221
 
# File 'lib/mux_ruby/models/create_track_request.rb', line 219

def hash
  [url, type, 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



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/mux_ruby/models/create_track_request.rb', line 142

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

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

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

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



303
304
305
 
# File 'lib/mux_ruby/models/create_track_request.rb', line 303

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



309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/mux_ruby/models/create_track_request.rb', line 309

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



297
298
299
 
# File 'lib/mux_ruby/models/create_track_request.rb', line 297

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



165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/mux_ruby/models/create_track_request.rb', line 165

def valid?
  return false if @url.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["text", "audio"])
  return false unless type_validator.valid?(@type)
  return false if @text_type.nil?
  text_type_validator = EnumAttributeValidator.new('String', ["subtitles"])
  return false unless text_type_validator.valid?(@text_type)
  return false if @language_code.nil?
  true
end