transcribe

Documentation

Overview

Package transcribe provides real-time audio transcription using OpenAI's Realtime API. This is a stub implementation for non-macOS platforms.

Index

• Variables
• type Transcriber
  • func New(apiKey string) *Transcriber
  • func (t *Transcriber) IsRunning() bool
  • func (t *Transcriber) IsSupported() bool
  • func (t *Transcriber) Start(ctx context.Context, handler TranscriptHandler) error
  • func (t *Transcriber) Stop()
• type TranscriptHandler

Variables

var ErrNotSupported = errors.New("speech-to-text is only supported on macOS")

ErrNotSupported is returned when transcription is not supported on the current platform.

Types

type Transcriber

type Transcriber struct{}

Transcriber provides real-time audio transcription using OpenAI's Realtime API. On non-macOS platforms, this is a stub that returns errors.

func New

func New(apiKey string) *Transcriber

New creates a new Transcriber with the given OpenAI API key.

func (*Transcriber) IsRunning

func (t *Transcriber) IsRunning() bool

IsRunning always returns false on non-macOS platforms.

func (*Transcriber) IsSupported

func (t *Transcriber) IsSupported() bool

IsSupported returns false on non-macOS platforms.

func (*Transcriber) Start

func (t *Transcriber) Start(ctx context.Context, handler TranscriptHandler) error

Start returns ErrNotSupported on non-macOS platforms.

func (*Transcriber) Stop

func (t *Transcriber) Stop()

Stop is a no-op on non-macOS platforms.

type TranscriptHandler

type TranscriptHandler func(delta string)

TranscriptHandler is called when new transcription text is received.