Class: Telnyx::Models::Conferences::ActionRecordStartParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/conferences/action_record_start_params.rb

Overview

See Also:

Defined Under Namespace

Modules: Format, Region, Trim

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

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(format_:, command_id: nil, custom_file_name: nil, play_beep: nil, region: nil, trim: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::Conferences::ActionRecordStartParams for more details.

Parameters:




# File 'lib/telnyx/models/conferences/action_record_start_params.rb', line 56

Instance Attribute Details

#command_id ⇒ String?

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

Returns:

  • (String, nil) 


27
 
# File 'lib/telnyx/models/conferences/action_record_start_params.rb', line 27

optional :command_id, String

#custom_file_name ⇒ String?

The custom recording file name to be used instead of the default ‘call_leg_id`. Telnyx will still add a Unix timestamp suffix.

Returns:

  • (String, nil) 


34
 
# File 'lib/telnyx/models/conferences/action_record_start_params.rb', line 34

optional :custom_file_name, String

#format_ ⇒ Symbol, Telnyx::Models::Conferences::ActionRecordStartParams::Format

The audio file format used when storing the conference recording. Can be either ‘mp3` or `wav`.

Returns:



16
17
18
19
20
 
# File 'lib/telnyx/models/conferences/action_record_start_params.rb', line 16

required :format_,
enum: -> {
  Telnyx::Conferences::ActionRecordStartParams::Format
},
api_name: :format

#play_beep ⇒ Boolean?

If enabled, a beep sound will be played at the start of a recording.

Returns:

  • (Boolean, nil) 


40
 
# File 'lib/telnyx/models/conferences/action_record_start_params.rb', line 40

optional :play_beep, Telnyx::Internal::Type::Boolean

#region ⇒ Symbol, ...

Region where the conference data is located. Defaults to the region defined in user’s data locality settings (Europe or US).

Returns:



47
 
# File 'lib/telnyx/models/conferences/action_record_start_params.rb', line 47

optional :region, enum: -> { Telnyx::Conferences::ActionRecordStartParams::Region }

#trim ⇒ Symbol, ...

When set to ‘trim-silence`, silence will be removed from the beginning and end of the recording.

Returns:



54
 
# File 'lib/telnyx/models/conferences/action_record_start_params.rb', line 54

optional :trim, enum: -> { Telnyx::Conferences::ActionRecordStartParams::Trim }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/conferences/action_record_start_params.rb', line 82