Class: Telnyx::Models::Calls::ActionStartNoiseSuppressionParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::Calls::ActionStartNoiseSuppressionParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/calls/action_start_noise_suppression_params.rb

Overview

See Also:

• Resources::Calls::Actions#start_noise_suppression

Defined Under Namespace

Modules: Direction, NoiseSuppressionEngine Classes: NoiseSuppressionEngineConfig

Instance Attribute Summary

• #call_control_id ⇒ String
• #client_state ⇒ String^?

  Use this field to add state to every subsequent webhook.

• #command_id ⇒ String^?

  Use this field to avoid duplicate commands.

• #direction ⇒ Symbol, ...

  The direction of the audio stream to be noise suppressed.

• #noise_suppression_engine ⇒ Symbol, ...

  The engine to use for noise suppression.

• #noise_suppression_engine_config ⇒ Telnyx::Models::Calls::ActionStartNoiseSuppressionParams::NoiseSuppressionEngineConfig^?

  Configuration parameters for noise suppression engines.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(call_control_id:, client_state: nil, command_id: nil, direction: nil, noise_suppression_engine: nil, noise_suppression_engine_config: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see ActionStartNoiseSuppressionParams for more details.

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(call_control_id:, client_state: nil, command_id: nil, direction: nil, noise_suppression_engine: nil, noise_suppression_engine_config: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::Calls::ActionStartNoiseSuppressionParams for more details.

Parameters:

• call_control_id (String)
• client_state (String) (defaults to: nil) —

  Use this field to add state to every subsequent webhook. It must be a valid Base

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

  Use this field to avoid duplicate commands. Telnyx will ignore any command with

• direction (Symbol, Telnyx::Models::Calls::ActionStartNoiseSuppressionParams::Direction) (defaults to: nil) —

  The direction of the audio stream to be noise suppressed.

• noise_suppression_engine (Symbol, Telnyx::Models::Calls::ActionStartNoiseSuppressionParams::NoiseSuppressionEngine) (defaults to: nil) —

  The engine to use for noise suppression.

• noise_suppression_engine_config (Telnyx::Models::Calls::ActionStartNoiseSuppressionParams::NoiseSuppressionEngineConfig) (defaults to: nil) —

  Configuration parameters for noise suppression engines. Different engines suppor

• request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/telnyx/models/calls/action_start_noise_suppression_params.rb', line 53

Instance Attribute Details

#call_control_id ⇒ String

Returns:

• (String)

# File 'lib/telnyx/models/calls/action_start_noise_suppression_params.rb', line 14

required :call_control_id, String

#client_state ⇒ String^?

Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.

Returns:

• (String, nil)

# File 'lib/telnyx/models/calls/action_start_noise_suppression_params.rb', line 21

optional :client_state, String

#command_id ⇒ String^?

Use this field to avoid duplicate commands. Telnyx will ignore any command with the same ‘command_id` for the same `call_control_id`.

Returns:

• (String, nil)

# File 'lib/telnyx/models/calls/action_start_noise_suppression_params.rb', line 28

optional :command_id, String

#direction ⇒ Symbol, ...

The direction of the audio stream to be noise suppressed.

Returns:

• (Symbol, Telnyx::Models::Calls::ActionStartNoiseSuppressionParams::Direction, nil)

# File 'lib/telnyx/models/calls/action_start_noise_suppression_params.rb', line 34

optional :direction, enum: -> { Telnyx::Calls::ActionStartNoiseSuppressionParams::Direction }

#noise_suppression_engine ⇒ Symbol, ...

The engine to use for noise suppression. For backward compatibility, engines A, B, C, and D are also supported, but are deprecated: A - Denoiser B - DeepFilterNet C - Krisp D - AiCoustics

Returns:

• (Symbol, Telnyx::Models::Calls::ActionStartNoiseSuppressionParams::NoiseSuppressionEngine, nil)

# File 'lib/telnyx/models/calls/action_start_noise_suppression_params.rb', line 42

optional :noise_suppression_engine,
enum: -> { Telnyx::Calls::ActionStartNoiseSuppressionParams::NoiseSuppressionEngine }

#noise_suppression_engine_config ⇒ Telnyx::Models::Calls::ActionStartNoiseSuppressionParams::NoiseSuppressionEngineConfig^?

Configuration parameters for noise suppression engines. Different engines support different parameters.

Returns:

• (Telnyx::Models::Calls::ActionStartNoiseSuppressionParams::NoiseSuppressionEngineConfig, nil)

# File 'lib/telnyx/models/calls/action_start_noise_suppression_params.rb', line 50

optional :noise_suppression_engine_config,
-> { Telnyx::Calls::ActionStartNoiseSuppressionParams::NoiseSuppressionEngineConfig }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/telnyx/models/calls/action_start_noise_suppression_params.rb', line 79