supports

Documentation

Overview

Package supports holds interface types for filter supports

Index

• type BitDepth
• type Channels
• type Data
• type Encoding
• type Loop
• type SampleRate
• type Unsupported
  • func NewUnsupported(filters []string) Unsupported
  • func (un Unsupported) Error() string

Types

type BitDepth

type BitDepth interface {
	GetBitDepth() *uint16
}

BitDepth types support filters that manipulate bit depth. Probably only useful in combination as an encoding

type Channels

type Channels interface {
	GetChannels() *uint16
}

Channels types support filters that manipulate channels. Probably only useful in combination as an encoding

type Data

type Data interface {
	GetData() *[]byte
}

Data types support filters that manipulate their raw audio data

type Encoding

type Encoding interface {
	SampleRate
	BitDepth
	Data
	Channels
}

Encoding types can get any variable on an audio.Encoding. They do not just return an audio.Encoding because that would be an import loop or another package to avoid said import loop.

type Loop

type Loop interface {
	GetLoop() *bool
}

Loop types support filters that manipulate whether they loop

type SampleRate

type SampleRate interface {
	GetSampleRate() *uint32
}

SampleRate types support filters that manipulate their SampleRate

type Unsupported

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

Unsupported is an error type reporting that a filter was not supported by the Audio type it was used on

func NewUnsupported

func NewUnsupported(filters []string) Unsupported

NewUnsupported returns an Unsupported error with the input filters

func (Unsupported) Error

func (un Unsupported) Error() string