realtime

package module
v0.0.0-...-c9c4fc0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 15, 2025 License: Apache-2.0 Imports: 16 Imported by: 0

README ¶

Go Client Package for OpenAI Realtime Voice API

This repository provides a Go package for building applications that create real-time, two-way voice conversations with an AI assistant using the OpenAI Realtime API. It is designed to be imported into your own Go projects, providing the core functionality to handle microphone input, low-latency audio streaming, and session management.

Purpose 📦

This package abstracts away the complexity of the underlying WebRTC handshake and media streaming. By using this library, you can easily integrate OpenAI's real-time voice capabilities into your own applications without needing to manage the low-level details of the peer-to-peer connection and audio processing.

Key Features 🎤

  • Real-Time, Bidirectional Audio: Provides components to capture local microphone audio, encode it using Opus, and stream it to OpenAI. It simultaneously handles receiving, decoding, and playing back the AI assistant's audio response.

  • WebRTC Integration: Built on the powerful Pion WebRTC library to manage the peer-to-peer connection, media tracks, and data channels required for the conversation.

  • Real-Time Events via Data Channel: Listens on the WebRTC data channel to receive a stream of structured JSON events from OpenAI, including live transcriptions, speech start/end notifications, function calls, and other session updates.

  • Dynamic Audio Playback: Employs the Ebitengine Oto library for cross-platform audio playback, dynamically configuring the output based on the audio format sent by the API.

  • Session Management: Offers functions to manage the full session lifecycle, from sending initial system and user prompts to gracefully terminating the connection.

Documentation ¶

Overview ¶

Go Client Package for OpenAI Realtime Voice API ¶

This repository provides a Go package for building applications that create real-time, two-way voice conversations with an AI assistant using the OpenAI Realtime API. It is designed to be imported into your own Go projects, providing the core functionality to handle microphone input, low-latency audio streaming, and session management.

Index ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶ 

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

func NewClient ¶ 

func NewClient(ctx context.Context, logger shared.LoggerAdapter, apikey, greeting, baseUrl string) (c *Client, err error)

func (*Client) Close ¶ 

func (c *Client) Close() error

func (*Client) Connected ¶ 

func (c *Client) Connected() <-chan struct{}

func (*Client) DC ¶ 

func (c *Client) DC() *webrtc.DataChannel

func (*Client) Done ¶ 

func (c *Client) Done() <-chan struct{}

func (*Client) RegisterEventHandler ¶ 

func (c *Client) RegisterEventHandler(handler EventHandler) error

func (*Client) RegisterTrackLocalHandler ¶ 

func (c *Client) RegisterTrackLocalHandler(handler TrackLocalHandler) error

func (*Client) RegisterTrackRemoteHandler ¶ 

func (c *Client) RegisterTrackRemoteHandler(handler TrackRemoteHandler) error

func (*Client) SetConfig ¶ 

func (c *Client) SetConfig(cfg *realtime.RealtimeSessionCreateRequestParam) error

func (*Client) Start ¶ 

func (c *Client) Start() error

func (*Client) State ¶ 

func (c *Client) State() webrtc.PeerConnectionState

type ClientEventType ¶ 

type ClientEventType EventType
const (
	ClientEventTypeSessionUpdate            ClientEventType = "session.update"
	ClientEventTypeInputAudioBufferAppend   ClientEventType = "input_audio_buffer.append"
	ClientEventTypeInputAudioBufferCommit   ClientEventType = "input_audio_buffer.commit"
	ClientEventTypeInputAudioBufferClear    ClientEventType = "input_audio_buffer.clear"
	ClientEventTypeConversationItemCreate   ClientEventType = "conversation.item.create"
	ClientEventTypeConversationItemRetrieve ClientEventType = "conversation.item.retrieve"
	ClientEventTypeConversationItemTruncate ClientEventType = "conversation.item.truncate"
	ClientEventTypeConversationItemDelete   ClientEventType = "conversation.item.delete"
	ClientEventTypeResponseCreate           ClientEventType = "response.create"
	ClientEventTypeResponseCancel           ClientEventType = "response.cancel"
	ClientEventTypeOutputAudioBufferClear   ClientEventType = "output_audio_buffer.clear"
)

Client event types

type ClientState ¶ 

