player

Documentation

Index

• Constants
• Variables
• type Info
• type Player
  • func New(player string) (*Player, error)
  • func (p *Player) Add(url string) error
  • func (p *Player) Close()
  • func (p *Player) Next() error
  • func (p *Player) Pause() error
  • func (p *Player) Play() error
  • func (p *Player) Seek(position float64) error
  • func (p *Player) Stop() error

Constants

const (
	// MPV (https://mpv.io) is a free, open source, and cross-platform media player
	MPV = "mpv"
	// VLC (https://www.videolan.org/vlc/index.html) is a free and open source
	// cross-platform multimedia player and framework that plays most multimedia
	// files as well as DVDs, Audio CDs, VCDs, and various streaming protocols.
	VLC = "vlc"
	OMX = "omx"
)

<GLOBAL>

Variables

var Players = []string{MPV, VLC}

<GLOBAL>

Types

type Info

type Info struct {
	Title     string
	Thumbnail string
	Volume    float64
	Position  float64
	Playing   bool
}

Info represents the current state of the video player

type Player

type Player struct {
	State *state
	// contains filtered or unexported fields
}

Player is an abstraction of a video player. the backend player is determined by the platform

func New

func New(player string) (*Player, error)

New creates a player interface

func (*Player) Add

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

Add adds the url to the playlist

func (*Player) Close

func (p *Player) Close()

Close cleans up resources

func (*Player) Next

func (p *Player) Next() error

Next sets the player to the next video in the playlist

func (*Player) Pause

func (p *Player) Pause() error

Pause pauses the current video. If there's no video, nothing will happen

func (*Player) Play

func (p *Player) Play() error

Play plays the current video. If there's no video, nothing will happen

func (*Player) Seek

func (p *Player) Seek(position float64) error

Seek sets the current video to position (from 0 - 1.0)

func (*Player) Stop

func (p *Player) Stop() error

Stop stops the player and clear up the playlist