AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the StartMedicalStreamTranscription operation. Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe Medical and the transcription results are streamed to your application.

The following parameters are required:

For more information on streaming with Amazon Transcribe Medical, see Transcribing streaming audio.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.TranscribeStreaming.AmazonTranscribeStreamingRequest
      Amazon.TranscribeStreaming.Model.StartMedicalStreamTranscriptionRequest

Namespace: Amazon.TranscribeStreaming.Model
Assembly: AWSSDK.TranscribeStreaming.dll
Version: 3.x.y.z

Syntax

C#
public class StartMedicalStreamTranscriptionRequest : AmazonTranscribeStreamingRequest
         IAmazonWebServiceRequest

The StartMedicalStreamTranscriptionRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AudioStreamPublisher System.Func<System.Threading.Tasks.Task<Amazon.TranscribeStreaming.Model.IAudioStreamEvent>>

Gets and sets the property AudioStreamPublisher.

The Func set for this property by the consumer of the SDK is used to stream events into the service. Consumers provide a Func that the SDK will continue to call to get events to send. When the consumer is done streaming events to the service the Func can return null to stop the SDK calling the Func for new events. The Func must return an event known by the service which can be identified by implementing the IAudioStreamEvent interface. The known implementatons in the SDK for this interface are: Amazon.TranscribeStreaming.Model.AudioEvent Amazon.TranscribeStreaming.Model.ConfigurationEvent

Public Property ContentIdentificationType Amazon.TranscribeStreaming.MedicalContentIdentificationType

Gets and sets the property ContentIdentificationType.

Labels all personal health information (PHI) identified in your transcript.

Content identification is performed at the segment level; PHI is flagged upon complete transcription of an audio segment.

For more information, see Identifying personal health information (PHI) in a transcription.

Public Property EnableChannelIdentification System.Nullable<System.Boolean>

Gets and sets the property EnableChannelIdentification.

Enables channel identification in multi-channel audio.

Channel identification transcribes the audio on each channel independently, then appends the output for each channel into one transcript.

If you have multi-channel audio and do not enable channel identification, your audio is transcribed in a continuous manner and your transcript is not separated by channel.

If you include EnableChannelIdentification in your request, you must also include NumberOfChannels.

For more information, see Transcribing multi-channel audio.

Public Property LanguageCode Amazon.TranscribeStreaming.LanguageCode

Gets and sets the property LanguageCode.

Specify the language code that represents the language spoken in your audio.

Amazon Transcribe Medical only supports US English (en-US).

Public Property MediaEncoding Amazon.TranscribeStreaming.MediaEncoding

Gets and sets the property MediaEncoding.

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.

Public Property MediaSampleRateHertz System.Nullable<System.Int32>

Gets and sets the property MediaSampleRateHertz.

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

Public Property NumberOfChannels System.Nullable<System.Int32>

Gets and sets the property NumberOfChannels.

Specify the number of channels in your audio stream. This value must be 2, as only two channels are supported. If your audio doesn't contain multiple channels, do not include this parameter in your request.

If you include NumberOfChannels in your request, you must also include EnableChannelIdentification.

Public Property SessionId System.String

Gets and sets the property SessionId.

Specify a name for your transcription session. If you don't include this parameter in your request, Amazon Transcribe Medical generates an ID and returns it in the response.

Public Property ShowSpeakerLabel System.Nullable<System.Boolean>

Gets and sets the property ShowSpeakerLabel.

Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.

For more information, see Partitioning speakers (diarization).

Public Property Specialty Amazon.TranscribeStreaming.Specialty

Gets and sets the property Specialty.

Specify the medical specialty contained in your audio.

Public Property Type Amazon.TranscribeStreaming.Type

Gets and sets the property Type.

Specify the type of input audio. For example, choose DICTATION for a provider dictating patient notes and CONVERSATION for a dialogue between a patient and a medical professional.

Public Property VocabularyName System.String

Gets and sets the property VocabularyName.

Specify the name of the custom vocabulary that you want to use when processing your transcription. Note that vocabulary names are case sensitive.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer