Class: Telnyx::Models::AI::VoiceSettings::BackgroundAudio::PredefinedMedia

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

Defined Under Namespace

Modules: Value

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(value:, volume: nil, type: :predefined_media) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::AI::VoiceSettings::BackgroundAudio::PredefinedMedia for more details.

Parameters:

  • value (Symbol, Telnyx::Models::AI::VoiceSettings::BackgroundAudio::PredefinedMedia::Value) —

    The predefined media to use. ‘silence` disables background audio.

  • volume (Float) (defaults to: nil) —

    Volume level for the predefined background audio. Supports values from 0.1 to 1.

  • type (Symbol, :predefined_media) (defaults to: :predefined_media) —

    Select from predefined media options.




# File 'lib/telnyx/models/ai/voice_settings.rb', line 163

Instance Attribute Details

#type ⇒ Symbol, :predefined_media

Select from predefined media options.

Returns:

  • (Symbol, :predefined_media) 


148
 
# File 'lib/telnyx/models/ai/voice_settings.rb', line 148

required :type, const: :predefined_media

#value ⇒ Symbol, Telnyx::Models::AI::VoiceSettings::BackgroundAudio::PredefinedMedia::Value

The predefined media to use. ‘silence` disables background audio.

Returns:



154
 
# File 'lib/telnyx/models/ai/voice_settings.rb', line 154

required :value, enum: -> { Telnyx::AI::VoiceSettings::BackgroundAudio::PredefinedMedia::Value }

#volume ⇒ Float?

Volume level for the predefined background audio. Supports values from 0.1 to 1.0 in 0.1 increments.

Returns:

  • (Float, nil) 


161
 
# File 'lib/telnyx/models/ai/voice_settings.rb', line 161

optional :volume, Float