Class: Shotstack::Clip

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

Overview

A clip is a container for a specific type of asset, i.e. a title, image, video, audio or html. You use a Clip to define when an asset will display on the timeline, how long it will play for and transitions, filters and effects to apply to it.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Clip

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/shotstack/models/clip.rb', line 113

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

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

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

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

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

  if attributes.key?(:'position')
    self.position = attributes[:'position']
  else
    self.position = 'center'
  end

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

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

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

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

  if attributes.key?(:'opacity')
    self.opacity = attributes[:'opacity']
  else
    self.opacity = 1
  end
end

Instance Attribute Details

#asset ⇒ Object

The type of asset to display for the duration of this Clip. Value must be one of TitleAsset, ImageAsset, VideoAsset, HtmlAsset, AudioAsset or LumaAsset



19
20
21
 
# File 'lib/shotstack/models/clip.rb', line 19

def asset
  @asset
end

#effect ⇒ Object

A motion effect to apply to the Clip. <ul> <li>zoomIn - slow zoom in</li> <li>zoomOut - slow zoom out</li> <li>slideLeft - slow slide (pan) left</li> <li>slideRight - slow slide (pan) right</li> <li>slideUp - slow slide (pan) up</li> <li>slideDown - slow slide (pan) down</li> </ul>



41
42
43
 
# File 'lib/shotstack/models/clip.rb', line 41

def effect
  @effect
end

#filter ⇒ Object

A filter effect to apply to the Clip. <ul> <li>blur - blurs the image or video</li> <li>boost - boost contrast and saturation</li> <li>contrast - increase contrast</li> <li>darken - darken the scene</li> <li>greyscale - remove colour</li> <li>lighten - lighten the scene</li> <li>muted - reduce saturation and contrast</li> <li>invert - invert colors</li> </ul>



44
45
46
 
# File 'lib/shotstack/models/clip.rb', line 44

def filter
  @filter
end

#fit ⇒ Object

Set how the asset should be scaled to fit the viewport using one of the following options: <ul> <li>cover - stretch the asset to fill the viewport without maintaining the aspect ratio.</li> <li>contain - fit the entire asset within the viewport while maintaining the original aspect ratio.</li> <li>crop - scale the asset to fill the viewport while maintaining the aspect ratio. The asset will be cropped if it exceeds the bounds of the viewport.</li> <li>none - preserves the original asset dimensions and does not apply any scaling.</li> </ul>



28
29
30
 
# File 'lib/shotstack/models/clip.rb', line 28

def fit
  @fit
end

#length ⇒ Object

The length, in seconds, the Clip should play for.



25
26
27
 
# File 'lib/shotstack/models/clip.rb', line 25

def length
  @length
end

#offset ⇒ Object

Returns the value of attribute offset.



36
37
38
 
# File 'lib/shotstack/models/clip.rb', line 36

def offset
  @offset
end

#opacity ⇒ Object

Sets the opacity of the Clip where 1 is opaque and 0 is transparent.



47
48
49
 
# File 'lib/shotstack/models/clip.rb', line 47

def opacity
  @opacity
end

#position ⇒ Object

Place the asset in one of nine predefined positions of the viewport. This is most effective for when the asset is scaled and you want to position the element to a specific position. <ul> <li>top - top (center)</li> <li>topRight - top right</li> <li>right - right (center)</li> <li>bottomRight - bottom right</li> <li>bottom - bottom (center)</li> <li>bottomLeft - bottom left</li> <li>left - left (center)</li> <li>topLeft - top left</li> <li>center - center</li> </ul>



34
35
36
 
# File 'lib/shotstack/models/clip.rb', line 34

def position
  @position
end

#scale ⇒ Object

Scale the asset to a fraction of the viewport size - i.e. setting the scale to 0.5 will scale asset to half the size of the viewport. This is useful for picture-in-picture video and scaling images such as logos and watermarks.



