mux_ruby 1.8.1 → 1.9.0

data/lib/mux_ruby/models/get_asset_or_live_stream_id_response_data_object.rb

@@ -0,0 +1,230 @@
+=begin
+# Mux Ruby - Copyright 2019 Mux Inc.
+# NOTE: This file is auto generated. Do not edit this file manually.
+=end
+
+require 'date'
+
+module MuxRuby
+  # Describes the Asset or LiveStream object associated with the playback ID.
+  class GetAssetOrLiveStreamIdResponseDataObject
+    # The identifier of the object.
+    attr_accessor :id
+
+    # Identifies the object type associated with the playback ID.
+    attr_accessor :type
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'type' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'type')
+        self.type = attributes[:'type']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      type_validator = EnumAttributeValidator.new('String', ['asset', 'live_stream'])
+      return false unless type_validator.valid?(@type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ['asset', 'live_stream'])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          type == o.type
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [id, type].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.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
+        MuxRuby.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # 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
+    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
+
+  end
+
+end

data/lib/mux_ruby/models/input_settings.rb

@@ -6,22 +6,35 @@
 require 'date'
 
 module MuxRuby
-  # Input object with additional configuration
+  # 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.
   class InputSettings
+    # 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)](https://en.wikipedia.org/wiki/SubRip) and [Web Video Text Tracks](https://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. 
     attr_accessor :url
 
     attr_accessor :overlay_settings
 
+    # 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.
+    attr_accessor :start_time
+
+    # 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.
+    attr_accessor :end_time
+
+    # This parameter is required for the `text` track type.
     attr_accessor :type
 
+    # Type of text track. This parameter only supports subtitles value. For more information on Subtitles / Closed Captions, [see this blog post](https://mux.com/blog/subtitles-captions-webvtt-hls-and-those-magic-flags/). This parameter is required for `text` track type.
     attr_accessor :text_type
 
+    # The language code value must be a valid [BCP 47](https://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.
     attr_accessor :language_code
 
+    # 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.
     attr_accessor :name
 
+    # 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.
     attr_accessor :closed_captions
 
+    # This optional parameter should be used for `text` type and subtitles `text` type tracks.
     attr_accessor :passthrough
 
     class EnumAttributeValidator
@@ -51,6 +64,8 @@ module MuxRuby
       {
         :'url' => :'url',
         :'overlay_settings' => :'overlay_settings',
+        :'start_time' => :'start_time',
+        :'end_time' => :'end_time',
         :'type' => :'type',
         :'text_type' => :'text_type',
         :'language_code' => :'language_code',
@@ -65,6 +80,8 @@ module MuxRuby
       {
         :'url' => :'String',
         :'overlay_settings' => :'InputSettingsOverlaySettings',
+        :'start_time' => :'Float',
+        :'end_time' => :'Float',
         :'type' => :'String',
         :'text_type' => :'String',
         :'language_code' => :'String',
@@ -90,6 +107,14 @@ module MuxRuby
         self.overlay_settings = attributes[:'overlay_settings']
       end
 
+      if attributes.has_key?(:'start_time')
+        self.start_time = attributes[:'start_time']
+      end
+
+      if attributes.has_key?(:'end_time')
+        self.end_time = attributes[:'end_time']
+      end
+
       if attributes.has_key?(:'type')
         self.type = attributes[:'type']
       end
@@ -137,7 +162,7 @@ module MuxRuby
     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}.'
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end
       @type = type
     end
@@ -147,7 +172,7 @@ module MuxRuby
     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}.'
+        fail ArgumentError, "invalid value for \"text_type\", must be one of #{validator.allowable_values}."
       end
       @text_type = text_type
     end
@@ -159,6 +184,8 @@ module MuxRuby
       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 &&
@@ -176,7 +203,7 @@ module MuxRuby
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [url, overlay_settings, type, text_type, language_code, name, closed_captions, passthrough].hash
+      [url, overlay_settings, start_time, end_time, type, text_type, language_code, name, closed_captions, passthrough].hash
     end
 
     # Builds the object from hash

data/lib/mux_ruby/models/input_settings_overlay_settings.rb

@@ -6,19 +6,27 @@
 require 'date'
 
 module MuxRuby
+  # An object that describes how the image file referenced in url should be placed over the video (i.e. watermarking).
   class InputSettingsOverlaySettings
+    # Where the vertical positioning of the overlay/watermark should begin from. Defaults to `\"top\"`
     attr_accessor :vertical_align
 
+    # The distance from the vertical_align starting point and the image's closest edge. Can be expressed as a percent (\"10%\") or as a pixel value (\"100px\"). Negative values will move the overlay offscreen. In the case of 'middle', a positive value will shift the overlay towards the bottom and and a negative value will shift it towards the top.
     attr_accessor :vertical_margin
 
