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

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::Conferences::ActionRecordStartParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/conferences/action_record_start_params.rb,
sig/telnyx/models/conferences/action_record_start_params.rbs

Overview

See Also:

• Telnyx::Resources::Conferences::Actions#record_start

Defined Under Namespace

Modules: Channels, Format, Trim

Instance Attribute Summary

• #channels ⇒ Symbol, ...

  When dual, final audio file will be stereo recorded with the conference creator on the first channel, and the rest on the second channel.

• #command_id ⇒ String^?

  Use this field to avoid duplicate commands.

• #custom_file_name ⇒ String^?

  The custom recording file name to be used instead of the default call_leg_id.

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

  The audio file format used when storing the conference recording.

• #id ⇒ String
• #play_beep ⇒ Boolean^?

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

• #region ⇒ Symbol, ...

  Region where the conference data is located.

• #trim ⇒ Symbol, ...

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

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(id:, format_:, channels: nil, command_id: nil, custom_file_name: nil, play_beep: nil, region: nil, trim: nil, request_options: {}) ⇒ Object constructor

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

• #to_hash ⇒ {

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(id:, format_:, channels: nil, 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:

• id (String)
• format_ (Symbol, Telnyx::Models::Conferences::ActionRecordStartParams::Format) —

  The audio file format used when storing the conference recording. Can be either

• channels (Symbol, Telnyx::Models::Conferences::ActionRecordStartParams::Channels) (defaults to: nil) —

  When dual, final audio file will be stereo recorded with the conference creato

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

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

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

  The custom recording file name to be used instead of the default call_leg_id.

• play_beep (Boolean) (defaults to: nil) —

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

• region (Symbol, Telnyx::Models::Conferences::ConferenceRegion) (defaults to: nil) —

  Region where the conference data is located. Defaults to the region defined in u

• trim (Symbol, Telnyx::Models::Conferences::ActionRecordStartParams::Trim) (defaults to: nil) —

  When set to trim-silence, silence will be removed from the beginning and end o

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

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

Instance Attribute Details

#channels ⇒ Symbol, ...

When dual, final audio file will be stereo recorded with the conference creator on the first channel, and the rest on the second channel.

Returns:

• (Symbol, Telnyx::Models::Conferences::ActionRecordStartParams::Channels, nil)

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

optional :channels, enum: -> { Telnyx::Conferences::ActionRecordStartParams::Channels }

#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.

Parameters:

• (String)

Returns:

• (String, nil)

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

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.

Parameters:

• (String)

Returns:

• (String, nil)

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

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.

Parameters:

• value (Telnyx::Models::Conferences::ActionRecordStartParams::format_)

Returns:

• (Symbol, Telnyx::Models::Conferences::ActionRecordStartParams::Format)

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

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

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :id, String

#play_beep ⇒ Boolean^?

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

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

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

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:

• (Symbol, Telnyx::Models::Conferences::ConferenceRegion, nil)

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

optional :region, enum: -> { Telnyx::Conferences::ConferenceRegion }

#trim ⇒ Symbol, ...

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

Returns:

• (Symbol, Telnyx::Models::Conferences::ActionRecordStartParams::Trim, nil)

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

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 98

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/telnyx/models/conferences/action_record_start_params.rbs', line 67

def to_hash: -> {