Class: MuxRuby::InputSettings

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

Overview

An array of objects that each describe an input file to be used to create the asset. As a shortcut, input can also be a string URL for a file when only one input file is used. See input[].url for requirements.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InputSettings

Initializes the object



115
116
117
118
119
120
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
 
# File 'lib/mux_ruby/models/input_settings.rb', line 115

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

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

  if attributes.key?(:'end_time')
    self.end_time = attributes[:'end_time']
  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). This optional parameter should be used for text type and subtitles text type tracks.



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

def closed_captions
  @closed_captions
end

#end_time ⇒ Object

The time offset in seconds from the beginning of the video, indicating the clip’s ending marker. The default value is the duration of the video when not included. This parameter is only applicable for creating clips when input.url has ‘mux://assets/asset_id` format.



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

def end_time
  @end_time
end

#language_code ⇒ Object

The language code value must be a valid [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 required for text type and subtitles text type track.



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

def language_code
  @language_code
end

#name ⇒ Object

The name of the track containing a human-readable description. This value must be unique across all text type and subtitles text type tracks. The hls manifest will associate a subtitle text track with this value. For example, the value should be "English" for subtitles text track with language_code as en. This optional parameter should be used only for text type and subtitles text type track. If this parameter is not included, Mux will auto-populate based on the input[].language_code value.



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

def name
  @name
end

#overlay_settings ⇒ Object

Returns the value of attribute overlay_settings.



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

def overlay_settings
  @overlay_settings
end

#passthrough ⇒ Object

This optional parameter should be used for text type and subtitles text type tracks.



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

def passthrough
  @passthrough
end

#start_time ⇒ Object

The time offset in seconds from the beginning of the video indicating the clip’s starting marker. The default value is 0 when not included. This parameter is only applicable for creating clips when input.url has ‘mux://assets/asset_id` format.



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

def start_time
  @start_time
end

#text_type ⇒ Object

Type of text track. This parameter only supports subtitles value. For more information on Subtitles / Closed Captions, [see this blog post](mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/). This parameter is required for text track type.



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

def text_type
  @text_type
end

#type ⇒ Object

This parameter is required for the text track type.



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

def type
  @type
end

#url ⇒ Object

The web address of the file that Mux should download and use. * For subtitles 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/) format for ingesting Subtitles and Closed Captions. * For Watermarking or Overlay, the url is the location of the watermark image. * When creating clips from existing Mux assets, the url is defined with ‘mux://assets/asset_id` template where asset_id is the Asset Identifier for creating the clip from.



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

def url
  @url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



87
88
89
 
# File 'lib/mux_ruby/models/input_settings.rb', line 87

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/mux_ruby/models/input_settings.rb', line 71

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



238
239
240
 
# File 'lib/mux_ruby/models/input_settings.rb', line 238

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



108
109
110
111
 
# File 'lib/mux_ruby/models/input_settings.rb', line 108

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

.openapi_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/mux_ruby/models/input_settings.rb', line 92

def self.openapi_types
  {
    :'url' => :'String',
    :'overlay_settings' => :'InputSettingsOverlaySettings',
    :'start_time' => :'Float',
    :'end_time' => :'Float',
    :'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.



208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/mux_ruby/models/input_settings.rb', line 208

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



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
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/mux_ruby/models/input_settings.rb', line 268

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



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/mux_ruby/models/input_settings.rb', line 339

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



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

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

See Also:

  • `==` method


225
226
227
 
# File 'lib/mux_ruby/models/input_settings.rb', line 225

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



231
232
233
 
# File 'lib/mux_ruby/models/input_settings.rb', line 231

def hash
  [url, overlay_settings, start_time, end_time, 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?



171
172
173
174
 
# File 'lib/mux_ruby/models/input_settings.rb', line 171

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



315
316
317
 
# File 'lib/mux_ruby/models/input_settings.rb', line 315

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/mux_ruby/models/input_settings.rb', line 321

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



309
310
311
 
# File 'lib/mux_ruby/models/input_settings.rb', line 309

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



178
179
180
181
182
183
184
 
# File 'lib/mux_ruby/models/input_settings.rb', line 178

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