Amazon Transcribe Streaming examples using SDK for Swift
The following code examples show you how to perform actions and implement common scenarios by using the AWS SDK for Swift with Amazon Transcribe Streaming.
Actions are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Scenarios are code examples that show you how to accomplish specific tasks by calling multiple functions within a service or combined with other AWS services.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
Actions
The following code example shows how to use StartStreamTranscription
.
- SDK for Swift
-
Note
There's more on GitHub. Find the complete example and learn how to set up and run in the AWS Code Examples Repository
. let client = TranscribeStreamingClient( config: try await TranscribeStreamingClient.TranscribeStreamingClientConfiguration( region: region ) ) // Start the transcription running on the audio stream. let output = try await client.startStreamTranscription( input: StartStreamTranscriptionInput( audioStream: try await createAudioStream(), languageCode: TranscribeStreamingClientTypes.LanguageCode(rawValue: lang), mediaEncoding: mediaEncoding, mediaSampleRateHertz: sampleRate ) )
-
For API details, see StartStreamTranscription
in AWS SDK for Swift API reference.
-
Scenarios
The following code example shows how to generate a transcription of a source audio file using Amazon Transcribe streaming.
- SDK for Swift
-
Note
There's more on GitHub. Find the complete example and learn how to set up and run in the AWS Code Examples Repository
. Use Amazon Transcribe streaming to transcribe the spoken language in an audio file.
/// An example that demonstrates how to watch an transcribe event stream to /// transcribe audio from a file to the console. import ArgumentParser import AWSClientRuntime import AWSTranscribeStreaming import Foundation /// Identify one of the media file formats supported by Amazon Transcribe. enum TranscribeFormat: String, ExpressibleByArgument { case ogg = "ogg" case pcm = "pcm" case flac = "flac" } // -MARK: - Async command line tool struct ExampleCommand: ParsableCommand { // -MARK: Command arguments @Flag(help: "Show partial results") var showPartial = false @Option(help: "Language code to transcribe into") var lang: String = "en-US" @Option(help: "Format of the source audio file") var format: TranscribeFormat @Option(help: "Sample rate of the source audio file in Hertz") var sampleRate: Int = 16000 @Option(help: "Path of the source audio file") var path: String @Option(help: "Name of the Amazon S3 Region to use (default: us-east-1)") var region = "us-east-1" static var configuration = CommandConfiguration( commandName: "tsevents", abstract: """ This example shows how to use event streaming with Amazon Transcribe. """, discussion: """ """ ) /// Create and return an Amazon Transcribe audio stream from the file /// specified in the arguments. /// /// - Throws: Errors from `TranscribeError`. /// /// - Returns: `AsyncThrowingStream<TranscribeStreamingClientTypes.AudioStream, Error>` func createAudioStream() async throws -> AsyncThrowingStream<TranscribeStreamingClientTypes.AudioStream, Error> { let fileURL: URL = URL(fileURLWithPath: path) let audioData = try Data(contentsOf: fileURL) // Properties defining the size of audio chunks and the total size of // the audio file in bytes. You should try to send chunks that last on // average 125 milliseconds. let chunkSizeInMilliseconds = 125.0 let chunkSize = Int(chunkSizeInMilliseconds / 1000.0 * Double(sampleRate) * 2.0) let audioDataSize = audioData.count // Create an audio stream from the source data. The stream's job is // to send the audio in chunks to Amazon Transcribe as // `AudioStream.audioevent` events. let audioStream = AsyncThrowingStream<TranscribeStreamingClientTypes.AudioStream, Error> { continuation in Task { var currentStart = 0 var currentEnd = min(chunkSize, audioDataSize - currentStart) // Generate and send chunks of audio data as `audioevent` // events until the entire file has been sent. Each event is // yielded to the SDK after being created. while currentStart < audioDataSize { let dataChunk = audioData[currentStart ..< currentEnd] let audioEvent = TranscribeStreamingClientTypes.AudioStream.audioevent( .init(audioChunk: dataChunk) ) let yieldResult = continuation.yield(audioEvent) switch yieldResult { case .enqueued(_): // The chunk was successfully enqueued into the // stream. The `remaining` parameter estimates how // much room is left in the queue, but is ignored here. break case .dropped(_): // The chunk was dropped because the queue buffer // is full. This will cause transcription errors. print("Warning: Dropped audio! The transcription will be incomplete.") case .terminated: print("Audio stream terminated.") continuation.finish() return default: print("Warning: Unrecognized response during audio streaming.") } currentStart = currentEnd currentEnd = min(currentStart + chunkSize, audioDataSize) } // Let the SDK's continuation block know the stream is over. continuation.finish() } } return audioStream } /// Run the transcription process. /// /// - Throws: An error from `TranscribeError`. func transcribe() async throws { // Convert the value of the `--format` option into the Transcribe // Streaming `MediaEncoding` type. let mediaEncoding: TranscribeStreamingClientTypes.MediaEncoding switch format { case .flac: mediaEncoding = .flac case .ogg: mediaEncoding = .oggOpus case .pcm: mediaEncoding = .pcm } // Create the Transcribe Streaming client. let client = TranscribeStreamingClient( config: try await TranscribeStreamingClient.TranscribeStreamingClientConfiguration( region: region ) ) // Start the transcription running on the audio stream. let output = try await client.startStreamTranscription( input: StartStreamTranscriptionInput( audioStream: try await createAudioStream(), languageCode: TranscribeStreamingClientTypes.LanguageCode(rawValue: lang), mediaEncoding: mediaEncoding, mediaSampleRateHertz: sampleRate ) ) // Iterate over the events in the returned transcript result stream. // Each `transcriptevent` contains a list of result fragments which // need to be concatenated together to build the final transcript. for try await event in output.transcriptResultStream! { switch event { case .transcriptevent(let event): for result in event.transcript?.results ?? [] { guard let transcript = result.alternatives?.first?.transcript else { continue } // If showing partial results is enabled and the result is // partial, show it. Partial results may be incomplete, and // may be inaccurate, with upcoming audio making the // transcription complete or by giving more context to make // transcription make more sense. if (result.isPartial && showPartial) { print("[Partial] \(transcript)") } // When the complete fragment of transcribed text is ready, // print it. This could just as easily be used to draw the // text as a subtitle over a playing video, though timing // would need to be managed. if !result.isPartial { if (showPartial) { print("[Final ] ", terminator: "") } print(transcript) } } default: print("Error: Unexpected message from Amazon Transcribe:") } } } } // -MARK: - Entry point /// The program's asynchronous entry point. @main struct Main { static func main() async { let args = Array(CommandLine.arguments.dropFirst()) do { let command = try ExampleCommand.parse(args) try await command.transcribe() } catch let error as TranscribeError { print("ERROR: \(error.errorDescription ?? "Unknown error")") } catch { ExampleCommand.exit(withError: error) } } } /// Errors thrown by the example's functions. enum TranscribeError: Error { /// No transcription stream available. case noTranscriptionStream /// The source media file couldn't be read. case readError var errorDescription: String? { switch self { case .noTranscriptionStream: return "No transcription stream returned by Amazon Transcribe." case .readError: return "Unable to read the source audio file." } } }
-
For API details, see StartStreamTranscription
in AWS SDK for Swift API reference.
-