voice

Documentation

Index

• func Available() bool
• type Engine
  • func New(openAIKey string) *Engine
  • func (e *Engine) Record(outPath string) error
  • func (e *Engine) RecordCtx(ctx context.Context, outPath string) error
  • func (e *Engine) RecordFixed(outPath string, seconds int) error
  • func (e *Engine) Transcribe(audioPath string) (string, error)
  • func (e *Engine) TranscribeCtx(ctx context.Context, audioPath string) (string, error)
  • func (e *Engine) TranscribeReader(audio io.Reader, filename string) (string, error)
  • func (e *Engine) TranscribeReaderCtx(ctx context.Context, audio io.Reader, filename string) (string, error)

Functions

func Available

func Available() bool

Available checks if sox/rec is installed.

Types

type Engine

type Engine struct {
	// contains filtered or unexported fields
}

func New

func New(openAIKey string) *Engine

func (*Engine) Record

func (e *Engine) Record(outPath string) error

Record captures audio from the microphone using sox. Equivalent to RecordCtx with context.Background(); kept for back-compat.

Deprecated: prefer RecordCtx so the REPL's turn ctx can abort a stuck recording (Ctrl+C cancels mid-flight instead of waiting for silence).

func (*Engine) RecordCtx

func (e *Engine) RecordCtx(ctx context.Context, outPath string) error

RecordCtx captures audio from the microphone using sox until the silence detector fires or the recordTimeout fallback expires. The caller's ctx is honoured: cancelling it kills the rec process. Records 16kHz mono WAV, stops after 1s of silence.

func (*Engine) RecordFixed

func (e *Engine) RecordFixed(outPath string, seconds int) error

RecordFixed captures audio for a fixed duration in seconds.

func (*Engine) Transcribe

func (e *Engine) Transcribe(audioPath string) (string, error)

Transcribe sends audio to OpenAI Whisper API and returns the text. Equivalent to TranscribeCtx with context.Background().

Deprecated: prefer TranscribeCtx so a network hang can be cancelled.

func (*Engine) TranscribeCtx

func (e *Engine) TranscribeCtx(ctx context.Context, audioPath string) (string, error)

TranscribeCtx is the ctx-aware variant of Transcribe.

func (*Engine) TranscribeReader

func (e *Engine) TranscribeReader(audio io.Reader, filename string) (string, error)

TranscribeReader sends audio from a reader to OpenAI Whisper API. Equivalent to TranscribeReaderCtx with context.Background().

Deprecated: prefer TranscribeReaderCtx — without a cancellable ctx the only timeout is the HTTP client's Timeout field.

func (*Engine) TranscribeReaderCtx

func (e *Engine) TranscribeReaderCtx(ctx context.Context, audio io.Reader, filename string) (string, error)

TranscribeReaderCtx sends audio from a reader to OpenAI Whisper API. Honours ctx — cancelling it aborts the in-flight HTTP request so the REPL can return immediately on Ctrl+C even if the API hangs.