websocketv1

package
v1.6.2 Latest Latest
Warning

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

 Go to latest Published: Nov 7, 2024 License: MIT Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	PackageVersion string = "v1.0"
)

Variables

View Source 
var (
	// ErrInvalidMessageType invalid message type
	ErrInvalidMessageType = errors.New("invalid message type")

	// ErrUserCallbackNotDefined user callback not defined or invalid
	ErrUserCallbackNotDefined = errors.New("user callback not defined or invalid")

	// ErrUserChanNotDefined user chan not defined or invalid
	ErrUserChanNotDefined = errors.New("user chan not defined or invalid")
)

Functions

This section is empty.

Types

type CallbackRouter added in v1.6.0 

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

CallbackRouter routes events

func New 

func New(callback interfaces.LiveMessageCallback) *CallbackRouter

New creates a CallbackRouter with a user-defined callback Deprecated: Use NewCallbackRouter instead

func NewCallbackRouter added in v1.6.0 

func NewCallbackRouter(callback interfaces.LiveMessageCallback) *CallbackRouter

New creates a CallbackRouter with a user-defined callback

func NewCallbackWithDefault added in v1.6.0 

func NewCallbackWithDefault() *CallbackRouter

NewCallbackWithDefault creates a CallbackRouter with the default callback handler

func NewWithDefault 

func NewWithDefault() *CallbackRouter

NewWithDefault creates a CallbackRouter with the default callback handler Deprecated: Use NewCallbackWithDefault instead

func (*CallbackRouter) Binary added in v1.6.0 

func (r *CallbackRouter) Binary(byMsg []byte) error

Binary handles platform messages and routes them appropriately based on the MessageType

func (*CallbackRouter) Close added in v1.6.0 

func (r *CallbackRouter) Close(or *interfaces.CloseResponse) error

Close sends an CloseResponse message to the callback

func (*CallbackRouter) Error added in v1.6.0 

func (r *CallbackRouter) Error(er *interfaces.ErrorResponse) error

Error sends an ErrorResponse message to the callback

func (*CallbackRouter) Message added in v1.6.0 

func (r *CallbackRouter) Message(byMsg []byte) error

Message handles platform messages and routes them appropriately based on the MessageType

func (*CallbackRouter) Open added in v1.6.0 

func (r *CallbackRouter) Open(or *interfaces.OpenResponse) error

Open sends an OpenResponse message to the callback

func (*CallbackRouter) UnhandledMessage added in v1.6.0 

func (r *CallbackRouter) UnhandledMessage(byMsg []byte) error

UnhandledMessage logs and handles any unexpected message types

type ChanRouter added in v1.6.0 

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

ChanRouter routes events

func NewChanRouter added in v1.6.0 

func NewChanRouter(chans interfaces.LiveMessageChan) *ChanRouter

New creates a ChanRouter with a user-defined channels gocritic:ignore

func NewChanWithDefault added in v1.6.0 

func NewChanWithDefault() *ChanRouter

NewWithDefault creates a ChanRouter with the default callback handler

func (*ChanRouter) Binary added in v1.6.0 

func (r *ChanRouter) Binary(byMsg []byte) error

Binary handles platform messages and routes them appropriately based on the MessageType

func (*ChanRouter) Close added in v1.6.0 

func (r *ChanRouter) Close(cr *interfaces.CloseResponse) error

Close sends an CloseResponse message to the callback

func (*ChanRouter) Error added in v1.6.0 

func (r *ChanRouter) Error(er *interfaces.ErrorResponse) error

Error sends an ErrorResponse message to the callback

func (*ChanRouter) Message added in v1.6.0 

func (r *ChanRouter) Message(byMsg []byte) error

Message handles platform messages and routes them appropriately based on the MessageType

func (*ChanRouter) Open added in v1.6.0 

func (r *ChanRouter) Open(or *interfaces.OpenResponse) error

Open sends an OpenResponse message to the callback

func (*ChanRouter) UnhandledMessage added in v1.6.0 

func (r *ChanRouter) UnhandledMessage(byMsg []byte) error

UnhandledMessage logs and handles any unexpected message types

type DefaultCallbackHandler 

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

Using Callbacks

