Class: Telnyx::Models::TextToSpeechGenerateParams::Aws

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/text_to_speech_generate_params.rb

Defined Under Namespace

Modules: TextType

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(language_code: nil, lexicon_names: nil, output_format: nil, sample_rate: nil, text_type: nil) ⇒ Object

AWS Polly provider-specific parameters.

Parameters:

  • language_code (String) (defaults to: nil) —

    Language code (e.g. ‘en-US`, `es-ES`).

  • lexicon_names (Array<String>) (defaults to: nil) —

    List of lexicon names to apply.

  • output_format (String) (defaults to: nil) —

    Audio output format.

  • sample_rate (String) (defaults to: nil) —

    Audio sample rate.

  • text_type (Symbol, ::Telnyx::Models::TextToSpeechGenerateParams::Aws::TextType) (defaults to: nil) —

    Input text type.



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
196
197
198
199
200
201
 
# File 'lib/telnyx/models/text_to_speech_generate_params.rb', line 145

class Aws < ::Telnyx::Internal::Type::BaseModel
  # @!attribute language_code
  #   Language code (e.g. `en-US`, `es-ES`).
  #
  #   @return [String, nil]
  optional :language_code, String

  # @!attribute lexicon_names
  #   List of lexicon names to apply.
  #
  #   @return [Array<String>, nil]
  optional :lexicon_names, ::Telnyx::Internal::Type::ArrayOf[String]

  # @!attribute output_format
  #   Audio output format.
  #
  #   @return [String, nil]
  optional :output_format, String

  # @!attribute sample_rate
  #   Audio sample rate.
  #
  #   @return [String, nil]
  optional :sample_rate, String

  # @!attribute text_type
  #   Input text type.
  #
  #   @return [Symbol, ::Telnyx::Models::TextToSpeechGenerateParams::Aws::TextType, nil]
  optional :text_type, enum: -> { ::Telnyx::TextToSpeechGenerateParams::Aws::TextType }

  # @!method initialize(language_code: nil, lexicon_names: nil, output_format: nil, sample_rate: nil, text_type: nil)
  #   AWS Polly provider-specific parameters.
  #
  #   @param language_code [String] Language code (e.g. `en-US`, `es-ES`).
  #
  #   @param lexicon_names [Array<String>] List of lexicon names to apply.
  #
  #   @param output_format [String] Audio output format.
  #
  #   @param sample_rate [String] Audio sample rate.
  #
  #   @param text_type [Symbol, ::Telnyx::Models::TextToSpeechGenerateParams::Aws::TextType] Input text type.

  # Input text type.
  #
  # @see Telnyx::Models::TextToSpeechGenerateParams::Aws#text_type
  module TextType
    extend ::Telnyx::Internal::Type::Enum

    TEXT = :text
    SSML = :ssml

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#language_code ⇒ String?

Language code (e.g. ‘en-US`, `es-ES`).

Returns:

  • (String, nil) 


150
 
# File 'lib/telnyx/models/text_to_speech_generate_params.rb', line 150

optional :language_code, String

#lexicon_names ⇒ Array<String>?

List of lexicon names to apply.

Returns:

  • (Array<String>, nil) 


156
 
# File 'lib/telnyx/models/text_to_speech_generate_params.rb', line 156

optional :lexicon_names, ::Telnyx::Internal::Type::ArrayOf[String]

#output_format ⇒ String?

Audio output format.

Returns:

  • (String, nil) 


162
 
# File 'lib/telnyx/models/text_to_speech_generate_params.rb', line 162

optional :output_format, String

#sample_rate ⇒ String?

Audio sample rate.

Returns:

  • (String, nil) 


168
 
# File 'lib/telnyx/models/text_to_speech_generate_params.rb', line 168

optional :sample_rate, String

#text_type ⇒ Symbol, ...

Input text type.

Returns:



174
 
# File 'lib/telnyx/models/text_to_speech_generate_params.rb', line 174

optional :text_type, enum: -> { ::Telnyx::TextToSpeechGenerateParams::Aws::TextType }