type ClientState int
const (
	ClientStateNew ClientState = iota
	ClientStateConnecting
	ClientStateConnected
	ClientStateDisconnected
	ClientStateFailed
	ClientStateClosed
)

type Event ¶ 

type Event interface {
	EventType() EventType
	IsServerEvent() bool
	IsClientEvent() bool
	MarshalYAML() ([]byte, error)
	UnmarshalYAML(data []byte) error
	MarshalJSON() ([]byte, error)
	UnmarshalJSON(data []byte) error
}

type EventHandler ¶ 

type EventHandler func(event *ServerEvent)

type EventParam ¶ 

type EventParam interface {
	New(map[string]any) error
	Json() map[string]any
}

type EventType ¶ 

type EventType string

type ServerEvent ¶ 

type ServerEvent struct {
	EventId string
	Type    ServerEventType
	Param   EventParam
}

func (*ServerEvent) EventType ¶ 

func (e *ServerEvent) EventType() EventType

func (*ServerEvent) IsClientEvent ¶ 

func (e *ServerEvent) IsClientEvent() bool

func (*ServerEvent) IsServerEvent ¶ 

func (e *ServerEvent) IsServerEvent() bool

func (*ServerEvent) MarshalJSON ¶ 

func (e *ServerEvent) MarshalJSON() ([]byte, error)

func (*ServerEvent) MarshalYAML ¶ 

func (e *ServerEvent) MarshalYAML() ([]byte, error)

func (*ServerEvent) UnmarshalJSON ¶ 

func (e *ServerEvent) UnmarshalJSON(data []byte) error

func (*ServerEvent) UnmarshalYAML ¶ 

func (e *ServerEvent) UnmarshalYAML(data []byte) error

type ServerEventParamConversationItemAdded ¶ 

type ServerEventParamConversationItemAdded struct {
	PreviousItemId any
	Item           map[string]any
}

conversation.item.added

func (*ServerEventParamConversationItemAdded) Json ¶ 

func (p *ServerEventParamConversationItemAdded) Json() map[string]any

func (*ServerEventParamConversationItemAdded) New ¶ 

func (p *ServerEventParamConversationItemAdded) New(m map[string]any) error

type ServerEventParamConversationItemDeleted ¶ 

type ServerEventParamConversationItemDeleted struct {
	ItemId string
}

conversation.item.deleted

func (*ServerEventParamConversationItemDeleted) Json ¶ 

func (p *ServerEventParamConversationItemDeleted) Json() map[string]any

func (*ServerEventParamConversationItemDeleted) New ¶ 

func (p *ServerEventParamConversationItemDeleted) New(m map[string]any) error

type ServerEventParamConversationItemDone ¶ 

type ServerEventParamConversationItemDone struct {
	PreviousItemId any
	Item           map[string]any
}

conversation.item.done

func (*ServerEventParamConversationItemDone) Json ¶ 

func (p *ServerEventParamConversationItemDone) Json() map[string]any

func (*ServerEventParamConversationItemDone) New ¶ 

func (p *ServerEventParamConversationItemDone) New(m map[string]any) error

type ServerEventParamConversationItemInputAudioTranscriptionCompleted ¶ 

type ServerEventParamConversationItemInputAudioTranscriptionCompleted struct {
	ItemId       string
	ContentIndex int
	Transcript   string
	Usage        map[string]any
}

conversation.item.input_audio_transcription.completed

func (*ServerEventParamConversationItemInputAudioTranscriptionCompleted) Json ¶ 

func (p *ServerEventParamConversationItemInputAudioTranscriptionCompleted) Json() map[string]any

func (*ServerEventParamConversationItemInputAudioTranscriptionCompleted) New ¶ 

func (p *ServerEventParamConversationItemInputAudioTranscriptionCompleted) New(m map[string]any) error

type ServerEventParamConversationItemInputAudioTranscriptionDelta ¶ 

type ServerEventParamConversationItemInputAudioTranscriptionDelta struct {
	ItemId       string
	ContentIndex int
	Delta        string
	Obfuscation  string
}

conversation.item.input_audio_transcription.delta

func (*ServerEventParamConversationItemInputAudioTranscriptionDelta) Json ¶ 

func (p *ServerEventParamConversationItemInputAudioTranscriptionDelta) Json() map[string]any

func (*ServerEventParamConversationItemInputAudioTranscriptionDelta) New ¶ 

