Class: Shotstack::VideoAsset

Inherits:
Object
  • Object
show all
Defined in:
lib/shotstack/models/video_asset.rb

Overview

The VideoAsset is used to create video sequences from video files. The src must be a publicly accessible URL to a video resource such as an mp4 file.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VideoAsset

Initializes the object

Parameters:

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

    Model attributes in the form of hash



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
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
 
# File 'lib/shotstack/models/video_asset.rb', line 100

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

  if attributes.key?(:'src')
    self.src = attributes[:'src']
  else
    self.src = nil
  end

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

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

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

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

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

Instance Attribute Details

#crop ⇒ Object

Returns the value of attribute crop.



37
38
39
 
# File 'lib/shotstack/models/video_asset.rb', line 37

def crop
  @crop
end

#speed ⇒ Object

Adjust the playback speed of the video clip between 0 (paused) and 10 (10x normal speed) where 1 is normal speed (defaults to 1). Adjusting the speed will also adjust the duration of the clip and may require you to adjust the Clip length. For example, if you set speed to 0.5, the clip will need to be 2x as long to play the entire video (i.e. original length / 0.5). If you set speed to 2, the clip will need to be half as long to play the entire video (i.e. original length / 2).



35
36
37
 
# File 'lib/shotstack/models/video_asset.rb', line 35

def speed
  @speed
end

#src ⇒ Object

The video source URL. The URL must be publicly accessible or include credentials.



23
24
25
 
# File 'lib/shotstack/models/video_asset.rb', line 23

def src
  @src
end

#trim ⇒ Object

The start trim point of the video clip, in seconds (defaults to 0). Videos will start from the in trim point. The video will play until the file ends or the Clip length is reached.



26
27
28
 
# File 'lib/shotstack/models/video_asset.rb', line 26

def trim
  @trim
end

#type ⇒ Object

The type of asset - set to ‘video` for videos.



20
21
22
 
# File 'lib/shotstack/models/video_asset.rb', line 20

def type
  @type
end

#volume ⇒ Object

Set the volume for the video clip between 0 and 1 where 0 is muted and 1 is full volume (defaults to 1).



29
30
31
 
# File 'lib/shotstack/models/video_asset.rb', line 29

def volume
  @volume
end

#volume_effect ⇒ Object

The volume effect to apply to the video 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>



32
33
34
 
# File 'lib/shotstack/models/video_asset.rb', line 32

def volume_effect
  @volume_effect
end

Class Method Details

._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



264
265
266
267
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
 
# File 'lib/shotstack/models/video_asset.rb', line 264

def self._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_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/shotstack/models/video_asset.rb', line 75

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/shotstack/models/video_asset.rb', line 62

def self.attribute_map
  {
    :'type' => :'type',
    :'src' => :'src',
    :'trim' => :'trim',
    :'volume' => :'volume',
    :'volume_effect' => :'volumeEffect',
    :'speed' => :'speed',
    :'crop' => :'crop'
  }
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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/shotstack/models/video_asset.rb', line 240

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



93
94
95
96
 
# File 'lib/shotstack/models/video_asset.rb', line 93

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

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/shotstack/models/video_asset.rb', line 80

def self.openapi_types
  {
    :'type' => :'String',
    :'src' => :'String',
    :'trim' => :'Float',
    :'volume' => :'Float',
    :'volume_effect' => :'String',
    :'speed' => :'Float',
    :'crop' => :'Crop'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/shotstack/models/video_asset.rb', line 213

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      src == o.src &&
      trim == o.trim &&
      volume == o.volume &&
      volume_effect == o.volume_effect &&
      speed == o.speed &&
      crop == o.crop
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



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/shotstack/models/video_asset.rb', line 335

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


227
228
229
 
# File 'lib/shotstack/models/video_asset.rb', line 227

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



233
234
235
 
# File 'lib/shotstack/models/video_asset.rb', line 233

def hash
  [type, src, trim, volume, volume_effect, speed, crop].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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/shotstack/models/video_asset.rb', line 148

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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

  if !@speed.nil? && @speed > 10
    invalid_properties.push('invalid value for "speed", must be smaller than or equal to 10.')
  end

  if !@speed.nil? && @speed < 0
    invalid_properties.push('invalid value for "speed", must be greater than or equal to 0.')
  end

  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



311
312
313
 
# File 'lib/shotstack/models/video_asset.rb', line 311

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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/shotstack/models/video_asset.rb', line 317

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



305
306
307
 
# File 'lib/shotstack/models/video_asset.rb', line 305

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



172
173
174
175
176
177
178
179
180
181
 
# File 'lib/shotstack/models/video_asset.rb', line 172

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @type.nil?
  return false if @src.nil?
  volume_effect_validator = EnumAttributeValidator.new('String', ["fadeIn", "fadeOut", "fadeInFadeOut"])
  return false unless volume_effect_validator.valid?(@volume_effect)
  return false if !@speed.nil? && @speed > 10
  return false if !@speed.nil? && @speed < 0
  true
end