pbReader

Documentation

Index

• type Option
  • func Channels(chs int) Option
  • func Decoder(dec audiocodec.Decoder) Option
  • func Samplerate(s float64) Option
• type Options
• type PbReader
  • func NewPbReader(opts ...Option) (*PbReader, error)
  • func (pbr *PbReader) Close() error
  • func (pbr *PbReader) Enqueue(data []byte) error
  • func (pbr *PbReader) SetCb(cb audio.OnDataCb)
  • func (pbr *PbReader) Start() error
  • func (pbr *PbReader) Stop() error

Types

type Option

type Option func(*Options)

Option is the type for a function option

func Channels

func Channels(chs int) Option

Channels is a functional option to set the amount of channels to be used with the audio device. Typically this is either Mono (1) or Stereo (2). Make sure that your audio device supports the specified amount of channels.

func Decoder

func Decoder(dec audiocodec.Decoder) Option

Decoder is a functional option to set a specific decoder. By default, the opus decoder is used.

func Samplerate

func Samplerate(s float64) Option

Samplerate is a functional option to set the sampling rate of the audio device. Make sure your audio device supports the specified sampling rate.

type Options

type Options struct {
	DeviceName string
	Decoder    audiocodec.Decoder
	Channels   int
	Samplerate float64
	Callback   audio.OnDataCb
}

Options is the data structure which holds the option values. These values are typically set through functional options.

type PbReader

type PbReader struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

PbReader implements the audio.Source interface and is used to read audio frames encapsulated in Protocol Buffer messages, typically received from the network.

func NewPbReader

func NewPbReader(opts ...Option) (*PbReader, error)

NewPbReader is the constructor for a PbReader object.

func (*PbReader) Close

func (pbr *PbReader) Close() error

Close shuts down the PbReader

func (*PbReader) Enqueue

func (pbr *PbReader) Enqueue(data []byte) error

Enqueue is the entry point for the PbReader. Incoming Protobufs are enqueded with this function.

func (*PbReader) SetCb

func (pbr *PbReader) SetCb(cb audio.OnDataCb)

SetCb sets the callback which get's executed once the Protobuf has been converted in an audio.Msg.

func (*PbReader) Start

func (pbr *PbReader) Start() error

Start processing Protobufs

func (*PbReader) Stop

func (pbr *PbReader) Stop() error

Stop processing Protobufs