frames

package

Go to main page

Versions in this module

v0

v0.1.0

Aug 30, 2026

Changes in this version

+ const AsyncToolInstructions

+ const AsyncToolPayloadType

+ const AsyncToolStatusFinished

+ const AsyncToolStatusRunning

+ const DefaultAudioInSampleRate

+ const DefaultAudioOutSampleRate

+ const DefaultSummarizationPrompt

+ const DefaultSummarizationTimeout

+ const DefaultSummaryMessageTemplate

+ const ToolResultInProgress

+ const UserTurnCompleteMarker

+ const UserTurnIncompleteLongMarker

+ const UserTurnIncompleteShortMarker

+ var ErrMaxContextTokens = errors.New("MaxContextTokens must be positive")

+ var ErrMaxUnsummarizedMessages = errors.New("MaxUnsummarizedMessages must be at least 1")

+ var ErrMinMessagesAfterSummary = errors.New("MinMessagesAfterSummary must be non-negative")

+ var ErrNoSummarizationThreshold = errors.New("at least one of MaxContextTokens and MaxUnsummarizedMessages must be set")

+ var ErrTargetContextTokens = errors.New("TargetContextTokens must be positive")

+ func AddTokens(count *int64, n int64) *int64

+ func KeypadString(buttons []KeypadEntry) string

+ func NowTimestamp() string

+ func StripUserTurnMarkers(text string, extra ...string) string

+ func TokenCount(count *int64) (int64, bool)

+ type AdapterType string

+ const AdapterTypeGemini

+ const AdapterTypeOpenAI

+ type AggregatedTextFrame struct

+ AggregatedBy AggregationType

+ ContextID string

+ RawText string

+ WillBeSpoken bool

+ func NewAggregatedTextFrame(text string, by AggregationType) *AggregatedTextFrame

+ func (f *AggregatedTextFrame) String() string

+ type AggregatedTextProgressFrame struct

+ AccumulatedText string

+ AggregatedBy AggregationType

+ ContextID string

+ RemainingText string

+ SegmentID uint64

+ Text string

+ func NewAggregatedTextProgressFrame(segmentID uint64, contextID, text string, by AggregationType, ...) *AggregatedTextProgressFrame

+ func (f *AggregatedTextProgressFrame) String() string

+ type AggregationType string

+ const AggregationSentence

+ const AggregationToken

+ const AggregationWord

+ const AnyAggregation

+ type AsyncToolKind string

+ const AsyncToolFinal

+ const AsyncToolIntermediate

+ const AsyncToolStarted

+ type AsyncToolMessage struct

+ Description string

+ HasResult bool

+ Kind AsyncToolKind

+ Result string

+ Status string

+ ToolCallID string

+ func ParseAsyncToolMessage(m Message) (AsyncToolMessage, bool)

+ type AudioFrame interface

+ AudioData func() *AudioRawData

type AudioRawData

+ func (a *AudioRawData) AudioData() *AudioRawData

+ type AutoSummarizationConfig struct

+ MaxContextTokens *int

+ MaxUnsummarizedMessages *int

+ SummaryConfig SummaryConfig

+ func NewAutoSummarizationConfig() AutoSummarizationConfig

+ func (c AutoSummarizationConfig) Validate() error

+ func (c AutoSummarizationConfig) WithDefaults() AutoSummarizationConfig

type BaseFrame

+ func (f *BaseFrame) Base() *BaseFrame

+ type BaseMetricsData struct

+ Model string

+ Processor string

+ func (d BaseMetricsData) MetricsModel() string

+ func (d BaseMetricsData) MetricsProcessor() string

+ type BaseSwitcherFrame struct

+ func NewBaseSwitcherFrame(typeName string) BaseSwitcherFrame

+ type BotConnectedFrame struct

+ func NewBotConnectedFrame() *BotConnectedFrame

+ type CancelWorkerFrame struct

+ Reason string

+ func NewCancelWorkerFrame() *CancelWorkerFrame

+ func (f *CancelWorkerFrame) String() string

+ type ClientConnectedFrame struct

+ func NewClientConnectedFrame() *ClientConnectedFrame

+ type DTMFOutput interface

+ Keys func() []KeypadEntry

+ type EndWorkerFrame struct

+ Reason string

+ func NewEndWorkerFrame() *EndWorkerFrame

+ func (f *EndWorkerFrame) String() string

type ErrorFrame

+ Category errors.Category