+    # Where the horizontal positioning of the overlay/watermark should begin from.
     attr_accessor :horizontal_align
 
+    # The distance from the horizontal_align starting point and the image's closest edge. Can be expressed as a percent (\"10%\") or as a pixel value (\"100px\"). Negative values will move the overlay offscreen. In the case of 'center', a positive value will shift the image towards the right and and a negative value will shift it towards the left.
     attr_accessor :horizontal_margin
 
+    # How wide the overlay should appear. Can be expressed as a percent (\"10%\") or as a pixel value (\"100px\"). If both width and height are left blank the width will be the true pixels of the image, applied as if the video has been scaled to fit a 1920x1080 frame. If height is supplied with no width, the width will scale proportionally to the height.
     attr_accessor :width
 
+    # How tall the overlay should appear. Can be expressed as a percent (\"10%\") or as a pixel value (\"100px\"). If both width and height are left blank the height will be the true pixels of the image, applied as if the video has been scaled to fit a 1920x1080 frame. If width is supplied with no height, the height will scale proportionally to the width.
     attr_accessor :height
 
+    # How opaque the overlay should appear, expressed as a percent. (Default 100%)
     attr_accessor :opacity
 
     class EnumAttributeValidator
@@ -128,7 +136,7 @@ module MuxRuby
     def vertical_align=(vertical_align)
       validator = EnumAttributeValidator.new('String', ['top', 'middle', 'bottom'])
       unless validator.valid?(vertical_align)
-        fail ArgumentError, 'invalid value for "vertical_align", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"vertical_align\", must be one of #{validator.allowable_values}."
       end
       @vertical_align = vertical_align
     end
@@ -138,7 +146,7 @@ module MuxRuby
     def horizontal_align=(horizontal_align)
       validator = EnumAttributeValidator.new('String', ['left', 'center', 'right'])
       unless validator.valid?(horizontal_align)
-        fail ArgumentError, 'invalid value for "horizontal_align", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"horizontal_align\", must be one of #{validator.allowable_values}."
       end
       @horizontal_align = horizontal_align
     end

data/lib/mux_ruby/models/playback_id.rb

@@ -7,6 +7,7 @@ require 'date'
 
 module MuxRuby
   class PlaybackID
+    # Unique identifier for the PlaybackID
     attr_accessor :id
 
     attr_accessor :policy

data/lib/mux_ruby/models/simulcast_target.rb

@@ -115,7 +115,7 @@ module MuxRuby
     def status=(status)
       validator = EnumAttributeValidator.new('String', ['idle', 'starting', 'broadcasting', 'errored'])
       unless validator.valid?(status)
-        fail ArgumentError, 'invalid value for "status", must be one of #{validator.allowable_values}.'
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
       end
       @status = status
     end

data/lib/mux_ruby/models/track.rb

@@ -7,30 +7,43 @@ require 'date'
 
 module MuxRuby
   class Track
+    # Unique identifier for the Track
     attr_accessor :id
 
+    # The type of track
     attr_accessor :type
 
+    # 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.
     attr_accessor :duration
 
+    # The maximum width in pixels available for the track. Only set for the `video` type track.
     attr_accessor :max_width
 
+    # The maximum height in pixels available for the track. Only set for the `video` type track.
     attr_accessor :max_height
 
+    # 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.
     attr_accessor :max_frame_rate
 
+    # The maximum number of audio channels the track supports. Only set for the `audio` type track.
     attr_accessor :max_channels
 
+    # Only set for the `audio` type track.
     attr_accessor :max_channel_layout
 
+    # This parameter is set only for the `text` type track.
     attr_accessor :text_type
 
+    # The language code value represents [BCP 47](https://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.
     attr_accessor :language_code
 
+    # 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.
     attr_accessor :name
 
+    # 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.
     attr_accessor :closed_captions
 
+    # 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.
     attr_accessor :passthrough
 
     class EnumAttributeValidator
@@ -166,6 +179,8 @@ module MuxRuby
     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
@@ -176,17 +191,27 @@ module MuxRuby
     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}.'
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end
       @type = type
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] max_channel_layout Object to be assigned
+    def max_channel_layout=(max_channel_layout)
+      validator = EnumAttributeValidator.new('String', ['mono', 'stereo', '5.2', '7.1'])
+      unless validator.valid?(max_channel_layout)
+        fail ArgumentError, "invalid value for \"max_channel_layout\", must be one of #{validator.allowable_values}."
+      end
+      @max_channel_layout = max_channel_layout
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] text_type Object to be assigned
     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}.'
+        fail ArgumentError, "invalid value for \"text_type\", must be one of #{validator.allowable_values}."
       end
       @text_type = text_type
     end