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.

Implementation for accessing TranscribeStreaming

Amazon Transcribe streaming offers four main types of real-time transcription: Standard, Medical, Call Analytics, and Health Scribe.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.TranscribeStreaming.AmazonTranscribeStreamingClient

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

Syntax

C# 
public class AmazonTranscribeStreamingClient : AmazonServiceClient
         IAmazonService, IAmazonTranscribeStreaming, IDisposable

The AmazonTranscribeStreamingClient type exposes the following members

Constructors

NameDescription
Public Method AmazonTranscribeStreamingClient()

Constructs AmazonTranscribeStreamingClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

Public Method AmazonTranscribeStreamingClient(RegionEndpoint)

Constructs AmazonTranscribeStreamingClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

Public Method AmazonTranscribeStreamingClient(AmazonTranscribeStreamingConfig)

Constructs AmazonTranscribeStreamingClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set. 

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSProfileName" value="AWS Default"/>
    </appSettings>
</configuration>

Public Method AmazonTranscribeStreamingClient(AWSCredentials)

Constructs AmazonTranscribeStreamingClient with AWS Credentials

Public Method AmazonTranscribeStreamingClient(AWSCredentials, RegionEndpoint)

Constructs AmazonTranscribeStreamingClient with AWS Credentials

Public Method AmazonTranscribeStreamingClient(AWSCredentials, AmazonTranscribeStreamingConfig)

Constructs AmazonTranscribeStreamingClient with AWS Credentials and an AmazonTranscribeStreamingClient Configuration object.

Public Method AmazonTranscribeStreamingClient(string, string)

Constructs AmazonTranscribeStreamingClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonTranscribeStreamingClient(string, string, RegionEndpoint)

Constructs AmazonTranscribeStreamingClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonTranscribeStreamingClient(string, string, AmazonTranscribeStreamingConfig)

Constructs AmazonTranscribeStreamingClient with AWS Access Key ID, AWS Secret Key and an AmazonTranscribeStreamingClient Configuration object.

Public Method AmazonTranscribeStreamingClient(string, string, string)

Constructs AmazonTranscribeStreamingClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonTranscribeStreamingClient(string, string, string, RegionEndpoint)

Constructs AmazonTranscribeStreamingClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonTranscribeStreamingClient(string, string, string, AmazonTranscribeStreamingConfig)

Constructs AmazonTranscribeStreamingClient with AWS Access Key ID, AWS Secret Key and an AmazonTranscribeStreamingClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.7.2 or higher.

NameDescription
Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetMedicalScribeStream(GetMedicalScribeStreamRequest)

Provides details about the specified Amazon Web Services HealthScribe streaming session. To view the status of the streaming session, check the StreamStatus field in the response. To get the details of post-stream analytics, including its status, check the PostStreamAnalyticsResult field in the response.

Public Method GetMedicalScribeStreamAsync(GetMedicalScribeStreamRequest, CancellationToken)

Provides details about the specified Amazon Web Services HealthScribe streaming session. To view the status of the streaming session, check the StreamStatus field in the response. To get the details of post-stream analytics, including its status, check the PostStreamAnalyticsResult field in the response.

Public Method StartCallAnalyticsStreamTranscriptionAsync(StartCallAnalyticsStreamTranscriptionRequest, CancellationToken)

Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to Amazon Transcribe and the transcription results are streamed to your application. Use this operation for Call Analytics transcriptions.

The following parameters are required:

  • language-code or identify-language

  • media-encoding

  • sample-rate

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

Public Method StartMedicalScribeStreamAsync(StartMedicalScribeStreamRequest, CancellationToken)

Starts a bidirectional HTTP/2 stream, where audio is streamed to Amazon Web Services HealthScribe and the transcription results are streamed to your application.

When you start a stream, you first specify the stream configuration in a MedicalScribeConfigurationEvent. This event includes channel definitions, encryption settings, medical scribe context, and post-stream analytics settings, such as the output configuration for aggregated transcript and clinical note generation. These are additional streaming session configurations beyond those provided in your initial start request headers. Whether you are starting a new session or resuming an existing session, your first event must be a MedicalScribeConfigurationEvent.

After you send a MedicalScribeConfigurationEvent, you start AudioEvents and Amazon Web Services HealthScribe responds with real-time transcription results. When you are finished, to start processing the results with the post-stream analytics, send a MedicalScribeSessionControlEvent with a Type of END_OF_SESSION and Amazon Web Services HealthScribe starts the analytics.

You can pause or resume streaming. To pause streaming, complete the input stream without sending the MedicalScribeSessionControlEvent. To resume streaming, call the StartMedicalScribeStream and specify the same SessionId you used to start the stream.

The following parameters are required:

  • language-code

  • media-encoding

  • media-sample-rate-hertz

For more information on streaming with Amazon Web Services HealthScribe, see Amazon Web Services HealthScribe.

Public Method StartMedicalStreamTranscriptionAsync(StartMedicalStreamTranscriptionRequest, CancellationToken)

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:

  • language-code

  • media-encoding

  • sample-rate

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

Public Method StartStreamTranscriptionAsync(StartStreamTranscriptionRequest, CancellationToken)

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

The following parameters are required:

  • language-code or identify-language or identify-multiple-language

  • media-encoding

  • sample-rate

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

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

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