+ func (f *ErrorFrame) ErrorInfo() *ErrorFrame

+ type ErrorReport interface

+ ErrorInfo func() *ErrorFrame

type ErrorSource

+ Usable func() bool

+ type FatalErrorFrame struct

+ func NewFatalErrorFrame(message string) *FatalErrorFrame

+ type FilterControlBase struct

+ type FilterControlFrame interface

+ type FilterEnableFrame struct

+ Enable bool

+ func NewFilterEnableFrame(enable bool) *FilterEnableFrame

+ func (f *FilterEnableFrame) String() string

+ type FilterUpdateSettingsFrame struct

+ Settings map[string]any

+ func NewFilterUpdateSettingsFrame(settings map[string]any) *FilterUpdateSettingsFrame

+ func (f *FilterUpdateSettingsFrame) String() string

type Frame

+ Base func() *BaseFrame

+ type FrameProcessorPauseFrame struct

+ Processor ProcessorTarget

+ func NewFrameProcessorPauseFrame(p ProcessorTarget) *FrameProcessorPauseFrame

+ type FrameProcessorPauseUrgentFrame struct

+ Processor ProcessorTarget

+ func NewFrameProcessorPauseUrgentFrame(p ProcessorTarget) *FrameProcessorPauseUrgentFrame

+ type FrameProcessorResumeFrame struct

+ Processor ProcessorTarget

+ func NewFrameProcessorResumeFrame(p ProcessorTarget) *FrameProcessorResumeFrame

+ type FrameProcessorResumeUrgentFrame struct

+ Processor ProcessorTarget

+ func NewFrameProcessorResumeUrgentFrame(p ProcessorTarget) *FrameProcessorResumeUrgentFrame

type FunctionCallCancelFrame

+ RunLLM bool

type FunctionCallInProgressFrame

+ Args json.RawMessage

+ CancelOnInterruption bool

+ GroupID string

type FunctionCallResultFrame

+ Args json.RawMessage

+ Properties *FunctionCallResultProperties

+ RunLLM *bool

+ type FunctionCallResultProperties struct

+ IsFinal *bool

+ OnContextUpdated func(ctx context.Context) error

+ RunLLM *bool

+ func (p *FunctionCallResultProperties) Final() bool

+ type HeartbeatFrame struct

+ Timestamp time.Duration

+ func NewHeartbeatFrame(ts time.Duration) *HeartbeatFrame

+ func (f *HeartbeatFrame) String() string

+ type InputTextRawFrame struct

+ Text string

+ func NewInputTextRawFrame(text string) *InputTextRawFrame

+ func (f *InputTextRawFrame) String() string

+ type InputTransportStartAudioStreamingFrame struct

+ func NewInputTransportStartAudioStreamingFrame() *InputTransportStartAudioStreamingFrame

+ type InterruptionWorkerFrame struct

+ func NewInterruptionWorkerFrame() *InterruptionWorkerFrame

type KeypadEntry

+ func (e KeypadEntry) Valid() bool

+ type LLMAssistantPushAggregationFrame struct

+ func NewLLMAssistantPushAggregationFrame() *LLMAssistantPushAggregationFrame

+ type LLMConfigureOutputFrame struct

+ SkipTTS bool

+ func NewLLMConfigureOutputFrame(skipTTS bool) *LLMConfigureOutputFrame

type LLMContext

+ func (c *LLMContext) AddAssistantToolCall(call ToolCall)

+ func (c *LLMContext) AddMessage(m Message)

+ func (c *LLMContext) AddToolResult(r ToolResult)

+ func (c *LLMContext) MessagesFor(llm string) []Message

+ func (c *LLMContext) ReplaceLastAssistantText(text string) bool

+ func (c *LLMContext) SetMessages(messages []Message)

+ func (c *LLMContext) SetToolChoice(choice ToolChoice)

+ func (c *LLMContext) SetToolsSchema(schema ToolsSchema)

+ func (c *LLMContext) SystemParts() (stable, volatile string)

+ func (c *LLMContext) ToolChoice() ToolChoice

+ func (c *LLMContext) ToolsSchema() ToolsSchema

+ func (c *LLMContext) TransformMessages(transform func([]Message) []Message)

+ func (c *LLMContext) UpdateToolResult(toolCallID, content string) bool

+ type LLMContextAssistantTimestampFrame struct

+ Timestamp string

+ func NewLLMContextAssistantTimestampFrame(timestamp string) *LLMContextAssistantTimestampFrame