func (p *ServerEventParamConversationItemInputAudioTranscriptionDelta) New(m map[string]any) error

type ServerEventParamConversationItemInputAudioTranscriptionFailed ¶ 

type ServerEventParamConversationItemInputAudioTranscriptionFailed struct {
	ItemId       string
	ContentIndex int
	Error        map[string]any
}

conversation.item.input_audio_transcription.failed

func (*ServerEventParamConversationItemInputAudioTranscriptionFailed) Json ¶ 

func (p *ServerEventParamConversationItemInputAudioTranscriptionFailed) Json() map[string]any

func (*ServerEventParamConversationItemInputAudioTranscriptionFailed) New ¶ 

func (p *ServerEventParamConversationItemInputAudioTranscriptionFailed) New(m map[string]any) error

type ServerEventParamConversationItemInputAudioTranscriptionSegment ¶ 

type ServerEventParamConversationItemInputAudioTranscriptionSegment struct {
	ItemId       string
	ContentIndex int
	Text         string
	Id           string
	Speaker      string
	Start        float64
	End          float64
}

conversation.item.input_audio_transcription.segment

func (*ServerEventParamConversationItemInputAudioTranscriptionSegment) Json ¶ 

func (p *ServerEventParamConversationItemInputAudioTranscriptionSegment) Json() map[string]any

func (*ServerEventParamConversationItemInputAudioTranscriptionSegment) New ¶ 

func (p *ServerEventParamConversationItemInputAudioTranscriptionSegment) New(m map[string]any) error

type ServerEventParamConversationItemRetrieved ¶ 

type ServerEventParamConversationItemRetrieved struct {
	Item map[string]any
}

conversation.item.retrieved

func (*ServerEventParamConversationItemRetrieved) Json ¶ 

func (p *ServerEventParamConversationItemRetrieved) Json() map[string]any

func (*ServerEventParamConversationItemRetrieved) New ¶ 

func (p *ServerEventParamConversationItemRetrieved) New(m map[string]any) error

type ServerEventParamConversationItemTruncated ¶ 

type ServerEventParamConversationItemTruncated struct {
	ItemId       string
	ContentIndex int
	AudioEndMs   int
}

conversation.item.truncated

func (*ServerEventParamConversationItemTruncated) Json ¶ 

func (p *ServerEventParamConversationItemTruncated) Json() map[string]any

func (*ServerEventParamConversationItemTruncated) New ¶ 

func (p *ServerEventParamConversationItemTruncated) New(m map[string]any) error

type ServerEventParamError ¶ 

type ServerEventParamError struct {
	Type    string
	EventId string
	Code    string
	Message string
	Param   any
}

ServerEventParamError

func (*ServerEventParamError) Json ¶ 

func (p *ServerEventParamError) Json() map[string]any

func (*ServerEventParamError) New ¶ 

func (p *ServerEventParamError) New(jsonMap map[string]any) error

type ServerEventParamInputAudioBufferCleared ¶ 

type ServerEventParamInputAudioBufferCleared struct{}

input_audio_buffer.cleared

func (*ServerEventParamInputAudioBufferCleared) Json ¶ 

func (p *ServerEventParamInputAudioBufferCleared) Json() map[string]any

func (*ServerEventParamInputAudioBufferCleared) New ¶ 

func (p *ServerEventParamInputAudioBufferCleared) New(m map[string]any) error

type ServerEventParamInputAudioBufferCommitted ¶ 

type ServerEventParamInputAudioBufferCommitted struct {
	PreviousItemId any
	ItemId         string
}

input_audio_buffer.committed

func (*ServerEventParamInputAudioBufferCommitted) Json ¶ 

func (p *ServerEventParamInputAudioBufferCommitted) Json() map[string]any

func (*ServerEventParamInputAudioBufferCommitted) New ¶ 

func (p *ServerEventParamInputAudioBufferCommitted) New(m map[string]any) error

type ServerEventParamInputAudioBufferSpeechStarted ¶ 

type ServerEventParamInputAudioBufferSpeechStarted struct {
	AudioStartMs int
	ItemId       string
}

input_audio_buffer.speech_started

func (*ServerEventParamInputAudioBufferSpeechStarted) Json ¶ 

func (p *ServerEventParamInputAudioBufferSpeechStarted) Json() map[string]any

func (*ServerEventParamInputAudioBufferSpeechStarted) New ¶ 

func (p *ServerEventParamInputAudioBufferSpeechStarted) New(m map[string]any) error

type ServerEventParamInputAudioBufferSpeechStopped ¶ 

type ServerEventParamInputAudioBufferSpeechStopped struct {
	AudioEndMs int
	ItemId     string
}

input_audio_buffer.speech_stopped

func (*ServerEventParamInputAudioBufferSpeechStopped) Json ¶ 

func (p *ServerEventParamInputAudioBufferSpeechStopped) Json() map[string]any

func (*ServerEventParamInputAudioBufferSpeechStopped) New ¶ 

func (p *ServerEventParamInputAudioBufferSpeechStopped) New(m map[string]any) error

type ServerEventParamInputAudioBufferTimeoutTriggered ¶ 

type ServerEventParamInputAudioBufferTimeoutTriggered struct {
	AudioStartMs int
	AudioEndMs   int
	ItemId       string
}

input_audio_buffer.timeout_triggered

func (*ServerEventParamInputAudioBufferTimeoutTriggered) Json ¶ 

func (p *ServerEventParamInputAudioBufferTimeoutTriggered) Json() map[string]any

func (*ServerEventParamInputAudioBufferTimeoutTriggered) New ¶ 

func (p *ServerEventParamInputAudioBufferTimeoutTriggered) New(m map[string]any) error

type ServerEventParamMCPListToolsCompleted ¶ 

type ServerEventParamMCPListToolsCompleted struct {
	ItemId string
}

mcp_list_tools.completed

func (*ServerEventParamMCPListToolsCompleted) Json ¶ 

func (p *ServerEventParamMCPListToolsCompleted) Json() map[string]any

func (*ServerEventParamMCPListToolsCompleted) New ¶ 

func (p *ServerEventParamMCPListToolsCompleted) New(m map[string]any) error

type ServerEventParamMCPListToolsFailed ¶ 

type ServerEventParamMCPListToolsFailed struct {
	ItemId string
}

mcp_list_tools.failed

func (*ServerEventParamMCPListToolsFailed) Json ¶ 

func (p *ServerEventParamMCPListToolsFailed) Json() map[string]any

func (*ServerEventParamMCPListToolsFailed) New ¶ 

func (p *ServerEventParamMCPListToolsFailed) New(m map[string]any) error

type ServerEventParamMCPListToolsInProgress ¶ 

type ServerEventParamMCPListToolsInProgress struct {
	ItemId string
}

mcp_list_tools.in_progress

func (*ServerEventParamMCPListToolsInProgress) Json ¶ 

func (p *ServerEventParamMCPListToolsInProgress) Json() map[string]any

func (*ServerEventParamMCPListToolsInProgress) New ¶ 

func (p *ServerEventParamMCPListToolsInProgress) New(m map[string]any) error

type ServerEventParamOutputAudioBufferCleared ¶ 

type ServerEventParamOutputAudioBufferCleared struct {
	ResponseId string
}

output_audio_buffer.cleared

func (*ServerEventParamOutputAudioBufferCleared) Json ¶ 

func (p *ServerEventParamOutputAudioBufferCleared) Json() map[string]any

func (*ServerEventParamOutputAudioBufferCleared) New ¶ 

func (p *ServerEventParamOutputAudioBufferCleared) New(m map[string]any) error

type ServerEventParamOutputAudioBufferStarted ¶ 

type ServerEventParamOutputAudioBufferStarted struct {
	ResponseId string
}

output_audio_buffer.started

func (*ServerEventParamOutputAudioBufferStarted) Json ¶ 

func (p *ServerEventParamOutputAudioBufferStarted) Json() map[string]any

func (*ServerEventParamOutputAudioBufferStarted) New ¶ 

func (p *ServerEventParamOutputAudioBufferStarted) New(m map[string]any) error

type ServerEventParamOutputAudioBufferStopped ¶ 

type ServerEventParamOutputAudioBufferStopped struct {
	ResponseId string
}

output_audio_buffer.stopped

func (*ServerEventParamOutputAudioBufferStopped) Json ¶ 

func (p *ServerEventParamOutputAudioBufferStopped) Json() map[string]any

func (*ServerEventParamOutputAudioBufferStopped) New ¶ 

func (p *ServerEventParamOutputAudioBufferStopped) New(m map[string]any) error

type ServerEventParamRatelimitsUpdated ¶ 

type ServerEventParamRatelimitsUpdated struct {
	RateLimits []map[string]any
}

rate_limits.updated

func (*ServerEventParamRatelimitsUpdated) Json ¶ 

func (p *ServerEventParamRatelimitsUpdated) Json() map[string]any

func (*ServerEventParamRatelimitsUpdated) New ¶ 

func (p *ServerEventParamRatelimitsUpdated) New(m map[string]any) error

type ServerEventParamResponseContentPartAdded ¶ 

type ServerEventParamResponseContentPartAdded struct {
	ResponseId   string
	ItemId       string
	OutputIndex  int
	ContentIndex int
	Part         map[string]any
}

response.content_part.added

func (*ServerEventParamResponseContentPartAdded) Json ¶ 

func (p *ServerEventParamResponseContentPartAdded) Json() map[string]any

func (*ServerEventParamResponseContentPartAdded) New ¶ 

func (p *ServerEventParamResponseContentPartAdded) New(m map[string]any) error

type ServerEventParamResponseContentPartDone ¶ 

type ServerEventParamResponseContentPartDone struct {
	ResponseId   string
	ItemId       string
	OutputIndex  int
	ContentIndex int
	Part         map[string]any
}

response.content_part.done

func (*ServerEventParamResponseContentPartDone) Json ¶ 

func (p *ServerEventParamResponseContentPartDone) Json() map[string]any

func (*ServerEventParamResponseContentPartDone) New ¶ 

func (p *ServerEventParamResponseContentPartDone) New(m map[string]any) error

type ServerEventParamResponseCreated ¶ 

type ServerEventParamResponseCreated struct {
	Response map[string]any
}

response.created

func (*ServerEventParamResponseCreated) Json ¶ 

func (p *ServerEventParamResponseCreated) Json() map[string]any

func (*ServerEventParamResponseCreated) New ¶ 

func (p *ServerEventParamResponseCreated) New(m map[string]any) error

type ServerEventParamResponseDone ¶ 

type ServerEventParamResponseDone struct {
	Response map[string]any
}

response.done

func (*ServerEventParamResponseDone) Json ¶ 

func (p *ServerEventParamResponseDone) Json() map[string]any

func (*ServerEventParamResponseDone) New ¶ 

func (p *ServerEventParamResponseDone) New(m map[string]any) error

type ServerEventParamResponseFunctionCallArgumentsDelta ¶ 

type ServerEventParamResponseFunctionCallArgumentsDelta struct {
	ResponseId  string
	ItemId      string
	OutputIndex int
	CallId      string
	Delta       string
}

response.function_call_arguments.delta

func (*ServerEventParamResponseFunctionCallArgumentsDelta) Json ¶ 

func (p *ServerEventParamResponseFunctionCallArgumentsDelta) Json() map[string]any

func (*ServerEventParamResponseFunctionCallArgumentsDelta) New ¶ 

func (p *ServerEventParamResponseFunctionCallArgumentsDelta) New(m map[string]any) error

type ServerEventParamResponseFunctionCallArgumentsDone ¶ 

type ServerEventParamResponseFunctionCallArgumentsDone struct {
	ResponseId  string
	ItemId      string
	OutputIndex int
	CallId      string
	Arguments   string
}

response.function_call_arguments.done

func (*ServerEventParamResponseFunctionCallArgumentsDone) Json ¶ 

func (p *ServerEventParamResponseFunctionCallArgumentsDone) Json() map[string]any

func (*ServerEventParamResponseFunctionCallArgumentsDone) New ¶ 

func (p *ServerEventParamResponseFunctionCallArgumentsDone) New(m map[string]any) error

type ServerEventParamResponseMCPCallArgumentsDelta ¶ 

type ServerEventParamResponseMCPCallArgumentsDelta struct {
	ResponseId  string
	ItemId      string
	OutputIndex int
	Delta       string
}

response.mcp_call_arguments.delta

func (*ServerEventParamResponseMCPCallArgumentsDelta) Json ¶ 

func (p *ServerEventParamResponseMCPCallArgumentsDelta) Json() map[string]any

func (*ServerEventParamResponseMCPCallArgumentsDelta) New ¶ 

func (p *ServerEventParamResponseMCPCallArgumentsDelta) New(m map[string]any) error

type ServerEventParamResponseMCPCallArgumentsDone ¶ 

type ServerEventParamResponseMCPCallArgumentsDone struct {
	ResponseId  string
	ItemId      string
	OutputIndex int
	Arguments   string
}

response.mcp_call_arguments.done

func (*ServerEventParamResponseMCPCallArgumentsDone) Json ¶ 

func (p *ServerEventParamResponseMCPCallArgumentsDone) Json() map[string]any

func (*ServerEventParamResponseMCPCallArgumentsDone) New ¶ 

func (p *ServerEventParamResponseMCPCallArgumentsDone) New(m map[string]any) error

type ServerEventParamResponseMCPCallCompleted ¶ 

type ServerEventParamResponseMCPCallCompleted struct {
	OutputIndex int
	ItemId      string
}

response.mcp_call.completed

func (*ServerEventParamResponseMCPCallCompleted) Json ¶ 

func (p *ServerEventParamResponseMCPCallCompleted) Json() map[string]any

func (*ServerEventParamResponseMCPCallCompleted) New ¶ 

func (p *ServerEventParamResponseMCPCallCompleted) New(m map[string]any) error

type ServerEventParamResponseMCPCallFailed ¶ 

type ServerEventParamResponseMCPCallFailed struct {
	OutputIndex int
	ItemId      string
}

response.mcp_call.failed

func (*ServerEventParamResponseMCPCallFailed) Json ¶ 

func (p *ServerEventParamResponseMCPCallFailed) Json() map[string]any

func (*ServerEventParamResponseMCPCallFailed) New ¶ 

func (p *ServerEventParamResponseMCPCallFailed) New(m map[string]any) error

type ServerEventParamResponseMCPCallInProgress ¶ 

type ServerEventParamResponseMCPCallInProgress struct {
	OutputIndex int
	ItemId      string
}

response.mcp_call.in_progress

func (*ServerEventParamResponseMCPCallInProgress) Json ¶ 

func (p *ServerEventParamResponseMCPCallInProgress) Json() map[string]any

func (*ServerEventParamResponseMCPCallInProgress) New ¶ 

func (p *ServerEventParamResponseMCPCallInProgress) New(m map[string]any) error

type ServerEventParamResponseOutputAudioDelta ¶ 

type ServerEventParamResponseOutputAudioDelta struct {
	ResponseId   string
	ItemId       string
	OutputIndex  int
	ContentIndex int
	Delta        string
}

response.output_audio.delta

func (*ServerEventParamResponseOutputAudioDelta) Json ¶ 

func (p *ServerEventParamResponseOutputAudioDelta) Json() map[string]any

func (*ServerEventParamResponseOutputAudioDelta) New ¶ 

func (p *ServerEventParamResponseOutputAudioDelta) New(m map[string]any) error

type ServerEventParamResponseOutputAudioDone ¶ 

type ServerEventParamResponseOutputAudioDone struct {
	ResponseId   string
	ItemId       string
	OutputIndex  int
	ContentIndex int
}

response.output_audio.done

func (*ServerEventParamResponseOutputAudioDone) Json ¶ 

func (p *ServerEventParamResponseOutputAudioDone) Json() map[string]any

func (*ServerEventParamResponseOutputAudioDone) New ¶ 

func (p *ServerEventParamResponseOutputAudioDone) New(m map[string]any) error

type ServerEventParamResponseOutputAudioTranscriptDelta ¶ 

type ServerEventParamResponseOutputAudioTranscriptDelta struct {
	ResponseId   string
	ItemId       string
	OutputIndex  int
	ContentIndex int
	Delta        string
}

response.output_audio_transcript.delta

func (*ServerEventParamResponseOutputAudioTranscriptDelta) Json ¶ 

func (p *ServerEventParamResponseOutputAudioTranscriptDelta) Json() map[string]any

func (*ServerEventParamResponseOutputAudioTranscriptDelta) New ¶ 

func (p *ServerEventParamResponseOutputAudioTranscriptDelta) New(m map[string]any) error

type ServerEventParamResponseOutputAudioTranscriptDone ¶ 