DefaultCallbackHandler is a default callback handler for live transcription Simply prints the transcript to stdout

func NewDefaultCallbackHandler 

func NewDefaultCallbackHandler() *DefaultCallbackHandler

NewDefaultCallbackHandler creates a new DefaultCallbackHandler

func (DefaultCallbackHandler) Close 

func (dch DefaultCallbackHandler) Close(or *interfaces.CloseResponse) error

Close is the callback for when the connection closes

func (DefaultCallbackHandler) Error 

func (dch DefaultCallbackHandler) Error(er *interfaces.ErrorResponse) error

Error is the callback for a error messages

func (DefaultCallbackHandler) Message 

func (dch DefaultCallbackHandler) Message(mr *interfaces.MessageResponse) error

Message is the callback for a transcription message

func (DefaultCallbackHandler) Metadata 

func (dch DefaultCallbackHandler) Metadata(md *interfaces.MetadataResponse) error

Metadata is the callback for information about the connection

func (DefaultCallbackHandler) Open 

func (dch DefaultCallbackHandler) Open(or *interfaces.OpenResponse) error

Open is the callback for when the connection opens

func (DefaultCallbackHandler) SpeechStarted 

func (dch DefaultCallbackHandler) SpeechStarted(ssr *interfaces.SpeechStartedResponse) error

SpeechStarted is when VAD detects noise

func (DefaultCallbackHandler) UnhandledEvent 

func (dch DefaultCallbackHandler) UnhandledEvent(byData []byte) error

UnhandledEvent is the callback for unknown messages

func (DefaultCallbackHandler) UtteranceEnd 

func (dch DefaultCallbackHandler) UtteranceEnd(ur *interfaces.UtteranceEndResponse) error

UtteranceEnd is the callback for when a channel goes silent

type DefaultChanHandler added in v1.6.0 

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

Using Channels

DefaultCallbackHandler is a default callback handler for live transcription Simply prints the transcript to stdout

func NewDefaultChanHandler added in v1.6.0 

func NewDefaultChanHandler() *DefaultChanHandler

NewDefaultChanHandler creates a new DefaultChanHandler

func (DefaultChanHandler) GetClose added in v1.6.0 

func (dch DefaultChanHandler) GetClose() []*chan *interfaces.CloseResponse

GetClose returns the close channels

func (DefaultChanHandler) GetError added in v1.6.0 

func (dch DefaultChanHandler) GetError() []*chan *interfaces.ErrorResponse

GetError returns the error channels

func (DefaultChanHandler) GetMessage added in v1.6.0 

func (dch DefaultChanHandler) GetMessage() []*chan *interfaces.MessageResponse

GetMessage returns the message channels

func (DefaultChanHandler) GetMetadata added in v1.6.0 

func (dch DefaultChanHandler) GetMetadata() []*chan *interfaces.MetadataResponse

GetMetadata returns the metadata channels

func (DefaultChanHandler) GetOpen added in v1.6.0 

func (dch DefaultChanHandler) GetOpen() []*chan *interfaces.OpenResponse

GetOpen returns the open channels

func (DefaultChanHandler) GetSpeechStarted added in v1.6.0 

func (dch DefaultChanHandler) GetSpeechStarted() []*chan *interfaces.SpeechStartedResponse

GetSpeechStarted returns the speech started channels

func (DefaultChanHandler) GetUnhandled added in v1.6.0 

func (dch DefaultChanHandler) GetUnhandled() []*chan *[]byte

GetUnhandled returns the unhandled event channels

func (DefaultChanHandler) GetUtteranceEnd added in v1.6.0 

func (dch DefaultChanHandler) GetUtteranceEnd() []*chan *interfaces.UtteranceEndResponse

GetUtteranceEnd returns the utterance end channels

func (DefaultChanHandler) Run added in v1.6.0 

func (dch DefaultChanHandler) Run() error

Open is the callback for when the connection opens

type MessageRouter 

type MessageRouter = CallbackRouter

MessageRouter is the interface for routing messages Deprecated: Use CallbackRouter instead

Source Files

View all Source files

Directories

Path Synopsis
This package defines interfaces for the live API
 This package defines interfaces for the live API

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.