spiff

Documentation

Overview

Package spiff provides the model for all playlists used within TakeoutFM. A spiff is a container for one or more media tracks with basic media metadata. TakeoutFM also uses json patch to manipulate spiffs for remote playlist management.

Index

• Constants
• func Compare(before, after []byte) (bool, error)
• func Patch(data []byte, patch []byte) ([]byte, error)
• type Entry
• type Header
• type Playlist
  • func NewPlaylist(listType string) *Playlist
  • func Unmarshal(data []byte) (*Playlist, error)
  • func (p *Playlist) Empty() bool
  • func (p *Playlist) Length() int
  • func (playlist *Playlist) Marshal() ([]byte, error)
• type Spiff

Constants

const (
	TypeMusic   = "music"
	TypeVideo   = "video"
	TypePodcast = "podcast"
	TypeStream  = "stream"
)

const (
	ContentType = "application/json-patch+json"
)

Functions

func Compare

func Compare(before, after []byte) (bool, error)

func Patch

func Patch(data []byte, patch []byte) ([]byte, error)

Types

type Entry

type Entry struct {
	Ref        string   `json:"$ref,omitempty"`
	Creator    string   `json:"creator,omitempty" spiff:"creator"`
	Album      string   `json:"album,omitempty" spiff:"album"`
	Title      string   `json:"title,omitempty" spiff:"title"`
	Image      string   `json:"image,omitempty" spiff:"image"`
	Location   []string `json:"location,omitempty" spiff:"location"`
	Identifier []string `json:"identifier,omitempty" spiff:"identifier"`
	Size       []int64  `json:"size,omitempty"`
	Date       string   `json:"date,omitempty" spiff:"date"` // "2005-01-08T17:10:47-05:00",
}

type Header

type Header struct {
	Title    string `json:"title"`
	Creator  string `json:"creator,omitempty"`
	Image    string `json:"image,omitempty"`
	Location string `json:"location,omitempty"`
	Date     string `json:"date,omitempty"` // "2005-01-08T17:10:47-05:00",
}

type Playlist

type Playlist struct {
	Spiff    Spiff   `json:"playlist"`
	Index    int     `json:"index"`
	Position float64 `json:"position"`
	Type     string  `json:"type"`
}

func NewPlaylist

func NewPlaylist(listType string) *Playlist

func Unmarshal

func Unmarshal(data []byte) (*Playlist, error)

TODO could be large Playlist so return pointer

func (*Playlist) Empty

func (p *Playlist) Empty() bool

func (*Playlist) Length

func (p *Playlist) Length() int

func (*Playlist) Marshal

func (playlist *Playlist) Marshal() ([]byte, error)

type Spiff

type Spiff struct {
	Header
	Entries []Entry `json:"track"`
}