Class: Shotstack::HeyGenTextToAvatarOptions

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

Overview

Options for the HeyGen text-to-avatar service. Set the text to be converted to an avatar and configure the avatars voice, speaking style, appearance and background. The output will be generated as an MP4 video file available at the URL returned in the response.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HeyGenTextToAvatarOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/shotstack/models/hey_gen_text_to_avatar_options.rb', line 106

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

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

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

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

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

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

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

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

Instance Attribute Details

#avatar ⇒ Object

The avatar character to generate. Select from the list of available avatars: <ul> <li>‘Angela`</li> <li>`Bill`</li> <li>`Daisy`</li> <li>`Derek`</li> <li>`Eva`</li> <li>`Jake`</li> <li>`Jeff`</li> <li>`Jerome`</li> <li>`Joon`</li> <li>`Kayla`</li> <li>`Kent`</li> <li>`Luna`</li> <li>`Mark`</li> <li>`Matthew`</li> <li>`Monica`</li> <li>`Peter`</li> <li>`Selina`</li> <li>`Tanya`</li> <li>`Thomas`</li> <li>`Tina`</li> <li>`Tyler`</li> <li>`Vanessa`</li> <li>`Vera`</li> <li>`Wilson`</li> <li>`Zoey`</li> </ul>



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

def avatar
  @avatar
end

#avatar_style ⇒ Object

The display style of the avatar, a rectangle ‘normal` or circular `circle` background. Defaults to `normal`.



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

def avatar_style
  @avatar_style
end

#background ⇒ Object

The background color of the video. Defaults to ‘#ffffff`.



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

def background
  @background
end

#ratio ⇒ Object

The aspect ratio of the video, ‘16:9` horizontal or `9:16` vertical. Defaults to `16:9`.



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

def ratio
  @ratio
end

#test ⇒ Object

A boolean flag indicating whether the video is for testing purposes. See the "test" parameter in [HeyGen](docs.heygen.com/reference/generate-video) for more details.



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

def test
  @test
end

#text ⇒ Object

The text or script that the avatar will narrate.



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

def text
  @text
end

#type ⇒ Object

The type of asset to generate - set to ‘text-to-avatar` for text-to-avatar.



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

def type
  @type
end

#voice ⇒ Object

