plex

Documentation

Index

• Variables
• func CreateURI(server Host, path string) string
• func RemoveCachedToken() error
• func SelectedShows() ([]string, error)
• func SyncWatchedTv(source, destination Host) error
• func Token() string
• func TokenRequest(cred Credentials) error
• type Credentials
• type ER
• type Episode
• type Host
  • func (h *Host) GetToken(t string) error
• type SR
• type Show
  • func SearchShow(server Host, title string) (Show, error)

Variables

var CacheLifetime int

CacheLifetime controls when a cached image will be refreshed in days

var ShortVersion = strings.Split(Version, "-")[0]

ShortVersion contains the version in the format "1.2.3"

var Version = "0.0.0-default"

Version contains the version of the app, this contains the version with any pre-release metadata "1.2.3-prerelease.4"

Functions

func CreateURI

func CreateURI(server Host, path string) string

CreateURI assembles the URI for an API request

func RemoveCachedToken

func RemoveCachedToken() error

RemoveCachedToken removes the cached tokenfile

func SelectedShows

func SelectedShows() ([]string, error)

SelectedShows returns the selected tv shows from the tvShowsFile

func SyncWatchedTv

func SyncWatchedTv(source, destination Host) error

SyncWatchedTv synchronises the watched TV Shows

func Token

func Token() string

Token requests a MyPlex authentication token from cache or from MyPlex.

func TokenRequest

func TokenRequest(cred Credentials) error

TokenRequest requests a new token from MyPlex

Types

type Credentials

type Credentials struct {
	Username string
	Password string
}

Credentials stores MyPlex credentials

type ER

type ER struct {
	XMLName xml.Name  `xml:"MediaContainer"`
	Video   []Episode `xml:"Video"`
}

ER contains episode results

type Episode

type Episode struct {
	ID          int    `xml:"ratingKey,attr"`
	Name        string `xml:"title,attr"`
	Episode     int    `xml:"index,attr"`
	Season      int    `xml:"parentIndex,attr"`
	ViewCount   int    `xml:"viewCount,attr"`
	LastWatched int    `xml:"lastViewedAt,attr"`
}

Episode defines the structure of a Plex TV Episode

type Host

type Host struct {
	gorm.Model
	Name     string
	Hostname string
	Port     int
	Ssl      bool
	Token    string
}

Host defines the data to be stored for server objects

func (*Host) GetToken

func (h *Host) GetToken(t string) error

GetToken requests the AccessToken from MyPlex for the named server

type SR

type SR struct {
	XMLName     xml.Name `xml:"MediaContainer"`
	Directories []Show   `xml:"Directory"`
}

SR contains search results

type Show

type Show struct {
	ID           int    `xml:"ratingKey,attr"`
	Name         string `xml:"title,attr"`
	EpisodeCount int    `xml:"leafCount,attr"`
	Thumbnail    string `xml:"thumb,attr"`
	Banner       string `xml:"banner,attr"`
}

Show defines the structure of a Plex TV Show

func SearchShow

func SearchShow(server Host, title string) (Show, error)

SearchShow returns all episodes for a given TV Show