commonMain.aws.sdk.kotlin.services.transcribestreaming.model.AudioStream.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of transcribestreaming-jvm Show documentation

The AWS SDK for Kotlin client for Transcribe Streaming

The newest version!

// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.transcribestreaming.model



/**
 * An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or WebSocket data frames.
 *
 * For more information, see [Transcribing streaming audio](https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html).
 */
public sealed class AudioStream {
    /**
     * A blob of audio from your application. Your audio stream consists of one or more audio events.
     *
     * For more information, see [Event stream encoding](https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html).
     */
    public data class AudioEvent(val value: aws.sdk.kotlin.services.transcribestreaming.model.AudioEvent) : aws.sdk.kotlin.services.transcribestreaming.model.AudioStream() {
    }

    /**
     * Contains audio channel definitions and post-call analytics settings.
     */
    public data class ConfigurationEvent(val value: aws.sdk.kotlin.services.transcribestreaming.model.ConfigurationEvent) : aws.sdk.kotlin.services.transcribestreaming.model.AudioStream() {
    }

    public object SdkUnknown : aws.sdk.kotlin.services.transcribestreaming.model.AudioStream() {
    }

    /**
     * Casts this [AudioStream] as a [AudioEvent] and retrieves its [aws.sdk.kotlin.services.transcribestreaming.model.AudioEvent] value. Throws an exception if the [AudioStream] is not a
     * [AudioEvent].
     */
    public fun asAudioEvent(): aws.sdk.kotlin.services.transcribestreaming.model.AudioEvent = (this as AudioStream.AudioEvent).value

    /**
     * Casts this [AudioStream] as a [AudioEvent] and retrieves its [aws.sdk.kotlin.services.transcribestreaming.model.AudioEvent] value. Returns null if the [AudioStream] is not a [AudioEvent].
     */
    public fun asAudioEventOrNull(): aws.sdk.kotlin.services.transcribestreaming.model.AudioEvent? = (this as? AudioStream.AudioEvent)?.value

    /**
     * Casts this [AudioStream] as a [ConfigurationEvent] and retrieves its [aws.sdk.kotlin.services.transcribestreaming.model.ConfigurationEvent] value. Throws an exception if the [AudioStream] is not a
     * [ConfigurationEvent].
     */
    public fun asConfigurationEvent(): aws.sdk.kotlin.services.transcribestreaming.model.ConfigurationEvent = (this as AudioStream.ConfigurationEvent).value

    /**
     * Casts this [AudioStream] as a [ConfigurationEvent] and retrieves its [aws.sdk.kotlin.services.transcribestreaming.model.ConfigurationEvent] value. Returns null if the [AudioStream] is not a [ConfigurationEvent].
     */
    public fun asConfigurationEventOrNull(): aws.sdk.kotlin.services.transcribestreaming.model.ConfigurationEvent? = (this as? AudioStream.ConfigurationEvent)?.value
}