Class: OpenAI::Models::Live::SessionResource::Audio

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Live::SessionResource::Audio

Defined in:

lib/openai/models/live/session_resource.rb,
sig/openai/models/live/session_resource.rbs

Overview

See Also:

• OpenAI::Models::Live::SessionResource#audio

Defined Under Namespace

Classes: Output

Instance Attribute Summary

• #format_ ⇒ OpenAI::Models::Live::AudioFormat::AudioPCM, ...

  Audio encoding and sample rate for audio sent and received over a Live WebSocket connection.

• #output ⇒ OpenAI::Models::Live::SessionResource::Audio::Output^?

  The voice used for speech generated by the Live model.

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary

• #initialize(format_: nil, output: nil) ⇒ Object constructor

  Startup audio configuration.

• #to_hash ⇒ {

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, 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, coerce_with_error, 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_: nil, output: nil) ⇒ Object

Startup audio configuration. Only primary WebSockets accept audio.format; WebRTC and SIP negotiate their media format. Voice and format are immutable after startup.

Parameters:

• format_ (OpenAI::Models::Live::AudioFormat::AudioPCM, OpenAI::Models::Live::AudioFormat::AudioPCMU, OpenAI::Models::Live::AudioFormat::AudioPCMA) (defaults to: nil) —

  Audio encoding and sample rate for audio sent and received over a Live WebSocket connection. WebRTC and SIP negotiate their media format separately.

• output (OpenAI::Models::Live::SessionResource::Audio::Output) (defaults to: nil) —

  The voice used for speech generated by the Live model.

# File 'lib/openai/models/live/session_resource.rb', line 174

Instance Attribute Details

#format_ ⇒ OpenAI::Models::Live::AudioFormat::AudioPCM, ...

Audio encoding and sample rate for audio sent and received over a Live WebSocket connection. WebRTC and SIP negotiate their media format separately.

Returns:

• (OpenAI::Models::Live::AudioFormat::AudioPCM, OpenAI::Models::Live::AudioFormat::AudioPCMU, OpenAI::Models::Live::AudioFormat::AudioPCMA, nil)

# File 'lib/openai/models/live/session_resource.rb', line 166

optional :format_, union: -> { OpenAI::Live::AudioFormat }, api_name: :format

#output ⇒ OpenAI::Models::Live::SessionResource::Audio::Output^?

The voice used for speech generated by the Live model.

Returns:

• (OpenAI::Models::Live::SessionResource::Audio::Output, nil)

# File 'lib/openai/models/live/session_resource.rb', line 172

optional :output, -> { OpenAI::Live::SessionResource::Audio::Output }

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/openai/models/live/session_resource.rbs', line 111

def to_hash: -> {