v1

Documentation

Index

• Constants
• type Buffering
  • func NewBuffering(buffering bool) *Buffering
• type Magnet
  • func NewMagnetLink(magnet, path, title, description string, subtitles []Subtitle) *Magnet
• type Message
• type Pause
  • func NewPause(pause bool) *Pause
• type Position
  • func NewPosition(position float64) *Position
• type Subtitle

Constants

const (
	TypeMagnet    = "magnet"    // TypeMagnet contains a magnet link
	TypePause     = "pause"     // TypePause synchronizes play/pause state
	TypePosition  = "position"  // TypePosition synchronizes seek positions
	TypeBuffering = "buffering" // TypeBuffering synchronizes buffering state
)

Types

type Buffering

type Buffering struct {
	Message
	Buffering bool `json:"buffering"` // Whether to show the buffering state
}

Buffering synchronizes buffering state

func NewBuffering

func NewBuffering(buffering bool) *Buffering

type Magnet

type Magnet struct {
	Message
	Magnet      string     `json:"magnet"`      // Encapsulated magnet link
	Path        string     `json:"path"`        // Path of the media to play
	Title       string     `json:"title"`       // Title of the media to play
	Description string     `json:"description"` // Description of the media to play
	Subtitles   []Subtitle `json:"subtitles"`   // Subtitles of the media to play
}

Magnet contains a magnet link

func NewMagnetLink

func NewMagnetLink(magnet, path, title, description string, subtitles []Subtitle) *Magnet

type Message

type Message struct {
	Type string `json:"type"` // Message type to unmarshal to
}

Message is a generic message container

type Pause

type Pause struct {
	Message
	Pause bool `json:"pause"` // Whether to pause or play
}

Pause synchronizes play/pause state

func NewPause

func NewPause(pause bool) *Pause

type Position

type Position struct {
	Message
	Position float64 `json:"position"` // Position to seek to
}

Position synchronizes seek positions

func NewPosition

func NewPosition(position float64) *Position

type Subtitle

type Subtitle struct {
	Name string `json:"name"` // Name of the subtitle
	Size int    `json:"size"` // Size of the subtitle file
}

Subtitle describes a subtitle file