type ServerEventParamResponseOutputAudioTranscriptDone struct {
	ResponseId   string
	ItemId       string
	OutputIndex  int
	ContentIndex int
	Transcript   string
}

response.output_audio_transcript.done

func (*ServerEventParamResponseOutputAudioTranscriptDone) Json ¶ 

func (p *ServerEventParamResponseOutputAudioTranscriptDone) Json() map[string]any

func (*ServerEventParamResponseOutputAudioTranscriptDone) New ¶ 

func (p *ServerEventParamResponseOutputAudioTranscriptDone) New(m map[string]any) error

type ServerEventParamResponseOutputItemAdded ¶ 

type ServerEventParamResponseOutputItemAdded struct {
	ResponseId  string
	OutputIndex int
	Item        map[string]any
}

response.output_item.added

func (*ServerEventParamResponseOutputItemAdded) Json ¶ 

func (p *ServerEventParamResponseOutputItemAdded) Json() map[string]any

func (*ServerEventParamResponseOutputItemAdded) New ¶ 

func (p *ServerEventParamResponseOutputItemAdded) New(m map[string]any) error

type ServerEventParamResponseOutputItemDone ¶ 

type ServerEventParamResponseOutputItemDone struct {
	ResponseId  string
	OutputIndex int
	Item        map[string]any
}

response.output_item.done

func (*ServerEventParamResponseOutputItemDone) Json ¶ 

func (p *ServerEventParamResponseOutputItemDone) Json() map[string]any

func (*ServerEventParamResponseOutputItemDone) New ¶ 

func (p *ServerEventParamResponseOutputItemDone) New(m map[string]any) error

type ServerEventParamResponseOutputTextDelta ¶ 

type ServerEventParamResponseOutputTextDelta struct {
	ResponseId   string
	ItemId       string
	OutputIndex  int
	ContentIndex int
	Delta        string
}

response.output_text.delta

func (*ServerEventParamResponseOutputTextDelta) Json ¶ 

func (p *ServerEventParamResponseOutputTextDelta) Json() map[string]any

func (*ServerEventParamResponseOutputTextDelta) New ¶ 

func (p *ServerEventParamResponseOutputTextDelta) New(m map[string]any) error

type ServerEventParamResponseOutputTextDone ¶ 

type ServerEventParamResponseOutputTextDone struct {
	ResponseId   string
	ItemId       string
	OutputIndex  int
	ContentIndex int
	Text         string
}

response.output_text.done

func (*ServerEventParamResponseOutputTextDone) Json ¶ 

func (p *ServerEventParamResponseOutputTextDone) Json() map[string]any

func (*ServerEventParamResponseOutputTextDone) New ¶ 

func (p *ServerEventParamResponseOutputTextDone) New(m map[string]any) error

type ServerEventParamSessionCreated ¶ 

type ServerEventParamSessionCreated struct {
	Session map[string]any
}

session.created

func (*ServerEventParamSessionCreated) Json ¶ 

func (p *ServerEventParamSessionCreated) Json() map[string]any

func (*ServerEventParamSessionCreated) New ¶ 

func (p *ServerEventParamSessionCreated) New(m map[string]any) error

type ServerEventParamSessionUpdated ¶ 

type ServerEventParamSessionUpdated struct {
	Session map[string]any
}

session.updated

func (*ServerEventParamSessionUpdated) Json ¶ 

func (p *ServerEventParamSessionUpdated) Json() map[string]any

func (*ServerEventParamSessionUpdated) New ¶ 

func (p *ServerEventParamSessionUpdated) New(m map[string]any) error

type ServerEventType ¶ 

