Container for the parameters to the StartMedicalScribeStream operation. 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, 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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.TranscribeStreaming.AmazonTranscribeStreamingRequest
Amazon.TranscribeStreaming.Model.StartMedicalScribeStreamRequest
Namespace: Amazon.TranscribeStreaming.Model
Assembly: AWSSDK.TranscribeStreaming.dll
Version: 3.x.y.z
Syntax
public class StartMedicalScribeStreamRequest : AmazonTranscribeStreamingRequest IAmazonWebServiceRequest
The StartMedicalScribeStreamRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
StartMedicalScribeStreamRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
InputStreamPublisher | System.Func<System.Threading.Tasks.Task<Amazon.TranscribeStreaming.Model.IMedicalScribeInputStreamEvent>> |
Gets and sets the property InputStreamPublisher. Specify the input stream where you will send events in real time.
The first element of the input stream must be a 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 IMedicalScribeInputStreamEvent interface. The known implementatons in the SDK for this interface are: |
|
|
LanguageCode | Amazon.TranscribeStreaming.MedicalScribeLanguageCode |
Gets and sets the property LanguageCode. Specify the language code for your HealthScribe streaming session. |
|
|
MediaEncoding | Amazon.TranscribeStreaming.MedicalScribeMediaEncoding |
Gets and sets the property MediaEncoding. Specify the encoding used for the input audio. Supported formats are:
For more information, see Media formats. |
|
|
MediaSampleRateHertz | System.Nullable<System.Int32> |
Gets and sets the property MediaSampleRateHertz. 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. |
|
|
SessionId | System.String |
Gets and sets the property SessionId. 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. |
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