+ func (f *LLMContextAssistantTimestampFrame) String() string

+ type LLMContextAssistantTurnFrame struct

+ Text string

+ Timestamp string

+ func NewLLMContextAssistantTurnFrame(text, timestamp string) *LLMContextAssistantTurnFrame

+ func (f *LLMContextAssistantTurnFrame) String() string

+ type LLMContextSummaryRequestFrame struct

+ Context *LLMContext

+ MinMessagesToKeep int

+ RequestID string

+ SummarizationPrompt string

+ SummarizationTimeout time.Duration

+ TargetContextTokens int

+ func NewLLMContextSummaryRequestFrame(requestID string, convo *LLMContext) *LLMContextSummaryRequestFrame

+ func (f *LLMContextSummaryRequestFrame) String() string

+ type LLMContextSummaryResultFrame struct

+ Error string

+ LastSummarizedIndex int

+ RequestID string

+ Summary string

+ func NewLLMContextSummaryErrorFrame(requestID, message string) *LLMContextSummaryResultFrame

+ func NewLLMContextSummaryResultFrame(requestID, summary string, lastSummarizedIndex int) *LLMContextSummaryResultFrame

+ func (f *LLMContextSummaryResultFrame) String() string

+ type LLMEnablePromptCachingFrame struct

+ Enable bool

+ func NewLLMEnablePromptCachingFrame(enable bool) *LLMEnablePromptCachingFrame

+ func (f *LLMEnablePromptCachingFrame) String() string

type LLMMarkerFrame

+ AppendToContextImmediately bool

type LLMMessagesAppendFrame

+ RunLLM bool

+ type LLMMessagesTransformFrame struct

+ RunLLM bool

+ Transform func([]Message) []Message

+ func NewLLMMessagesTransformFrame(transform func([]Message) []Message) *LLMMessagesTransformFrame

+ func (f *LLMMessagesTransformFrame) String() string

+ type LLMMessagesUpdateFrame struct

+ Messages []Message

+ RunLLM bool

+ func NewLLMMessagesUpdateFrame(messages []Message) *LLMMessagesUpdateFrame

+ func (f *LLMMessagesUpdateFrame) String() string

+ type LLMSetToolChoiceFrame struct

+ ToolChoice ToolChoice

+ func NewLLMSetToolChoiceFrame(choice ToolChoice) *LLMSetToolChoiceFrame

+ func (f *LLMSetToolChoiceFrame) String() string

+ type LLMSetToolsFrame struct

+ Tools []Tool

+ func NewLLMSetToolsFrame(tools []Tool) *LLMSetToolsFrame

+ func (f *LLMSetToolsFrame) String() string

+ type LLMSummarizeContextFrame struct

+ Config *SummaryConfig

+ func NewLLMSummarizeContextFrame() *LLMSummarizeContextFrame

+ type LLMThoughtEndFrame struct

+ Signature any

+ func NewLLMThoughtEndFrame() *LLMThoughtEndFrame

+ func (f *LLMThoughtEndFrame) String() string

+ type LLMThoughtStartFrame struct

+ AppendToContext bool

+ LLM string

+ func NewLLMThoughtStartFrame() *LLMThoughtStartFrame

+ func (f *LLMThoughtStartFrame) String() string

+ type LLMThoughtTextFrame struct

+ IncludesInterFrameSpaces bool

+ Text string

+ func NewLLMThoughtTextFrame(text string) *LLMThoughtTextFrame

+ func (f *LLMThoughtTextFrame) String() string

type LLMTokenUsage

+ CacheReadAudioTokens *int64

+ InputAudioTokens *int64

+ InputTextTokens *int64

+ OutputAudioTokens *int64

+ OutputTextTokens *int64

+ ReasoningTokens *int64

+ type LLMUpdateSettingsFrame struct

+ func NewLLMUpdateSettingsFrame(delta any) *LLMUpdateSettingsFrame

+ func (f *LLMUpdateSettingsFrame) Copy() SettingsUpdate

+ func (f *LLMUpdateSettingsFrame) String() string

+ type LLMUsageMetricsData struct

+ Value LLMTokenUsage

+ type ManuallySwitchServiceFrame struct

+ Service ServiceTarget

+ func NewManuallySwitchServiceFrame(svc ServiceTarget) *ManuallySwitchServiceFrame

+ func (f *ManuallySwitchServiceFrame) String() string

type Message

