Class: OpenAI::Models::Realtime::RealtimeTranslationOutputAudioDeltaEvent

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/realtime/realtime_translation_output_audio_delta_event.rb

Defined Under Namespace

Modules: Format

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(delta:, event_id:, channels: nil, elapsed_ms: nil, format_: nil, sample_rate: nil, type: :"session.output_audio.delta") ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Realtime::RealtimeTranslationOutputAudioDeltaEvent for more details.

Returned when translated output audio is available. Output audio deltas are 200 ms frames of PCM16 audio.

Parameters:

  • delta (String) —

    Base64-encoded translated audio data.

  • event_id (String) —

    The unique ID of the server event.

  • channels (Integer) (defaults to: nil) —

    Number of audio channels.

  • elapsed_ms (Integer, nil) (defaults to: nil) —

    Timing metadata for stream alignment, derived from the translation frame

  • format_ (Symbol, OpenAI::Models::Realtime::RealtimeTranslationOutputAudioDeltaEvent::Format) (defaults to: nil) —

    Audio encoding for ‘delta`.

  • sample_rate (Integer) (defaults to: nil) —

    Sample rate of the audio delta.

  • type (Symbol, :"session.output_audio.delta") (defaults to: :"session.output_audio.delta") —

    The event type, must be ‘session.output_audio.delta`.




# File 'lib/openai/models/realtime/realtime_translation_output_audio_delta_event.rb', line 53

Instance Attribute Details

#channels ⇒ Integer?

Number of audio channels.

Returns:

  • (Integer, nil) 


29
 
# File 'lib/openai/models/realtime/realtime_translation_output_audio_delta_event.rb', line 29

optional :channels, Integer

#delta ⇒ String

Base64-encoded translated audio data.

Returns:

  • (String) 


11
 
# File 'lib/openai/models/realtime/realtime_translation_output_audio_delta_event.rb', line 11

required :delta, String

#elapsed_ms ⇒ Integer?

Timing metadata for stream alignment, derived from the translation frame when available. Treat ‘elapsed_ms` as alignment metadata, not a unique event identifier.

Returns:

  • (Integer, nil) 


37
 
# File 'lib/openai/models/realtime/realtime_translation_output_audio_delta_event.rb', line 37

optional :elapsed_ms, Integer, nil?: true

#event_id ⇒ String

The unique ID of the server event.

Returns:

  • (String) 


17
 
# File 'lib/openai/models/realtime/realtime_translation_output_audio_delta_event.rb', line 17

required :event_id, String

#format_ ⇒ Symbol, ...

Audio encoding for ‘delta`.

Returns:



43
44
45
 
# File 'lib/openai/models/realtime/realtime_translation_output_audio_delta_event.rb', line 43

optional :format_,
enum: -> { OpenAI::Realtime::RealtimeTranslationOutputAudioDeltaEvent::Format },
api_name: :format

#sample_rate ⇒ Integer?

Sample rate of the audio delta.

Returns:

  • (Integer, nil) 


51
 
# File 'lib/openai/models/realtime/realtime_translation_output_audio_delta_event.rb', line 51

optional :sample_rate, Integer

#type ⇒ Symbol, :"session.output_audio.delta"

The event type, must be ‘session.output_audio.delta`.

Returns:

  • (Symbol, :"session.output_audio.delta") 


23
 
# File 'lib/openai/models/realtime/realtime_translation_output_audio_delta_event.rb', line 23

required :type, const: :"session.output_audio.delta"