Class: MuxRuby::AssetNonStandardInputReasons

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

Overview

An object containing one or more reasons the input file is non-standard. See [the guide on minimizing processing time](docs.mux.com/guides/minimize-processing-time) for more information on what a standard input is defined as. This object only exists on on-demand assets that have non-standard inputs, so if missing you can assume the input qualifies as standard.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AssetNonStandardInputReasons

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#audio_codec ⇒ Object

The audio codec used on the input file. Non-AAC audio codecs are non-standard.



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

def audio_codec
  @audio_codec
end

#audio_edit_list ⇒ Object

Audio Edit List reason indicates that the input file’s audio track contains a complex Edit Decision List.



44
45
46
 
# File 'lib/mux_ruby/models/asset_non_standard_input_reasons.rb', line 44

def audio_edit_list
  @audio_edit_list
end

#pixel_aspect_ratio ⇒ Object

The video pixel aspect ratio of the input file.



38
39
40
 
# File 'lib/mux_ruby/models/asset_non_standard_input_reasons.rb', line 38

def pixel_aspect_ratio
  @pixel_aspect_ratio
end

#unexpected_media_file_parameters ⇒ Object

A catch-all reason when the input file in created with non-standard encoding parameters.



47
48
49
 
# File 'lib/mux_ruby/models/asset_non_standard_input_reasons.rb', line 47

def unexpected_media_file_parameters
  @unexpected_media_file_parameters
end

#unsupported_pixel_format ⇒ Object

The video pixel format, as a string, returned by libav. Considered non-standard if not one of yuv420p or yuvj420p.



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

def unsupported_pixel_format
  @unsupported_pixel_format
end

#video_bitrate ⇒ Object

The video bitrate of the input file is ‘high`. This parameter is present when the average bitrate of any key frame interval (also known as Group of Pictures or GOP) is higher than what’s considered standard which typically is 16 Mbps.



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

def video_bitrate
  @video_bitrate
end

#video_codec ⇒ Object

The video codec used on the input file. For example, the input file encoded with ‘hevc` video codec is non-standard and the value of this parameter is `hevc`.



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

def video_codec
  @video_codec
end

#video_edit_list ⇒ Object

Video Edit List reason indicates that the input file’s video track contains a complex Edit Decision List.



41
42
43
 
# File 'lib/mux_ruby/models/asset_non_standard_input_reasons.rb', line 41

def video_edit_list
  @video_edit_list
end

#video_frame_rate ⇒ Object

The video frame rate of the input file. Video with average frames per second (fps) less than 5 or greater than 120 is non-standard. A ‘-1` frame rate value indicates Mux could not determine the frame rate of the video track.



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

def video_frame_rate
  @video_frame_rate
end

#video_gop_size ⇒ Object

The video key frame Interval (also called as Group of Picture or GOP) of the input file is ‘high`. This parameter is present when the gop is greater than 20 seconds.



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

def video_gop_size
  @video_gop_size
end

#video_resolution ⇒ Object

The video resolution of the input file. Video resolution higher than 2048 pixels on any one dimension (height or width) is considered non-standard, The resolution value is presented as ‘width` x `height` in pixels.



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

def video_resolution
  @video_resolution
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/mux_ruby/models/asset_non_standard_input_reasons.rb', line 75

def self.attribute_map
  {
    :'video_codec' => :'video_codec',
    :'audio_codec' => :'audio_codec',
    :'video_gop_size' => :'video_gop_size',
    :'video_frame_rate' => :'video_frame_rate',
    :'video_resolution' => :'video_resolution',
    :'video_bitrate' => :'video_bitrate',
    :'pixel_aspect_ratio' => :'pixel_aspect_ratio',
    :'video_edit_list' => :'video_edit_list',
    :'audio_edit_list' => :'audio_edit_list',
    :'unexpected_media_file_parameters' => :'unexpected_media_file_parameters',
    :'unsupported_pixel_format' => :'unsupported_pixel_format'
  }
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



285
286
287
 
# File 'lib/mux_ruby/models/asset_non_standard_input_reasons.rb', line 285

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



114
115
116
117
 
# File 'lib/mux_ruby/models/asset_non_standard_input_reasons.rb', line 114

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

.openapi_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/mux_ruby/models/asset_non_standard_input_reasons.rb', line 97

def self.openapi_types
  {
    :'video_codec' => :'String',
    :'audio_codec' => :'String',
    :'video_gop_size' => :'String',
    :'video_frame_rate' => :'String',
    :'video_resolution' => :'String',
    :'video_bitrate' => :'String',
    :'pixel_aspect_ratio' => :'String',
    :'video_edit_list' => :'String',
    :'audio_edit_list' => :'String',
    :'unexpected_media_file_parameters' => :'String',
    :'unsupported_pixel_format' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/mux_ruby/models/asset_non_standard_input_reasons.rb', line 254

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      video_codec == o.video_codec &&
      audio_codec == o.audio_codec &&
      video_gop_size == o.video_gop_size &&
      video_frame_rate == o.video_frame_rate &&
      video_resolution == o.video_resolution &&
      video_bitrate == o.video_bitrate &&
      pixel_aspect_ratio == o.pixel_aspect_ratio &&
      video_edit_list == o.video_edit_list &&
      audio_edit_list == o.audio_edit_list &&
      unexpected_media_file_parameters == o.unexpected_media_file_parameters &&
      unsupported_pixel_format == o.unsupported_pixel_format
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



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
348
349
350
351
352
 
# File 'lib/mux_ruby/models/asset_non_standard_input_reasons.rb', line 315

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



386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/mux_ruby/models/asset_non_standard_input_reasons.rb', line 386

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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/mux_ruby/models/asset_non_standard_input_reasons.rb', line 292

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


272
273
274
 
# File 'lib/mux_ruby/models/asset_non_standard_input_reasons.rb', line 272

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



278
279
280
 
# File 'lib/mux_ruby/models/asset_non_standard_input_reasons.rb', line 278

def hash
  [video_codec, audio_codec, video_gop_size, video_frame_rate, video_resolution, video_bitrate, pixel_aspect_ratio, video_edit_list, audio_edit_list, unexpected_media_file_parameters, unsupported_pixel_format].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



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

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



362
363
364
 
# File 'lib/mux_ruby/models/asset_non_standard_input_reasons.rb', line 362

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



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/mux_ruby/models/asset_non_standard_input_reasons.rb', line 368

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



356
357
358
 
# File 'lib/mux_ruby/models/asset_non_standard_input_reasons.rb', line 356

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



188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/mux_ruby/models/asset_non_standard_input_reasons.rb', line 188

def valid?
  video_gop_size_validator = EnumAttributeValidator.new('String', ["high"])
  return false unless video_gop_size_validator.valid?(@video_gop_size)
  video_bitrate_validator = EnumAttributeValidator.new('String', ["high"])
  return false unless video_bitrate_validator.valid?(@video_bitrate)
  video_edit_list_validator = EnumAttributeValidator.new('String', ["non-standard"])
  return false unless video_edit_list_validator.valid?(@video_edit_list)
  audio_edit_list_validator = EnumAttributeValidator.new('String', ["non-standard"])
  return false unless audio_edit_list_validator.valid?(@audio_edit_list)
  unexpected_media_file_parameters_validator = EnumAttributeValidator.new('String', ["non-standard"])
  return false unless unexpected_media_file_parameters_validator.valid?(@unexpected_media_file_parameters)
  true
end