+ LLM string

+ Native any

+ func NewAsyncToolCanceledMessage(toolCallID string) Message

+ func NewAsyncToolFinalMessage(toolCallID, result string) Message

+ func NewAsyncToolIntermediateMessage(toolCallID, result string) Message

+ func NewAsyncToolStartedMessage(toolCallID string) Message

+ func NewLLMSpecificMessage(llm string, native any) Message

+ func (m Message) IsLLMSpecific() bool

+ type MetricsData interface

+ MetricsModel func() string

+ MetricsProcessor func() string

type MetricsFrame

+ Data []MetricsData

+ type MixerControlBase struct

+ type MixerEnableFrame struct

+ Enable bool

+ func NewMixerEnableFrame(enable bool) *MixerEnableFrame

+ func (f *MixerEnableFrame) String() string

+ type MixerUpdateSettingsFrame struct

+ Settings map[string]any

+ func NewMixerUpdateSettingsFrame(settings map[string]any) *MixerUpdateSettingsFrame

+ func (f *MixerUpdateSettingsFrame) String() string

+ type OutputAudioFrame interface

type OutputDTMFFrame

+ Buttons []KeypadEntry

+ func NewOutputDTMFSequenceFrame(buttons []KeypadEntry) *OutputDTMFFrame

+ func (f *OutputDTMFFrame) Keys() []KeypadEntry

+ type OutputDTMFUrgentFrame struct

+ Buttons []KeypadEntry

+ func NewOutputDTMFUrgentFrame(button KeypadEntry) *OutputDTMFUrgentFrame

+ func (f *OutputDTMFUrgentFrame) Keys() []KeypadEntry

+ func (f *OutputDTMFUrgentFrame) String() string

type OutputTransportMessageFrame

+ func (f *OutputTransportMessageFrame) String() string

+ type OutputTransportMessageUrgentFrame struct

+ Message any

+ func NewOutputTransportMessageUrgentFrame(message any) *OutputTransportMessageUrgentFrame

+ func (f *OutputTransportMessageUrgentFrame) String() string

+ type OutputTransportReadyFrame struct

+ func NewOutputTransportReadyFrame() *OutputTransportReadyFrame

+ type PipelineFlushFrame struct

+ Done chan struct{}

+ Origin string

+ Returning bool

+ func NewPipelineFlushFrame() *PipelineFlushFrame

+ func (f *PipelineFlushFrame) CloseDone()

+ type ProcessingMetricsData struct

+ Value time.Duration

+ type ProcessorTarget interface

+ Name func() string

+ type ProposedUserStartedSpeakingFrame struct

+ func NewProposedUserStartedSpeakingFrame() *ProposedUserStartedSpeakingFrame

+ type ProposedUserStoppedSpeakingFrame struct

+ func NewProposedUserStoppedSpeakingFrame() *ProposedUserStoppedSpeakingFrame

type Role

+ const RoleDeveloper

+ type STTMuteFrame struct

+ Mute bool

+ func NewSTTMuteFrame(mute bool) *STTMuteFrame

+ func (f *STTMuteFrame) String() string

+ type STTUpdateSettingsFrame struct

+ func NewSTTUpdateSettingsFrame(delta any) *STTUpdateSettingsFrame

+ func (f *STTUpdateSettingsFrame) Copy() SettingsUpdate

+ func (f *STTUpdateSettingsFrame) String() string

+ type STTUsage struct

+ AudioSeconds float64

+ type STTUsageMetricsData struct

+ Value STTUsage

type ServiceMetadata

+ RecommendedUserTurnStrategies func() any

type ServiceMetadataFrame

+ UserTurnStrategies any

+ func (f *ServiceMetadataFrame) RecommendedUserTurnStrategies() any

+ type ServiceSwitcherRequestMetadataFrame struct

+ Service ServiceTarget

+ func NewServiceSwitcherRequestMetadataFrame(svc ServiceTarget) *ServiceSwitcherRequestMetadataFrame

+ func (f *ServiceSwitcherRequestMetadataFrame) String() string

+ type ServiceTarget interface

+ Name func() string

+ type ServiceUpdateSettingsFrame struct

+ Delta any

+ ReachInactiveServices bool

+ Service ServiceTarget

+ Settings map[string]any

+ func (f *ServiceUpdateSettingsFrame) ServiceUpdate() *ServiceUpdateSettingsFrame

+ func (f *ServiceUpdateSettingsFrame) TargetsService(svc ServiceTarget) bool

