Class: Aws::TranscribeStreamingService::EventStreams::MedicalScribeInputStream

Inherits:
Object
  • Object
show all
Defined in:
lib/aws-sdk-transcribestreamingservice/event_streams.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ MedicalScribeInputStream

Returns a new instance of MedicalScribeInputStream.



74
75
76
 
# File 'lib/aws-sdk-transcribestreamingservice/event_streams.rb', line 74

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



186
187
188
 
# File 'lib/aws-sdk-transcribestreamingservice/event_streams.rb', line 186

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



98
99
100
 
# File 'lib/aws-sdk-transcribestreamingservice/event_streams.rb', line 98

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):

  • :vocabulary_name (String) —

    Specify the name of the custom vocabulary you want to use for your streaming session. Custom vocabulary names are case-sensitive.

  • :vocabulary_filter_name (String) —

    Specify the name of the custom vocabulary filter you want to include in your streaming session. Custom vocabulary filter names are case-sensitive.

    If you include ‘VocabularyFilterName` in the `MedicalScribeConfigurationEvent`, you must also include `VocabularyFilterMethod`.

  • :vocabulary_filter_method (String) —

    Specify how you want your custom vocabulary filter applied to the streaming session.

    To replace words with ‘***`, specify `mask`.

    To delete words, specify ‘remove`.

    To flag words without changing them, specify ‘tag`.

  • :resource_access_role_arn (String) —

    The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 output bucket you specified, and use your KMS key if supplied. If the role that you specify doesn’t have the appropriate permissions, your request fails.

    IAM role ARNs have the format ‘arn:partition:iam::account:role/role-name-with-path`. For example: `arn:aws:iam::111122223333:role/Admin`.

    For more information, see [Amazon Web Services HealthScribe].

    [1]: docs.aws.amazon.com/transcribe/latest/dg/health-scribe-streaming.html

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

    Specify which speaker is on which audio channel.

  • :encryption_settings (Types::MedicalScribeEncryptionSettings) —

    Specify the encryption settings for your streaming session.

  • :post_stream_analytics_settings (Types::MedicalScribePostStreamAnalyticsSettings) —

    Specify settings for post-stream analytics.



176
177
178
 
# File 'lib/aws-sdk-transcribestreamingservice/event_streams.rb', line 176

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

#signal_end_stream ⇒ Object 



180
181
182
 
# File 'lib/aws-sdk-transcribestreamingservice/event_streams.rb', line 180

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

#signal_session_control_event_event(params = {}) ⇒ Object

Parameters:

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

    a customizable set of options

Options Hash (params):



124
125
126
 
# File 'lib/aws-sdk-transcribestreamingservice/event_streams.rb', line 124

def signal_session_control_event_event(params = {})
  @event_emitter.emit(:session_control_event, params)
end