class MuxRuby::InputSettings

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.

Attributes

closed_captions[RW]

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.

end_time[RW]

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.

language_code[RW]

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.

name[RW]

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.

overlay_settings[RW]
passthrough[RW]

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

start_time[RW]

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.

text_type[RW]

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.

type[RW]

This parameter is required for the `text` track type.

url[RW]

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.

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/mux_ruby/models/input_settings.rb, line 87
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/mux_ruby/models/input_settings.rb, line 238
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/mux_ruby/models/input_settings.rb, line 108
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/mux_ruby/models/input_settings.rb, line 225
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/mux_ruby/models/input_settings.rb, line 171
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
text_type=(text_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] text_type Object to be assigned

# File lib/mux_ruby/models/input_settings.rb, line 198
def text_type=(text_type)
  validator = EnumAttributeValidator.new('String', ["subtitles"])
  unless validator.valid?(text_type)
    fail ArgumentError, "invalid value for \"text_type\", must be one of #{validator.allowable_values}."
  end
  @text_type = text_type
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/mux_ruby/models/input_settings.rb, line 315
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/mux_ruby/models/input_settings.rb, line 309
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned

# File lib/mux_ruby/models/input_settings.rb, line 188
def type=(type)
  validator = EnumAttributeValidator.new('String', ["video", "audio", "text"])
  unless validator.valid?(type)
    fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
  end
  @type = type
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# 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