startStream method

TranscriptionSession startStream({
  1. String? optsJson,
  2. int abortHandle = 0,
})

Start a streaming transcription session (RFC-0028) on this model. Requires a model that supports streaming (realtime models such as gpt-realtime-whisper).

optsJson — optional session options JSON ({"input_audio_format": {...}, "provider_options", "headers", "include_raw_chunks"}). abortHandle — optional abort handle; firing it aborts the session.

Implementation

TranscriptionSession startStream({String? optsJson, int abortHandle = 0}) {
  _checkOpen();
  checkJson(optsJson, 'opts_json', emptyIsDefault: true);
  final optsPtr = toCStringOrNull(optsJson);
  final int handle;
  try {
    handle = takeHandle(
        (out) =>
            _ffi.transcriptionSessionNew(_handle, abortHandle, optsPtr, out),
        'transcription_session_new');
  } finally {
    if (optsPtr != nullptr) calloc.free(optsPtr);
  }
  return TranscriptionSession._(handle);
}