+ type SettingsUpdate interface

+ Copy func() SettingsUpdate

+ ServiceUpdate func() *ServiceUpdateSettingsFrame

type SpeechControlParamsFrame

+ TurnParams *turn.Params

+ VADParams *vad.Params

+ type SpeechOutputAudioRawFrame struct

+ func NewSpeechOutputAudioRawFrame(audio []byte, sampleRate, numChannels int) *SpeechOutputAudioRawFrame

+ type StopFrame struct

+ func NewStopFrame() *StopFrame

+ type StopWorkerFrame struct

+ func NewStopWorkerFrame() *StopWorkerFrame

+ type SummaryConfig struct

+ LLM any

+ MinMessagesAfterSummary int

+ SummarizationPrompt string

+ SummarizationTimeout time.Duration

+ SummaryMessageTemplate string

+ TargetContextTokens int

+ func (c SummaryConfig) SummaryPrompt() string

+ func (c SummaryConfig) Validate() error

+ func (c SummaryConfig) WithDefaults() SummaryConfig

+ type SwitcherFrame interface

+ type TTFAMetricsData struct

+ LeadingSilence time.Duration

+ TTFA time.Duration

+ TTFB time.Duration

+ type TTFBMetricsData struct

+ Value time.Duration

+ type TTSTextFrame struct

+ ContextID string

+ RawText string

+ func NewTTSTextFrame(text string) *TTSTextFrame

+ func (f *TTSTextFrame) Original() string

+ func (f *TTSTextFrame) String() string

+ type TTSUpdateSettingsFrame struct

+ func NewTTSUpdateSettingsFrame(delta any) *TTSUpdateSettingsFrame

+ func (f *TTSUpdateSettingsFrame) Copy() SettingsUpdate

+ func (f *TTSUpdateSettingsFrame) String() string

+ type TTSUsageMetricsData struct

+ Value int

+ type TextAggregationMetricsData struct

+ Value time.Duration

type Tool

+ CancelOnInterruption *bool

+ CancellableByLLM *bool

+ Cleanup any

+ Handler any

+ TimeoutSecs *float64

+ type ToolChoice string

+ const ToolChoiceAuto

+ const ToolChoiceNone

+ const ToolChoiceRequired

+ type ToolsSchema struct

+ Custom map[AdapterType][]any

+ Standard []Tool

+ func (s ToolsSchema) CustomFor(t AdapterType) []any

+ type TranslationFrame struct

+ Language string

+ Timestamp string

+ UserID string

+ func NewTranslationFrame(text, userID, timestamp string) *TranslationFrame

+ func (f *TranslationFrame) String() string

+ type TurnMetricsData struct

+ Complete bool

+ E2EProcessing time.Duration

+ Probability float64

+ type UserAudioRawFrame struct

+ UserID string

+ func NewUserAudioRawFrame(userID string, audio []byte, sampleRate, numChannels int) *UserAudioRawFrame

+ func (f *UserAudioRawFrame) String() string

+ type VADParamsUpdateFrame struct

+ Params vad.Params

+ func NewVADParamsUpdateFrame(params vad.Params) *VADParamsUpdateFrame

type VADUserStartedSpeakingFrame

+ Timestamp time.Time

+ func (f *VADUserStartedSpeakingFrame) SpeechStart() time.Time

v0.0.5

Jul 13, 2026

v0.0.4

Jul 12, 2026

Changes in this version

+ type AudioBufferStartRecordingFrame struct

+ func NewAudioBufferStartRecordingFrame() *AudioBufferStartRecordingFrame

+ type AudioBufferStopRecordingFrame struct

+ func NewAudioBufferStopRecordingFrame() *AudioBufferStopRecordingFrame

+ type InputDTMFFrame struct

+ Button KeypadEntry

+ func NewInputDTMFFrame(button KeypadEntry) *InputDTMFFrame

+ func (f *InputDTMFFrame) String() string

+ type KeypadEntry string

+ const KeypadA

+ const KeypadB

+ const KeypadC

+ const KeypadD

+ const KeypadEight

+ const KeypadFive

+ const KeypadFour

+ const KeypadNine

+ const KeypadOne

+ const KeypadPound

+ const KeypadSeven

+ const KeypadSix

+ const KeypadStar

+ const KeypadThree

+ const KeypadTwo

+ const KeypadZero

+ type LLMServiceMetadataFrame struct