type ServerEventType EventType
const (
	ServerEventTypeError                                            ServerEventType = "error"
	ServerEventTypeSessionCreated                                   ServerEventType = "session.created"
	ServerEventTypeSessionUpdated                                   ServerEventType = "session.updated"
	ServerEventTypeConversationItemAdded                            ServerEventType = "conversation.item.added"
	ServerEventTypeConversationItemDone                             ServerEventType = "conversation.item.done"
	ServerEventTypeConversationItemRetrieved                        ServerEventType = "conversation.item.retrieved"
	ServerEventTypeConversationItemInputAudioTranscriptionCompleted ServerEventType = "conversation.item.input_audio_transcription.completed"
	ServerEventTypeConversationItemInputAudioTranscriptionDelta     ServerEventType = "conversation.item.input_audio_transcription.delta"
	ServerEventTypeConversationItemInputAudioTranscriptionSegment   ServerEventType = "conversation.item.input_audio_transcription.segment"
	ServerEventTypeConversationItemInputAudioTranscriptionFailed    ServerEventType = "conversation.item.input_audio_transcription.failed"
	ServerEventTypeConversationItemTruncated                        ServerEventType = "conversation.item.truncated"
	ServerEventTypeConversationItemDeleted                          ServerEventType = "conversation.item.deleted"
	ServerEventTypeInputAudioBufferCommitted                        ServerEventType = "input_audio_buffer.committed"
	ServerEventTypeInputAudioBufferCleared                          ServerEventType = "input_audio_buffer.cleared"
	ServerEventTypeInputAudioBufferSpeechStarted                    ServerEventType = "input_audio_buffer.speech_started"
	ServerEventTypeInputAudioBufferSpeechStopped                    ServerEventType = "input_audio_buffer.speech_stopped"
	ServerEventTypeInputAudioBufferTimeoutTriggered                 ServerEventType = "input_audio_buffer.timeout_triggered"
	ServerEventTypeOutputAudioBufferStarted                         ServerEventType = "output_audio_buffer.started"
	ServerEventTypeOutputAudioBufferStopped                         ServerEventType = "output_audio_buffer.stopped"
	ServerEventTypeOutputAudioBufferCleared                         ServerEventType = "output_audio_buffer.cleared"
	ServerEventTypeResponseCreated                                  ServerEventType = "response.created"
	ServerEventTypeResponseDone                                     ServerEventType = "response.done"
	ServerEventTypeResponseOutputItemAdded                          ServerEventType = "response.output_item.added"
	ServerEventTypeResponseOutputItemDone                           ServerEventType = "response.output_item.done"
	ServerEventTypeResponseContentPartAdded                         ServerEventType = "response.content_part.added"
	ServerEventTypeResponseContentPartDone                          ServerEventType = "response.content_part.done"
	ServerEventTypeResponseOutputTextDelta                          ServerEventType = "response.output_text.delta"
	ServerEventTypeResponseOutputTextDone                           ServerEventType = "response.output_text.done"
	ServerEventTypeResponseOutputAudioTranscriptDelta               ServerEventType = "response.output_audio_transcript.delta"
	ServerEventTypeResponseOutputAudioTranscriptDone                ServerEventType = "response.output_audio_transcript.done"
	ServerEventTypeResponseOutputAudioDelta                         ServerEventType = "response.output_audio.delta"
	ServerEventTypeResponseOutputAudioDone                          ServerEventType = "response.output_audio.done"
	ServerEventTypeResponseFunctionCallArgumentsDelta               ServerEventType = "response.function_call_arguments.delta"
	ServerEventTypeResponseFunctionCallArgumentsDone                ServerEventType = "response.function_call_arguments.done"
	ServerEventTypeResponseMCPCallArgumentsDelta                    ServerEventType = "response.mcp_call_arguments.delta"
	ServerEventTypeResponseMCPCallArgumentsDone                     ServerEventType = "response.mcp_call_arguments.done"
	ServerEventTypeResponseMCPCallInProgress                        ServerEventType = "response.mcp_call.in_progress"
	ServerEventTypeResponseMCPCallCompleted                         ServerEventType = "response.mcp_call.completed"
	ServerEventTypeResponseMCPCallFailed                            ServerEventType = "response.mcp_call.failed"
	ServerEventTypeMCPListToolsInProgress                           ServerEventType = "mcp_list_tools.in_progress"
	ServerEventTypeMCPListToolsCompleted                            ServerEventType = "mcp_list_tools.completed"
	ServerEventTypeMCPListToolsFailed                               ServerEventType = "mcp_list_tools.failed"
	ServerEventTypeRatelimitsUpdated                                ServerEventType = "rate_limits.updated"
)

Server event types

type TrackLocalHandler ¶ 

type TrackLocalHandler func(track *webrtc.TrackLocalStaticSample)

type TrackRemoteHandler ¶ 

type TrackRemoteHandler func(track *webrtc.TrackRemote)

Source Files ¶

View all Source files

Directories ¶

Path Synopsis
_examples
cli command

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.