device

Documentation

Index

• Variables
• func GetKind(d Device) deviceCommon.Kind
• type Device
  • func CreateOutputDevice(settings deviceCommon.Settings) (Device, error)

Variables

var (
	// ErrDeviceNotSupported is returned when the requested device is not supported
	ErrDeviceNotSupported = errors.New("device not supported")
)

var (
	// Map is the mapping of device name to device details
	Map = make(map[string]deviceDetails)
)

Functions

func GetKind

func GetKind(d Device) deviceCommon.Kind

GetKind returns the kind for the passed in device

Types

type Device

type Device interface {
	Name() string
	Play(in <-chan *premix.PremixData) error
	PlayWithCtx(ctx context.Context, in <-chan *premix.PremixData) error
	Close() error
}

Device is an interface to output device operations

func CreateOutputDevice

func CreateOutputDevice(settings deviceCommon.Settings) (Device, error)

CreateOutputDevice creates an output device based on the provided settings