+ Realtime bool

+ func NewLLMServiceMetadataFrame(service string) *LLMServiceMetadataFrame

type MetricsFrame

+ LeadingSilence *time.Duration

+ TTFA *time.Duration

+ type MixerControlFrame struct

+ Settings map[string]any

+ func NewMixerControlFrame(settings map[string]any) *MixerControlFrame

+ type OutputDTMFFrame struct

+ Button KeypadEntry

+ func NewOutputDTMFFrame(button KeypadEntry) *OutputDTMFFrame

+ func (f *OutputDTMFFrame) String() string

type STTMetadataFrame

+ ServiceName string

+ UserTurns UserTurnRecommendation

+ func (f *STTMetadataFrame) RecommendedUserTurns() UserTurnRecommendation

+ func (f *STTMetadataFrame) Service() string

+ type ServiceMetadata interface

+ RecommendedUserTurns func() UserTurnRecommendation

+ Service func() string

+ type ServiceMetadataFrame struct

+ ServiceName string

+ UserTurns UserTurnRecommendation

+ func NewServiceMetadataFrame(service string) *ServiceMetadataFrame

+ func (f *ServiceMetadataFrame) RecommendedUserTurns() UserTurnRecommendation

+ func (f *ServiceMetadataFrame) Service() string

+ func (f *ServiceMetadataFrame) String() string

+ type UserTurnRecommendation int

+ const UserTurnExternal

+ const UserTurnUnspecified

+ func (r UserTurnRecommendation) String() string

v0.0.3

Jul 12, 2026

v0.0.2

Jul 2, 2026

v0.0.1

Jun 29, 2026

Changes in this version

+ type AudioRawData struct

+ Audio []byte

+ NumChannels int

+ SampleRate int

+ func (a *AudioRawData) NumFrames() int

+ type BaseControlFrame struct

+ func NewBaseControlFrame(typeName string) BaseControlFrame

+ type BaseDataFrame struct

+ func NewBaseDataFrame(typeName string) BaseDataFrame

+ type BaseFrame struct

+ func NewBaseFrame(typeName string) BaseFrame

+ func (f *BaseFrame) BroadcastSiblingID() (uint64, bool)

+ func (f *BaseFrame) ID() uint64

+ func (f *BaseFrame) Metadata() map[string]any

+ func (f *BaseFrame) Name() string

+ func (f *BaseFrame) PTS() (int64, bool)

+ func (f *BaseFrame) SetBroadcastSiblingID(id uint64)

+ func (f *BaseFrame) SetPTS(pts int64)

+ func (f *BaseFrame) SetTransportDestination(dest string)

+ func (f *BaseFrame) SetTransportSource(source string)

+ func (f *BaseFrame) String() string

+ func (f *BaseFrame) TransportDestination() string

+ func (f *BaseFrame) TransportSource() string

+ type BaseSystemFrame struct

+ func NewBaseSystemFrame(typeName string) BaseSystemFrame

+ type BotSpeakingFrame struct

+ func NewBotSpeakingFrame() *BotSpeakingFrame

+ type BotStartedSpeakingFrame struct

+ func NewBotStartedSpeakingFrame() *BotStartedSpeakingFrame

+ type BotStoppedSpeakingFrame struct

+ func NewBotStoppedSpeakingFrame() *BotStoppedSpeakingFrame

+ type CancelFrame struct

+ Reason any

+ func NewCancelFrame() *CancelFrame

+ func (f *CancelFrame) String() string

+ type ControlFrame interface

+ type DataFrame interface

+ type EndFrame struct

+ Reason any

+ func NewEndFrame() *EndFrame

+ func (f *EndFrame) String() string

+ type ErrorFrame struct

+ Err error

+ Error string

+ Fatal bool

+ Source ErrorSource

+ func NewErrorFrame(message string) *ErrorFrame

+ func (f *ErrorFrame) String() string

+ type ErrorSource interface

+ Name func() string

+ type Frame interface

+ BroadcastSiblingID func() (id uint64, ok bool)

+ ID func() uint64

+ Metadata func() map[string]any

+ Name func() string

+ PTS func() (pts int64, ok bool)

+ SetBroadcastSiblingID func(id uint64)

+ SetPTS func(pts int64)

+ SetTransportDestination func(dest string)

+ SetTransportSource func(source string)

+ TransportDestination func() string

+ TransportSource func() string

+ type FunctionCallCancelFrame struct

+ ToolCallID string

