player

Documentation

Overview

Package player provides a simple audio player based on Takeout server-based playlists. There's support for FLAC, OGG, MP3 and WAV audio decoding, along with Internet radio and ICY metadata. Internally Beep and Oto are used which are known to work on Linux, BSDs, macOS, Windows, and more.

Index

• Constants
• Variables
• func Notify(streamer beep.StreamSeekCloser, halfway NotifyFunc) *notify
• type Config
  • func NewConfig() *Config
• type Icy
  • func NewIcyReader(interval int, reader io.ReadCloser, onMetaData func(IcyMetadata)) *Icy
  • func (icy *Icy) Close() error
  • func (icy *Icy) Read(p []byte) (n int, err error)
• type IcyHeaders
• type IcyMetadata
• type NotifyFunc
• type Player
  • func NewPlayer(context client.Context, playlist spiff.Playlist, config *Config) *Player
  • func (p *Player) Album() string
  • func (p *Player) Artist() string
  • func (p *Player) Context() client.Context
  • func (p *Player) ETag() string
  • func (p *Player) Image() string
  • func (p *Player) Index() int
  • func (p *Player) IsMusic() bool
  • func (p *Player) IsPodcast() bool
  • func (p *Player) IsStream() bool
  • func (p *Player) Length() int
  • func (p *Player) Next()
  • func (p *Player) Pause()
  • func (p *Player) Position() (time.Duration, time.Duration)
  • func (p *Player) SkipBackward()
  • func (p *Player) SkipForward()
  • func (p *Player) Start()
  • func (p *Player) Stop()
  • func (p *Player) Title() string
  • func (p *Player) Track() (string, string, string, string)

Constants

const (
	ActionNext playerAction = iota
	ActionSkipForward
	ActionSkipBackward
	ActionPause
	ActionStop
)

Variables

var (
	ErrInvalidMetadataLength = errors.New("icy metadata length is invalid")
	ErrInvalidIntervalLength = errors.New("icy metadata interval is invalid")

	HeaderIcyBr          = http.CanonicalHeaderKey("Icy-Br")
	HeaderIcyDescription = http.CanonicalHeaderKey("Icy-Description")
	HeaderIcyGenre       = http.CanonicalHeaderKey("Icy-Genre")
	HeaderIcyMetaData    = http.CanonicalHeaderKey("Icy-MetaData")
	HeaderIcyMetaInt     = http.CanonicalHeaderKey("Icy-MetaInt")
	HeaderIcyName        = http.CanonicalHeaderKey("Icy-Name")
	HeaderIcyPublic      = http.CanonicalHeaderKey("Icy-Pub")
	HeaderIcyUrl         = http.CanonicalHeaderKey("Icy-Url")
)

Functions

func Notify

func Notify(streamer beep.StreamSeekCloser, halfway NotifyFunc) *notify

Types

type Config

type Config struct {
	Repeat   bool
	Buffer   time.Duration
	OnTrack  func(*Player)
	OnListen func(*Player)
	OnPause  func(*Player)
	OnError  func(*Player, error)
}

func NewConfig

func NewConfig() *Config

type Icy

type Icy struct {
	OnMetadata func(IcyMetadata)
	// contains filtered or unexported fields
}

func NewIcyReader

func NewIcyReader(interval int, reader io.ReadCloser, onMetaData func(IcyMetadata)) *Icy

func (*Icy) Close

func (icy *Icy) Close() error

func (*Icy) Read

func (icy *Icy) Read(p []byte) (n int, err error)

type IcyHeaders

type IcyHeaders struct {
	Bitrate     int
	Description string
	Genre       string
	Interval    int
	Name        string
	Public      bool
	Url         string
}

type IcyMetadata

type IcyMetadata struct {
	StreamTitle string
	StreamUrl   string
}

type NotifyFunc

type NotifyFunc func()

type Player

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

func NewPlayer

func NewPlayer(context client.Context, playlist spiff.Playlist, config *Config) *Player

func (*Player) Album

func (p *Player) Album() string

func (*Player) Artist

func (p *Player) Artist() string

func (*Player) Context

func (p *Player) Context() client.Context

func (*Player) ETag

func (p *Player) ETag() string

func (*Player) Image

func (p *Player) Image() string

func (*Player) Index

func (p *Player) Index() int

func (*Player) IsMusic

func (p *Player) IsMusic() bool

func (*Player) IsPodcast

func (p *Player) IsPodcast() bool

func (*Player) IsStream

func (p *Player) IsStream() bool

func (*Player) Length

func (p *Player) Length() int

func (*Player) Next

func (p *Player) Next()

func (*Player) Pause

func (p *Player) Pause()

func (*Player) Position

func (p *Player) Position() (time.Duration, time.Duration)

func (*Player) SkipBackward

func (p *Player) SkipBackward()

func (*Player) SkipForward

func (p *Player) SkipForward()

func (*Player) Start

func (p *Player) Start()

func (*Player) Stop

func (p *Player) Stop()

func (*Player) Title

func (p *Player) Title() string

func (*Player) Track

func (p *Player) Track() (string, string, string, string)