Class: Shotstack::Output
- Inherits:
-
Object
- Object
- Shotstack::Output
- Defined in:
- lib/shotstack/models/output.rb
Overview
The output format, render range and type of media to generate.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#aspect_ratio ⇒ Object
The aspect ratio (shape) of the video or image.
-
#destinations ⇒ Object
Specify the storage locations and hosting services to send rendered videos to.
-
#format ⇒ Object
The output format and type of media file to generate.
-
#fps ⇒ Object
Override the default frames per second.
-
#mute ⇒ Object
Mute the audio track of the output video.
-
#poster ⇒ Object
Returns the value of attribute poster.
-
#quality ⇒ Object
Adjust the output quality of the video, image or audio.
-
#range ⇒ Object
Returns the value of attribute range.
-
#repeat ⇒ Object
Loop settings for gif files.
-
#resolution ⇒ Object
The preset output resolution of the video or image.
-
#scale_to ⇒ Object
Override the resolution and scale the video or image to render at a different size.
-
#size ⇒ Object
Returns the value of attribute size.
-
#thumbnail ⇒ Object
Returns the value of attribute thumbnail.
Class Method Summary collapse
-
._deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Output
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ Output
Initializes the object
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 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
# File 'lib/shotstack/models/output.rb', line 127 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Shotstack::Output` 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::Output`. 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?(:'format') self.format = attributes[:'format'] else self.format = nil end if attributes.key?(:'resolution') self.resolution = attributes[:'resolution'] end if attributes.key?(:'aspect_ratio') self.aspect_ratio = attributes[:'aspect_ratio'] end if attributes.key?(:'size') self.size = attributes[:'size'] end if attributes.key?(:'fps') self.fps = attributes[:'fps'] end if attributes.key?(:'scale_to') self.scale_to = attributes[:'scale_to'] end if attributes.key?(:'quality') self.quality = attributes[:'quality'] end if attributes.key?(:'repeat') self.repeat = attributes[:'repeat'] end if attributes.key?(:'mute') self.mute = attributes[:'mute'] end if attributes.key?(:'range') self.range = attributes[:'range'] end if attributes.key?(:'poster') self.poster = attributes[:'poster'] end if attributes.key?(:'thumbnail') self.thumbnail = attributes[:'thumbnail'] end if attributes.key?(:'destinations') if (value = attributes[:'destinations']).is_a?(Array) self.destinations = value end end end |
Instance Attribute Details
#aspect_ratio ⇒ Object
The aspect ratio (shape) of the video or image. Useful for social media output formats. Options are: <ul> <li>‘16:9` (default) - regular landscape/horizontal aspect ratio</li> <li>`9:16` - vertical/portrait aspect ratio</li> <li>`1:1` - square aspect ratio</li> <li>`4:5` - short vertical/portrait aspect ratio</li> <li>`4:3` - legacy TV aspect ratio</li> </ul>
26 27 28 |
# File 'lib/shotstack/models/output.rb', line 26 def aspect_ratio @aspect_ratio end |
#destinations ⇒ Object
Specify the storage locations and hosting services to send rendered videos to.
52 53 54 |
# File 'lib/shotstack/models/output.rb', line 52 def destinations @destinations end |
#format ⇒ Object
The output format and type of media file to generate. <ul> <li>‘mp4` - mp4 video file</li> <li>`gif` - animated gif</li> <li>`jpg` - jpg image file</li> <li>`png` - png image file</li> <li>`bmp` - bmp image file</li> <li>`mp3` - mp3 audio file (audio only)</li> </ul>
20 21 22 |
# File 'lib/shotstack/models/output.rb', line 20 def format @format end |
#fps ⇒ Object
Override the default frames per second. Useful for when the source footage is recorded at 30fps, i.e. on mobile devices. Lower frame rates can be used to add cinematic quality (24fps) or to create smaller file size/faster render times or animated gifs (12 or 15fps). Default is 25fps. <ul> <li>‘12` - 12fps</li> <li>`15` - 15fps</li> <li>`24` - 24fps</li> <li>`23.976` - 23.976fps</li> <li>`25` (default) - 25fps</li> <li>`29.97` - 29.97fps</li> <li>`30` - 30fps</li> <li>`48` - 48fps</li> <li>`50` - 50fps</li> <li>`59.94` - 59.94fps</li> <li>`60` - 60fps</li> </ul>
31 32 33 |
# File 'lib/shotstack/models/output.rb', line 31 def fps @fps end |
#mute ⇒ Object
Mute the audio track of the output video. Set to ‘true` to mute, `false` to un-mute.
43 44 45 |
# File 'lib/shotstack/models/output.rb', line 43 def mute @mute end |
#poster ⇒ Object
Returns the value of attribute poster.
47 48 49 |
# File 'lib/shotstack/models/output.rb', line 47 def poster @poster end |
#quality ⇒ Object
Adjust the output quality of the video, image or audio. Adjusting quality affects render speed, download speeds and storage requirements due to file size. The default ‘medium` provides the most optimized choice for all three factors. <ul> <li>`verylow` - reduced quality, smallest file size</li> <li>`low` - slightly reduced quality, smaller file size</li> <li>`medium` (default) - optimized quality, render speeds and file size</li> <li>`high` - slightly increased quality, larger file size</li> <li>`veryhigh` - highest quality, largest file size</li> </ul>
37 38 39 |
# File 'lib/shotstack/models/output.rb', line 37 def quality @quality end |
#range ⇒ Object
Returns the value of attribute range.
45 46 47 |
# File 'lib/shotstack/models/output.rb', line 45 def range @range end |
#repeat ⇒ Object
Loop settings for gif files. Set to ‘true` to loop, `false` to play only once.
40 41 42 |
# File 'lib/shotstack/models/output.rb', line 40 def repeat @repeat end |
#resolution ⇒ Object
The preset output resolution of the video or image. For custom sizes use the ‘size` property. <ul> <li>`preview` - 512px x 288px @ 15fps</li> <li>`mobile` - 640px x 360px @ 25fps</li> <li>`sd` - 1024px x 576px @ 25fps</li> <li>`hd` - 1280px x 720px @ 25fps</li> <li>`1080` - 1920px x 1080px @ 25fps</li> <li>`4k` - 3840px x 2160px @ 25fps</li> </ul>
23 24 25 |
# File 'lib/shotstack/models/output.rb', line 23 def resolution @resolution end |
#scale_to ⇒ Object
Override the resolution and scale the video or image to render at a different size. When using scaleTo the asset should be edited at the resolution dimensions, i.e. use font sizes that look best at HD, then use scaleTo to output the file at SD and the text will be scaled to the correct size. This is useful if you want to create multiple asset sizes. <ul> <li>‘preview` - 512px x 288px @ 15fps</li> <li>`mobile` - 640px x 360px @ 25fps</li> <li>`sd` - 1024px x 576px @25fps</li> <li>`hd` - 1280px x 720px @25fps</li> <li>`1080` - 1920px x 1080px @25fps</li> </ul>
34 35 36 |
# File 'lib/shotstack/models/output.rb', line 34 def scale_to @scale_to end |
#size ⇒ Object
Returns the value of attribute size.
28 29 30 |
# File 'lib/shotstack/models/output.rb', line 28 def size @size end |
#thumbnail ⇒ Object
Returns the value of attribute thumbnail.
49 50 51 |
# File 'lib/shotstack/models/output.rb', line 49 def thumbnail @thumbnail end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
# File 'lib/shotstack/models/output.rb', line 348 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
96 97 98 |
# File 'lib/shotstack/models/output.rb', line 96 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 |
# File 'lib/shotstack/models/output.rb', line 77 def self.attribute_map { :'format' => :'format', :'resolution' => :'resolution', :'aspect_ratio' => :'aspectRatio', :'size' => :'size', :'fps' => :'fps', :'scale_to' => :'scaleTo', :'quality' => :'quality', :'repeat' => :'repeat', :'mute' => :'mute', :'range' => :'range', :'poster' => :'poster', :'thumbnail' => :'thumbnail', :'destinations' => :'destinations' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 |
# File 'lib/shotstack/models/output.rb', line 324 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
120 121 122 123 |
# File 'lib/shotstack/models/output.rb', line 120 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/shotstack/models/output.rb', line 101 def self.openapi_types { :'format' => :'String', :'resolution' => :'String', :'aspect_ratio' => :'String', :'size' => :'Size', :'fps' => :'Float', :'scale_to' => :'String', :'quality' => :'String', :'repeat' => :'Boolean', :'mute' => :'Boolean', :'range' => :'Range', :'poster' => :'Poster', :'thumbnail' => :'Thumbnail', :'destinations' => :'Array<Destinations>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 |
# File 'lib/shotstack/models/output.rb', line 291 def ==(o) return true if self.equal?(o) self.class == o.class && format == o.format && resolution == o.resolution && aspect_ratio == o.aspect_ratio && size == o.size && fps == o.fps && scale_to == o.scale_to && quality == o.quality && repeat == o.repeat && mute == o.mute && range == o.range && poster == o.poster && thumbnail == o.thumbnail && destinations == o.destinations end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
419 420 421 422 423 424 425 426 427 428 429 430 431 |
# File 'lib/shotstack/models/output.rb', line 419 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
311 312 313 |
# File 'lib/shotstack/models/output.rb', line 311 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
317 318 319 |
# File 'lib/shotstack/models/output.rb', line 317 def hash [format, resolution, aspect_ratio, size, fps, scale_to, quality, repeat, mute, range, poster, thumbnail, destinations].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
199 200 201 202 203 204 205 206 207 |
# File 'lib/shotstack/models/output.rb', line 199 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new if @format.nil? invalid_properties.push('invalid value for "format", format cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
395 396 397 |
# File 'lib/shotstack/models/output.rb', line 395 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
401 402 403 404 405 406 407 408 409 410 411 412 413 |
# File 'lib/shotstack/models/output.rb', line 401 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
389 390 391 |
# File 'lib/shotstack/models/output.rb', line 389 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 |
# File 'lib/shotstack/models/output.rb', line 211 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' return false if @format.nil? format_validator = EnumAttributeValidator.new('String', ["mp4", "gif", "mp3", "jpg", "png", "bmp"]) return false unless format_validator.valid?(@format) resolution_validator = EnumAttributeValidator.new('String', ["preview", "mobile", "sd", "hd", "1080", "4k"]) return false unless resolution_validator.valid?(@resolution) aspect_ratio_validator = EnumAttributeValidator.new('String', ["16:9", "9:16", "1:1", "4:5", "4:3"]) return false unless aspect_ratio_validator.valid?(@aspect_ratio) fps_validator = EnumAttributeValidator.new('Float', [12, 15, 23.976, 24, 25, 29.97, 30, 48, 50, 59.94, 60]) return false unless fps_validator.valid?(@fps) scale_to_validator = EnumAttributeValidator.new('String', ["preview", "mobile", "sd", "hd", "1080"]) return false unless scale_to_validator.valid?(@scale_to) quality_validator = EnumAttributeValidator.new('String', ["verylow", "low", "medium", "high", "veryhigh"]) return false unless quality_validator.valid?(@quality) true end |