player

Documentation

Index

• type BackendPlayer
• type Player
  • func NewPlayer(ctx context.Context, cfg *config.Value, internalPlayer BackendPlayer) (*Player, error)
  • func (p *Player) AvailablePlayerTypes() []config.PlayerType
  • func (p *Player) Close() error
  • func (p *Player) Metadata() *model.Metadata
  • func (p *Player) Pause(value bool) error
  • func (p *Player) Play(url string) error
  • func (p *Player) Seek(amtSec int) *model.Metadata
  • func (p *Player) SetVolume(value int) (int, error)
  • func (p *Player) Stop() error

Types

type BackendPlayer

type BackendPlayer interface {
	Play(url string) error
	Pause(value bool) error
	Stop() error

	// SetVolume:
	//
	//   - sets the volume to an absolute value in [0,100]
	//   - returns the set value and nil if succeeded, error if failed
	SetVolume(value int) (int, error)

	Metadata() *model.Metadata

	// Seek:
	//
	//   - seek by a +/- amount of seconds,
	//   - returns the metadata for the new playback position if succeeded, metadata with error if failed
	Seek(amtSec int) *model.Metadata

	Close() error
}

type Player

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

func NewPlayer

func NewPlayer(ctx context.Context, cfg *config.Value, internalPlayer BackendPlayer) (*Player, error)

func (*Player) AvailablePlayerTypes

func (p *Player) AvailablePlayerTypes() []config.PlayerType

func (*Player) Close

func (p *Player) Close() error

func (*Player) Metadata

func (p *Player) Metadata() *model.Metadata

func (*Player) Pause

func (p *Player) Pause(value bool) error

func (*Player) Play

func (p *Player) Play(url string) error

func (*Player) Seek

func (p *Player) Seek(amtSec int) *model.Metadata

Seek:

• seek by a +/- amount of seconds,
• returns the metadata for the new playback position if succeeded, metadata with error if failed

func (*Player) SetVolume

func (p *Player) SetVolume(value int) (int, error)

SetVolume:

• sets the volume to an absolute value in [0,100]
• returns the set value and nil if succeeded, or an irrelevant value and error if failed

func (*Player) Stop

func (p *Player) Stop() error