replay

Documentation

Overview

Implementation for a replay device. In this case, replays an audio file to stream into a listener

Index

• Variables
• type Client
  • func New(opts Options) (*Client, error)
  • func (c *Client) Mute()
  • func (c *Client) Read() ([]byte, error)
  • func (c *Client) Start() error
  • func (c *Client) Stop() error
  • func (c *Client) Stream(w io.Writer) error
  • func (c *Client) Unmute()
• type Options

Variables

var (
	// ErrInvalidInput required input was not found
	ErrInvalidInput = errors.New("required input was not found")
)

errors

Types

type Client

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

Client is a replay device. In this case, an audio stream.

func New

func New(opts Options) (*Client, error)

New creates an audio replay device

func (*Client) Mute

func (c *Client) Mute()

Mute silences the replay device

func (*Client) Read

func (c *Client) Read() ([]byte, error)

Read bits from the replay device

func (*Client) Start

func (c *Client) Start() error

Start begins streaming the audio for the device

func (*Client) Stop

func (c *Client) Stop() error

Stop terminates the playback on the replay device

func (*Client) Stream

func (c *Client) Stream(w io.Writer) error

Stream is a helper function to stream the replay device data to a source

func (*Client) Unmute

func (c *Client) Unmute()

Unmute restores playback on the replay device

type Options

type Options struct {
	FullFilename string
}

ReplayOpts defines options for this device