+ ToolName string

+ func NewFunctionCallCancelFrame(toolCallID, name string) *FunctionCallCancelFrame

+ func (f *FunctionCallCancelFrame) String() string

+ type FunctionCallInProgressFrame struct

+ ToolCallID string

+ ToolName string

+ func NewFunctionCallInProgressFrame(toolCallID, name string) *FunctionCallInProgressFrame

+ func (f *FunctionCallInProgressFrame) String() string

+ type FunctionCallResultFrame struct

+ IsError bool

+ Result string

+ ToolCallID string

+ ToolName string

+ func NewFunctionCallResultFrame(toolCallID, name, result string, isError bool) *FunctionCallResultFrame

+ func (f *FunctionCallResultFrame) String() string

+ type FunctionCallsStartedFrame struct

+ Calls []ToolCall

+ PreambleText string

+ func NewFunctionCallsStartedFrame(preamble string, calls []ToolCall) *FunctionCallsStartedFrame

+ func (f *FunctionCallsStartedFrame) String() string

+ type InputAudioRawFrame struct

+ func NewInputAudioRawFrame(audio []byte, sampleRate, numChannels int) *InputAudioRawFrame

+ func (f *InputAudioRawFrame) String() string

+ type InputTransportMessageFrame struct

+ Message []byte

+ func NewInputTransportMessageFrame(message []byte) *InputTransportMessageFrame

+ func (f *InputTransportMessageFrame) String() string

+ type InterimTranscriptionFrame struct

+ Language string

+ Result any

+ Timestamp string

+ UserID string

+ func NewInterimTranscriptionFrame(text, userID, timestamp string) *InterimTranscriptionFrame

+ func (f *InterimTranscriptionFrame) String() string

+ type InterruptionFrame struct

+ func NewInterruptionFrame() *InterruptionFrame

+ type LLMContext struct

+ func NewLLMContext(system string) *LLMContext

+ func (c *LLMContext) AddAssistantMessage(text string)

+ func (c *LLMContext) AddAssistantToolCalls(text string, calls []ToolCall)

+ func (c *LLMContext) AddToolResults(results []ToolResult)

+ func (c *LLMContext) AddUserMessage(text string)

+ func (c *LLMContext) Compact(ctx context.Context, keepRecent int, ...) (bool, error)

+ func (c *LLMContext) EstimatedTokens() int

+ func (c *LLMContext) Messages() []Message

+ func (c *LLMContext) Recall() string

+ func (c *LLMContext) SetRecall(recall string)

+ func (c *LLMContext) SetSystem(system string)

+ func (c *LLMContext) SetTools(tools []Tool)

+ func (c *LLMContext) Summary() string

+ func (c *LLMContext) System() string

+ func (c *LLMContext) Tools() []Tool

+ type LLMContextFrame struct

+ Context *LLMContext

+ func NewLLMContextFrame(ctx *LLMContext) *LLMContextFrame

+ func (f *LLMContextFrame) String() string

+ type LLMFullResponseEndFrame struct

+ SkipTTS *bool

+ func NewLLMFullResponseEndFrame() *LLMFullResponseEndFrame

+ type LLMFullResponseStartFrame struct

+ SkipTTS *bool

+ func NewLLMFullResponseStartFrame() *LLMFullResponseStartFrame

+ type LLMMarkerFrame struct

+ Marker string

+ func NewLLMMarkerFrame(marker string) *LLMMarkerFrame

+ type LLMMessagesAppendFrame struct

+ Messages []Message

+ func NewLLMMessagesAppendFrame(messages []Message) *LLMMessagesAppendFrame

+ type LLMRunFrame struct

+ func NewLLMRunFrame() *LLMRunFrame

+ type LLMTextFrame struct

+ func NewLLMTextFrame(text string) *LLMTextFrame

+ type LLMTokenUsage struct

+ CacheCreationTokens int64

+ CacheReadTokens int64

+ CompletionTokens int64

+ PromptTokens int64

+ TotalTokens int64

+ type Message struct

+ Role Role

+ Text string

+ ToolCalls []ToolCall

+ ToolResults []ToolResult

+ type MetricsFrame struct

+ Characters *int

+ Model string

+ Processing *time.Duration

+ Processor string

+ TTFB *time.Duration

+ Tokens *LLMTokenUsage

+ func NewMetricsFrame(processor string) *MetricsFrame

+ func (f *MetricsFrame) String() string

