class Shotstack::AudioAsset
The AudioAsset
is used to add sound effects and audio at specific intervals on the timeline. The src must be a publicly accessible URL to an audio resource such as an mp3 file.
Attributes
The effect to apply to the audio asset <ul> <li>`fadeIn` - fade volume in only</li> <li>`fadeOut` - fade volume out only</li> <li>`fadeInFadeOut` - fade volume in and out</li> </ul>
The audio source URL. The URL must be publicly accessible or include credentials.
The start trim point of the audio clip, in seconds (defaults to 0). Audio will start from the in trim point. The audio will play until the file ends or the Clip
length is reached.
The type of asset - set to `audio` for audio assets.
Set the volume for the audio clip between 0 and 1 where 0 is muted and 1 is full volume (defaults to 1).
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/shotstack/models/audio_asset.rb, line 69 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/shotstack/models/audio_asset.rb, line 58 def self.attribute_map { :'type' => :'type', :'src' => :'src', :'trim' => :'trim', :'volume' => :'volume', :'effect' => :'effect' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/shotstack/models/audio_asset.rb, line 192 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/shotstack/models/audio_asset.rb, line 92 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Shotstack::AudioAsset` 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 `Shotstack::AudioAsset`. 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?(:'type') self.type = attributes[:'type'] else self.type = 'audio' end if attributes.key?(:'src') self.src = attributes[:'src'] end if attributes.key?(:'trim') self.trim = attributes[:'trim'] end if attributes.key?(:'volume') self.volume = attributes[:'volume'] else self.volume = 1 end if attributes.key?(:'effect') self.effect = attributes[:'effect'] end end
List of attributes with nullable: true
# File lib/shotstack/models/audio_asset.rb, line 85 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/shotstack/models/audio_asset.rb, line 74 def self.openapi_types { :'type' => :'String', :'src' => :'String', :'trim' => :'Float', :'volume' => :'Float', :'effect' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/shotstack/models/audio_asset.rb, line 167 def ==(o) return true if self.equal?(o) self.class == o.class && type == o.type && src == o.src && trim == o.trim && volume == o.volume && effect == o.effect end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/shotstack/models/audio_asset.rb, line 222 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 = Shotstack.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end 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
# File lib/shotstack/models/audio_asset.rb, line 293 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/shotstack/models/audio_asset.rb, line 199 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
Custom attribute writer method checking allowed values (enum). @param [Object] effect Object to be assigned
# File lib/shotstack/models/audio_asset.rb, line 157 def effect=(effect) validator = EnumAttributeValidator.new('String', ["fadeIn", "fadeOut", "fadeInFadeOut"]) unless validator.valid?(effect) fail ArgumentError, "invalid value for \"effect\", must be one of #{validator.allowable_values}." end @effect = effect end
@see the `==` method @param [Object] Object to be compared
# File lib/shotstack/models/audio_asset.rb, line 179 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/shotstack/models/audio_asset.rb, line 185 def hash [type, src, trim, volume, effect].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/shotstack/models/audio_asset.rb, line 132 def list_invalid_properties invalid_properties = Array.new if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end if @src.nil? invalid_properties.push('invalid value for "src", src cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/shotstack/models/audio_asset.rb, line 275 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/shotstack/models/audio_asset.rb, line 263 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/shotstack/models/audio_asset.rb, line 147 def valid? return false if @type.nil? return false if @src.nil? effect_validator = EnumAttributeValidator.new('String', ["fadeIn", "fadeOut", "fadeInFadeOut"]) return false unless effect_validator.valid?(@effect) true end