31
32
33
 
# File 'lib/shotstack/models/clip.rb', line 31

def scale
  @scale
end

#start ⇒ Object

The start position of the Clip on the timeline, in seconds.



22
23
24
 
# File 'lib/shotstack/models/clip.rb', line 22

def start
  @start
end

#transition ⇒ Object

Returns the value of attribute transition.



38
39
40
 
# File 'lib/shotstack/models/clip.rb', line 38

def transition
  @transition
end

Class Method Details

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/shotstack/models/clip.rb', line 72

def self.attribute_map
  {
    :'asset' => :'asset',
    :'start' => :'start',
    :'length' => :'length',
    :'fit' => :'fit',
    :'scale' => :'scale',
    :'position' => :'position',
    :'offset' => :'offset',
    :'transition' => :'transition',
    :'effect' => :'effect',
    :'filter' => :'filter',
    :'opacity' => :'opacity'
  }
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



286
287
288
 
# File 'lib/shotstack/models/clip.rb', line 286

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



106
107
108
109
 
# File 'lib/shotstack/models/clip.rb', line 106

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

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/shotstack/models/clip.rb', line 89

def self.openapi_types
  {
    :'asset' => :'Asset',
    :'start' => :'Float',
    :'length' => :'Float',
    :'fit' => :'String',
    :'scale' => :'Float',
    :'position' => :'String',
    :'offset' => :'Offset',
    :'transition' => :'Transition',
    :'effect' => :'String',
    :'filter' => :'String',
    :'opacity' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/shotstack/models/clip.rb', line 255

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      asset == o.asset &&
      start == o.start &&
      length == o.length &&
      fit == o.fit &&
      scale == o.scale &&
      position == o.position &&
      offset == o.offset &&
      transition == o.transition &&
      effect == o.effect &&
      filter == o.filter &&
      opacity == o.opacity
end

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



314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/shotstack/models/clip.rb', line 314

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
    Shotstack.const_get(type).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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/shotstack/models/clip.rb', line 383

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/shotstack/models/clip.rb', line 293

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


273
274
275
 
# File 'lib/shotstack/models/clip.rb', line 273

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



279
280
281
 
# File 'lib/shotstack/models/clip.rb', line 279

def hash
  [asset, start, length, fit, scale, position, offset, transition, effect, filter, opacity].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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/shotstack/models/clip.rb', line 179

def list_invalid_properties
  invalid_properties = Array.new
  if @asset.nil?
    invalid_properties.push('invalid value for "asset", asset cannot be nil.')
  end

  if @start.nil?
    invalid_properties.push('invalid value for "start", start cannot be nil.')
  end

  if @length.nil?
    invalid_properties.push('invalid value for "length", length cannot be nil.')
  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



359
360
361
 
# File 'lib/shotstack/models/clip.rb', line 359

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



365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/shotstack/models/clip.rb', line 365

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



353
354
355
 
# File 'lib/shotstack/models/clip.rb', line 353

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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/shotstack/models/clip.rb', line 198

def valid?
  return false if @asset.nil?
  return false if @start.nil?
  return false if @length.nil?
  fit_validator = EnumAttributeValidator.new('String', ["cover", "contain", "crop", "none"])
  return false unless fit_validator.valid?(@fit)
  position_validator = EnumAttributeValidator.new('String', ["top", "topRight", "right", "bottomRight", "bottom", "bottomLeft", "left", "topLeft", "center"])
  return false unless position_validator.valid?(@position)
  effect_validator = EnumAttributeValidator.new('String', ["zoomIn", "zoomOut", "slideLeft", "slideRight", "slideUp", "slideDown"])
  return false unless effect_validator.valid?(@effect)
  filter_validator = EnumAttributeValidator.new('String', ["blur", "boost", "contrast", "darken", "greyscale", "lighten", "muted", "negative"])
  return false unless filter_validator.valid?(@filter)
  true
end