The avatars voice and speaking style. Select from the list of available voices: <ul> <li>‘Abb- - Natural`</li> <li>`Adam - Natural`</li> <li>`Aiston - Friendly`</li> <li>`Alice - Newscaster`</li> <li>`Alison - Cheerful`</li> <li>`Amber - Friendly`</li> <li>`Amy - Warm`</li> <li>`Ana - Cheerful`</li> <li>`Antoni - Friendly`</li> <li>`Aria - Newscaster`</li> <li>`Arnold - Cheerful`</li> <li>`Arthur - Natural`</li> <li>`Bella - Friendly`</li> <li>`Belle - Natural`</li> <li>`Brandon - Warm`</li> <li>`Brian - Natural`</li> <li>`Bruce - Natural`</li> <li>`Cerise - Cheerful`</li> <li>`Christopher - Calm`</li> <li>`Clara - Professional`</li> <li>`Connor - Natural`</li> <li>`Dahlia - Friendly`</li> <li>`Davis - Professional`</li> <li>`Dean - Natural`</li> <li>`Delbert - Cheerful`</li> <li>`Edward - Friendly`</li> <li>`Elaine - Calm`</li> <li>`Emily - Natural`</li> <li>`Emma - Newscaster`</li> <li>`Eric - Newscaster`</li> <li>`Grace - Natural`</li> <li>`Hailey - Calm`</li> <li>`Indira - Cheerful`</li> <li>`Isabella - Cheerful`</li> <li>`Jacob - Natural`</li> <li>`Jahmai - Friendly`</li> <li>`Jane - Serious`</li> <li>`Jason - Serious`</li> <li>`Jelle - Friendly`</li> <li>`Jen - Natural`</li> <li>`Jenny - Professional`</li> <li>`Jodi - Cheerful`</li> <li>`Joey - Calm`</li> <li>`Johan - Friendly`</li> <li>`Josie - Cheerful`</li> <li>`Keanan - Natural`</li> <li>`Keith - Cheerful`</li> <li>`Kellie - Friendly`</li> <li>`Lauren - Friendly`</li> <li>`Leah - Natural`</li> <li>`Liam - Professional`</li> <li>`Libby - Natural`</li> <li>`Lily - Professional`</li> <li>`Lucas - Natural`</li> <li>`Luke - Professional`</li> <li>`Luna - Natural`</li> <li>`Marieke - Natural`</li> <li>`Matthew - Professional`</li> <li>`Michelle - Natural`</li> <li>`Mitchell - Natural`</li> <li>`Molly - Newscaster`</li> <li>`Monica - Calm`</li> <li>`Natasha - Professional`</li> <li>`Neerja - Newscaster`</li> <li>`Noah - Serious`</li> <li>`Oliver - Newscaster`</li> <li>`Olivia - Calm`</li> <li>`Paul - Natural`</li> <li>`Prabhat - Natural`</li> <li>`Raveena - Natural`</li> <li>`Rudi - Friendly`</li> <li>`Ryan - Professional`</li> <li>`Sam - Natural`</li> <li>`Sara - Cheerful`</li> <li>`Sherry - Friendly`</li> <li>`Sonia - Warm`</li> <li>`Thomas - Natural`</li> <li>`Todd - Professional`</li> <li>`Tony - Professional`</li> <li>`Tracy - Cheerful`</li> <li>`Wayne - Natural`</li> <li>`Wilder - Natural`</li> <li>`Wille - Natural`</li> <li>`William - Friendly`</li> </ul>



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

def voice
  @voice
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



309
310
311
312
313
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
 
# File 'lib/shotstack/models/hey_gen_text_to_avatar_options.rb', line 309

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



80
81
82
 
# File 'lib/shotstack/models/hey_gen_text_to_avatar_options.rb', line 80

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/shotstack/models/hey_gen_text_to_avatar_options.rb', line 66

def self.attribute_map
  {
    :'type' => :'type',
    :'text' => :'text',
    :'avatar' => :'avatar',
    :'voice' => :'voice',
    :'avatar_style' => :'avatarStyle',
    :'background' => :'background',
    :'ratio' => :'ratio',
    :'test' => :'test'
  }
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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/shotstack/models/hey_gen_text_to_avatar_options.rb', line 285

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



99
100
101
102
 
# File 'lib/shotstack/models/hey_gen_text_to_avatar_options.rb', line 99

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

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/shotstack/models/hey_gen_text_to_avatar_options.rb', line 85

def self.openapi_types
  {
    :'type' => :'String',
    :'text' => :'String',
    :'avatar' => :'String',
    :'voice' => :'String',
    :'avatar_style' => :'String',
    :'background' => :'String',
    :'ratio' => :'String',
    :'test' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      text == o.text &&
      avatar == o.avatar &&
      voice == o.voice &&
      avatar_style == o.avatar_style &&
      background == o.background &&
      ratio == o.ratio &&
      test == o.test
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



380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/shotstack/models/hey_gen_text_to_avatar_options.rb', line 380

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


272
273
274
 
# File 'lib/shotstack/models/hey_gen_text_to_avatar_options.rb', line 272

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



278
279
280
 
# File 'lib/shotstack/models/hey_gen_text_to_avatar_options.rb', line 278

def hash
  [type, text, avatar, voice, avatar_style, background, ratio, test].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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/shotstack/models/hey_gen_text_to_avatar_options.rb', line 162

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

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

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



356
357
358
 
# File 'lib/shotstack/models/hey_gen_text_to_avatar_options.rb', line 356

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



362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/shotstack/models/hey_gen_text_to_avatar_options.rb', line 362

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



350
351
352
 
# File 'lib/shotstack/models/hey_gen_text_to_avatar_options.rb', line 350

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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/shotstack/models/hey_gen_text_to_avatar_options.rb', line 186

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["text-to-avatar"])
  return false unless type_validator.valid?(@type)
  return false if @text.nil?
  return false if @avatar.nil?
  avatar_validator = EnumAttributeValidator.new('String', ["Angela", "Bill", "Daisy", "Derek", "Eva", "Jake", "Jeff", "Jerome", "Joon", "Kayla", "Kent", "Luna", "Mark", "Matthew", "Monica", "Peter", "Selina", "Tanya", "Thomas", "Tina", "Tyler", "Vanessa", "Vera", "Wilson", "Zoey"])
  return false unless avatar_validator.valid?(@avatar)
  return false if @voice.nil?
  voice_validator = EnumAttributeValidator.new('String', ["Abbi - Natural", "Adam - Natural", "Aiston - Friendly", "Alice - Newscaster", "Alison - Cheerful", "Amber - Friendly", "Amy - Warm", "Ana - Cheerful", "Antoni - Friendly", "Aria - Newscaster", "Arnold - Cheerful", "Arthur - Natural", "Bella - Friendly", "Belle - Natural", "Brandon - Warm", "Brian - Natural", "Bruce - Natural", "Cerise - Cheerful", "Christopher - Calm", "Clara - Professional", "Connor - Natural", "Dahlia - Friendly", "Davis - Professional", "Dean - Natural", "Delbert - Cheerful", "Edward - Friendly", "Elaine - Calm", "Emily - Natural", "Emma - Newscaster", "Eric - Newscaster", "Grace - Natural", "Hailey - Calm", "Indira - Cheerful", "Isabella - Cheerful", "Jacob - Natural", "Jahmai - Friendly", "Jane - Serious", "Jason - Serious", "Jelle - Friendly", "Jen - Natural", "Jenny - Professional", "Jodi - Cheerful", "Joey - Calm", "Johan - Friendly", "Josie - Cheerful", "Keanan - Natural", "Keith - Cheerful", "Kellie - Friendly", "Lauren - Friendly", "Leah - Natural", "Liam - Professional", "Libby - Natural", "Lily - Professional", "Lucas - Natural", "Luke - Professional", "Luna - Natural", "Marieke - Natural", "Matthew - Professional", "Michelle - Natural", "Mitchell - Natural", "Molly - Newscaster", "Monica - Calm", "Natasha - Professional", "Neerja - Newscaster", "Noah - Serious", "Oliver - Newscaster", "Olivia - Calm", "Paul - Natural", "Prabhat - Natural", "Raveena - Natural", "Rudi - Friendly", "Ryan - Professional", "Sam - Natural", "Sara - Cheerful", "Sherry - Friendly", "Sonia - Warm", "Thomas - Natural", "Todd - Professional", "Tony - Professional", "Tracy - Cheerful", "Wayne - Natural", "Wilder - Natural", "Wille - Natural", "William - Friendly"])
  return false unless voice_validator.valid?(@voice)
  avatar_style_validator = EnumAttributeValidator.new('String', ["normal", "circle"])
  return false unless avatar_style_validator.valid?(@avatar_style)
  ratio_validator = EnumAttributeValidator.new('String', ["16:9", "9:16"])
  return false unless ratio_validator.valid?(@ratio)
  true
end