progress

Documentation

Overview

Package progress manages user progress data which contains media offset and duration to allow incremental watch/listen progress to be saved and retrieved to/from the server based on etag.

Index

• Variables
• type Progress
  • func NewProgress(config *config.Config) *Progress
  • func (p *Progress) Close()
  • func (p *Progress) Delete(user auth.User, offset Offset) error
  • func (p *Progress) Offset(user auth.User, id int) (Offset, error)
  • func (p *Progress) Offsets(user auth.User) []Offset
  • func (p *Progress) Open() (err error)
  • func (p *Progress) Update(user auth.User, newOffset Offset) error

Variables

var (
	ErrOffsetTooOld = errors.New("offset is old")
	ErrOffsetSame   = errors.New("offset is the same")
	ErrAccessDenied = errors.New("access denied")
)

var (
	ErrOffsetNotFound = errors.New("offset not found")
)

Types

type Progress

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

func NewProgress

func NewProgress(config *config.Config) *Progress

func (*Progress) Close

func (p *Progress) Close()

func (*Progress) Delete

func (p *Progress) Delete(user auth.User, offset Offset) error

Delete will delete the provided user & offset, ensuring the offset belongs to the user.

func (*Progress) Offset

func (p *Progress) Offset(user auth.User, id int) (Offset, error)

Offset gets the user offset based on the internal id.

func (*Progress) Offsets

func (p *Progress) Offsets(user auth.User) []Offset

Offsets gets all the offets for the user.

func (*Progress) Open

func (p *Progress) Open() (err error)

func (*Progress) Update

func (p *Progress) Update(user auth.User, newOffset Offset) error

Update will create or update an offset for the provided user using the etag as the primary key.