Enum MedicalScribeInputStream

#[non_exhaustive]
pub enum MedicalScribeInputStream {
    AudioEvent(MedicalScribeAudioEvent),
    ConfigurationEvent(MedicalScribeConfigurationEvent),
    SessionControlEvent(MedicalScribeSessionControlEvent),
    Unknown,
}

An encoded stream of events. The stream is encoded as HTTP/2 data frames.

An input stream consists of the following types of events. The first element of the input stream must be the MedicalScribeConfigurationEvent event type.

• MedicalScribeConfigurationEvent

• MedicalScribeAudioEvent

• MedicalScribeSessionControlEvent

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

AudioEvent(MedicalScribeAudioEvent)

A wrapper for your audio chunks

For more information, see Event stream encoding.

ConfigurationEvent(MedicalScribeConfigurationEvent)

Specify additional streaming session configurations beyond those provided in your initial start request headers. For example, specify channel definitions, encryption settings, and post-stream analytics settings.

Whether you are starting a new session or resuming an existing session, your first event must be a MedicalScribeConfigurationEvent.

SessionControlEvent(MedicalScribeSessionControlEvent)

Specify the lifecycle of your streaming session, such as ending the session.

Unknown

The Unknown variant represents cases where new union variant was received. Consider upgrading the SDK to the latest available version. An unknown enum variant

Note: If you encounter this error, consider upgrading your SDK to the latest version. The Unknown variant represents cases where the server sent a value that wasn’t recognized by the client. This can happen when the server adds new functionality, but the client has not been updated. To investigate this, consider turning on debug logging to print the raw HTTP response.

Implementations

impl MedicalScribeInputStream

pub fn as_audio_event(&self) -> Result<&MedicalScribeAudioEvent, &Self>

Tries to convert the enum instance into AudioEvent, extracting the inner MedicalScribeAudioEvent. Returns Err(&Self) if it can’t be converted.

pub fn is_audio_event(&self) -> bool

Returns true if this is a AudioEvent.

pub fn as_configuration_event( &self, ) -> Result<&MedicalScribeConfigurationEvent, &Self>

Tries to convert the enum instance into ConfigurationEvent, extracting the inner MedicalScribeConfigurationEvent. Returns Err(&Self) if it can’t be converted.

pub fn is_configuration_event(&self) -> bool

Returns true if this is a ConfigurationEvent.

pub fn as_session_control_event( &self, ) -> Result<&MedicalScribeSessionControlEvent, &Self>

Tries to convert the enum instance into SessionControlEvent, extracting the inner MedicalScribeSessionControlEvent. Returns Err(&Self) if it can’t be converted.

pub fn is_session_control_event(&self) -> bool

Returns true if this is a SessionControlEvent.

pub fn is_unknown(&self) -> bool

Returns true if the enum instance is the Unknown variant.

Trait Implementations

impl Clone for MedicalScribeInputStream

fn clone(&self) -> MedicalScribeInputStream

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MedicalScribeInputStream

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for MedicalScribeInputStream

fn eq(&self, other: &MedicalScribeInputStream) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for MedicalScribeInputStream