Class: Aws::TranscribeStreamingService::Types::StartMedicalScribeStreamRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-transcribestreamingservice/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#input_stream ⇒ Types::MedicalScribeInputStream

Specify the input stream where you will send events in real time.

The first element of the input stream must be a ‘MedicalScribeConfigurationEvent`.

Returns:



1919
1920
1921
1922
1923
1924
1925
1926
1927
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1919

class StartMedicalScribeStreamRequest < Struct.new(
  :session_id,
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :input_stream)
  SENSITIVE = []
  include Aws::Structure
end

#language_code ⇒ String

Specify the language code for your HealthScribe streaming session.

Returns:

  • (String) 


1919
1920
1921
1922
1923
1924
1925
1926
1927
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1919

class StartMedicalScribeStreamRequest < Struct.new(
  :session_id,
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :input_stream)
  SENSITIVE = []
  include Aws::Structure
end

#media_encoding ⇒ String

Specify the encoding used for the input audio.

Supported formats are:

  • FLAC

  • OPUS-encoded audio in an Ogg container

  • PCM (only signed 16-bit little-endian audio formats, which does not include WAV)

For more information, see [Media formats].

[1]: docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio

Returns:

  • (String) 


1919
1920
1921
1922
1923
1924
1925
1926
1927
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1919

class StartMedicalScribeStreamRequest < Struct.new(
  :session_id,
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :input_stream)
  SENSITIVE = []
  include Aws::Structure
end

#media_sample_rate_hertz ⇒ Integer

Specify the sample rate of the input audio (in hertz). Amazon Web Services HealthScribe supports a range from 16,000 Hz to 48,000 Hz. The sample rate you specify must match that of your audio.

Returns:

  • (Integer) 


1919
1920
1921
1922
1923
1924
1925
1926
1927
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1919

class StartMedicalScribeStreamRequest < Struct.new(
  :session_id,
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :input_stream)
  SENSITIVE = []
  include Aws::Structure
end

#session_id ⇒ String

Specify an identifier for your streaming session (in UUID format). If you don’t include a SessionId in your request, Amazon Web Services HealthScribe generates an ID and returns it in the response.

Returns:

  • (String) 


1919
1920
1921
1922
1923
1924
1925
1926
1927
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1919

class StartMedicalScribeStreamRequest < Struct.new(
  :session_id,
  :language_code,
  :media_sample_rate_hertz,
  :media_encoding,
  :input_stream)
  SENSITIVE = []
  include Aws::Structure
end