+ type OutputAudioRawFrame struct

+ func NewOutputAudioRawFrame(audio []byte, sampleRate, numChannels int) *OutputAudioRawFrame

+ func (f *OutputAudioRawFrame) String() string

+ type OutputTransportMessageFrame struct

+ Message any

+ func NewOutputTransportMessageFrame(message any) *OutputTransportMessageFrame

+ type Role string

+ const RoleAssistant

+ const RoleSystem

+ const RoleUser

+ type STTMetadataFrame struct

+ TTFSP99Latency time.Duration

+ func NewSTTMetadataFrame(ttfsP99 time.Duration) *STTMetadataFrame

+ func (f *STTMetadataFrame) String() string

+ type SpeechControlParamsFrame struct

+ MaxDurationSecs float64

+ PreSpeechMs float64

+ StopSecs float64

+ func NewSpeechControlParamsFrame(stopSecs, preSpeechMs, maxDurationSecs float64) *SpeechControlParamsFrame

+ type StartFrame struct

+ AudioInSampleRate int

+ AudioOutSampleRate int

+ EnableMetrics bool

+ EnableUsageMetrics bool

+ ReportOnlyInitialTTFB bool

+ func NewStartFrame() *StartFrame

+ type SystemFrame interface

+ type TTSAudioRawFrame struct

+ ContextID string

+ func NewTTSAudioRawFrame(audio []byte, sampleRate, numChannels int) *TTSAudioRawFrame

+ type TTSSpeakFrame struct

+ AppendToContext bool

+ Text string

+ func NewTTSSpeakFrame(text string) *TTSSpeakFrame

+ func (f *TTSSpeakFrame) String() string

+ type TTSStartedFrame struct

+ AppendToContext bool

+ ContextID string

+ func NewTTSStartedFrame() *TTSStartedFrame

+ type TTSStoppedFrame struct

+ ContextID string

+ func NewTTSStoppedFrame() *TTSStoppedFrame

+ type TextFrame struct

+ AppendToContext bool

+ IncludesInterFrameSpaces bool

+ SkipTTS *bool

+ Text string

+ func NewTextFrame(text string) *TextFrame

+ func (f *TextFrame) String() string

+ type Tool struct

+ Description string

+ Name string

+ Parameters json.RawMessage

+ type ToolCall struct

+ Args json.RawMessage

+ ID string

+ Name string

+ type ToolResult struct

+ Content string

+ ID string

+ IsError bool

+ Name string

+ type TranscriptionFrame struct

+ Finalized bool

+ Language string

+ Result any

+ Timestamp string

+ UserID string

+ func NewTranscriptionFrame(text, userID, timestamp string) *TranscriptionFrame

+ func (f *TranscriptionFrame) String() string

+ type Uninterruptible interface

+ type UninterruptibleMixin struct

+ type UserIdleTimeoutUpdateFrame struct

+ Timeout time.Duration

+ func NewUserIdleTimeoutUpdateFrame(timeout time.Duration) *UserIdleTimeoutUpdateFrame

+ func (f *UserIdleTimeoutUpdateFrame) String() string

+ type UserMuteStartedFrame struct

+ func NewUserMuteStartedFrame() *UserMuteStartedFrame

+ type UserMuteStoppedFrame struct

+ func NewUserMuteStoppedFrame() *UserMuteStoppedFrame

+ type UserSpeakingFrame struct

+ func NewUserSpeakingFrame() *UserSpeakingFrame

+ type UserStartedSpeakingFrame struct

+ func NewUserStartedSpeakingFrame() *UserStartedSpeakingFrame

+ type UserStoppedSpeakingFrame struct

+ func NewUserStoppedSpeakingFrame() *UserStoppedSpeakingFrame

+ type UserTurnInferenceCompletedFrame struct

+ func NewUserTurnInferenceCompletedFrame() *UserTurnInferenceCompletedFrame

+ type VADUserStartedSpeakingFrame struct

+ StartSecs float64

+ func NewVADUserStartedSpeakingFrame(startSecs float64) *VADUserStartedSpeakingFrame

+ func (f *VADUserStartedSpeakingFrame) String() string

+ type VADUserStoppedSpeakingFrame struct

+ StopSecs float64

+ Timestamp string

+ func NewVADUserStoppedSpeakingFrame(stopSecs float64, timestamp string) *VADUserStoppedSpeakingFrame

+ func (f *VADUserStoppedSpeakingFrame) String() string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL