Class: Aws::TranscribeStreamingService::EventStreams::AudioStream

Inherits:

Object

• Object
• Aws::TranscribeStreamingService::EventStreams::AudioStream

Defined in:

lib/aws-sdk-transcribestreamingservice/event_streams.rb,
lib/aws-sdk-transcribestreamingservice/event_streams.rb,
lib/aws-sdk-transcribestreamingservice/event_streams.rb

Instance Attribute Summary

• #event_emitter ⇒ Object readonly private

  Aws::EventEmitter.

Instance Method Summary

• #initialize ⇒ AudioStream constructor

  A new instance of AudioStream.

• #signal_audio_event_event(params = {}) ⇒ Object
• #signal_configuration_event_event(params = {}) ⇒ Object
• #signal_end_stream ⇒ Object

Constructor Details

#initialize ⇒ AudioStream

Returns a new instance of AudioStream.

# File 'lib/aws-sdk-transcribestreamingservice/event_streams.rb', line 14

def initialize
  @event_emitter = Aws::EventEmitter.new
end

Instance Attribute Details

#event_emitter ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns Aws::EventEmitter.

Returns:

• Aws::EventEmitter

# File 'lib/aws-sdk-transcribestreamingservice/event_streams.rb', line 68

def event_emitter
  @event_emitter
end

Instance Method Details

#signal_audio_event_event(params = {}) ⇒ Object

Parameters:

• params (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (params):

• :audio_chunk (String, StringIO, File) —

  An audio blob containing the next segment of audio from your application, with a maximum duration of 1 second. The maximum size in bytes varies based on audio properties.

  Find recommended size in [Transcribing streaming best practices].

  Size calculation: ‘Duration (s) * Sample Rate (Hz) * Number of Channels * 2 (Bytes per Sample)`

  For example, a 1-second chunk of 16 kHz, 2-channel, 16-bit audio would be ‘1 * 16000 * 2 * 2 = 64000 bytes`.

  For 8 kHz, 1-channel, 16-bit audio, a 1-second chunk would be ‘1 * 8000 * 1 * 2 = 16000 bytes`.

  [1]: docs.aws.amazon.com/transcribe/latest/dg/streaming.html#best-practices

# File 'lib/aws-sdk-transcribestreamingservice/event_streams.rb', line 38

def signal_audio_event_event(params = {})
  @event_emitter.emit(:audio_event, params)
end

#signal_configuration_event_event(params = {}) ⇒ Object

Parameters:

• params (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (params):

• :channel_definitions (Array<Types::ChannelDefinition>) —

  Indicates which speaker is on which audio channel.

• :post_call_analytics_settings (Types::PostCallAnalyticsSettings) —

  Provides additional optional settings for your Call Analytics post-call request, including encryption and output locations for your redacted transcript.

  ‘PostCallAnalyticsSettings` provides you with the same insights as a Call Analytics post-call transcription. Refer to [Post-call analytics] for more information on this feature.

  [1]: docs.aws.amazon.com/transcribe/latest/dg/tca-post-call.html

# File 'lib/aws-sdk-transcribestreamingservice/event_streams.rb', line 58

def signal_configuration_event_event(params = {})
  @event_emitter.emit(:configuration_event, params)
end

#signal_end_stream ⇒ Object

# File 'lib/aws-sdk-transcribestreamingservice/event_streams.rb', line 62

def signal_end_stream
  @event_emitter.emit(:end_stream, {})
end