live

Documentation

Overview

Copyright 2023-2024 Deepgram SDK contributors. All Rights Reserved. Use of this source code is governed by a MIT license that can be found in the LICENSE file. SPDX-License-Identifier: MIT

Index

• Variables
• type DefaultCallbackHandler
  • func NewDefaultCallbackHandler() DefaultCallbackHandler
  • func (dch DefaultCallbackHandler) Close(or *interfaces.CloseResponse) error
  • func (dch DefaultCallbackHandler) Error(er *interfaces.ErrorResponse) error
  • func (dch DefaultCallbackHandler) Message(mr *interfaces.MessageResponse) error
  • func (dch DefaultCallbackHandler) Metadata(md *interfaces.MetadataResponse) error
  • func (dch DefaultCallbackHandler) Open(or *interfaces.OpenResponse) error
  • func (dch DefaultCallbackHandler) SpeechStarted(ssr *interfaces.SpeechStartedResponse) error
  • func (dch DefaultCallbackHandler) UnhandledEvent(byData []byte) error
  • func (dch DefaultCallbackHandler) UtteranceEnd(ur *interfaces.UtteranceEndResponse) error
• type MessageRouter
  • func New(callback interfaces.LiveMessageCallback) *MessageRouter
  • func NewWithDefault() *MessageRouter
  • func (r *MessageRouter) CloseHelper(or *interfaces.CloseResponse) error
  • func (r *MessageRouter) ErrorHelper(er *interfaces.ErrorResponse) error
  • func (r *MessageRouter) Message(byMsg []byte) error
  • func (r *MessageRouter) OpenHelper(or *interfaces.OpenResponse) error
  • func (r *MessageRouter) UnhandledMessage(byMsg []byte) error
• type MessageType

Variables

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

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

Types

type DefaultCallbackHandler

type DefaultCallbackHandler struct{}

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 MessageRouter

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

MessageRouter routes events

func New

func New(callback interfaces.LiveMessageCallback) *MessageRouter

New creates a MessageRouter with a user-defined callback

func NewWithDefault

func NewWithDefault() *MessageRouter

NewWithDefault creates a MessageRouter with the default callback handler

func (*MessageRouter) CloseHelper

func (r *MessageRouter) CloseHelper(or *interfaces.CloseResponse) error

OpenResponse handles the OpenResponse message

func (*MessageRouter) ErrorHelper

func (r *MessageRouter) ErrorHelper(er *interfaces.ErrorResponse) error

ErrorResponse handles the OpenResponse message

func (*MessageRouter) Message

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

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

func (*MessageRouter) OpenHelper

func (r *MessageRouter) OpenHelper(or *interfaces.OpenResponse) error

OpenHelper handles the OpenResponse message

func (*MessageRouter) UnhandledMessage

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

UnhandledMessage logs and handles any unexpected message types

type MessageType

type MessageType struct {
	Type string `json:"type"`
}

MessageType is the header to bootstrap you way unmarshalling other messages

Example:
{
	"type": "message",
	"message": {
		...
	}
}