plex

package module

Go to main page

Versions in this module

v1

v1.1.12

Jan 4, 2024

Changes in this version

type Metadata

+ Live string

v1.1.11

Jan 10, 2023

Changes in this version

type Metadata

+ GrandparentGUID string

+ ParentGUID string

v1.1.10

Nov 12, 2022

v1.1.9

Oct 20, 2022

Changes in this version

type Connection

+ Relay bool

v1.1.8

Oct 20, 2022

v1.1.7

Apr 29, 2022

Changes in this version

+ type FixedRating float32

+ func (value *FixedRating) UnmarshalJSON(data []byte) error

v1.1.6

Apr 28, 2022

Changes in this version

type Metadata

+ Ratings []Rating

v1.1.5

Apr 25, 2022

Changes in this version

type PlaySessionStateNotification

+ ClientIdentifier string

+ PlayQueueID int64

type Plex

+ func (p *Plex) GetServerDevices() ([]PMSDevices, error)

v1.1.4

Mar 9, 2022

v1.1.3

Feb 27, 2022

v1.1.2

Feb 19, 2022

Changes in this version

type Metadata

+ AudienceRating float64

+ AudienceRatingImage string

+ UserRating float64

+ type Rating struct

+ Count int

+ Image string

+ Type string

+ Value float64

v1.1.1

Feb 9, 2022

v1.1.0

Dec 18, 2021

Changes in this version

+ type Timestamp time.Time

+ func (t *Timestamp) UnmarshalJSON(s []byte) (err error)

+ func (t Timestamp) MarshalJSON() ([]byte, error)

+ func (t Timestamp) String() string

+ func (t Timestamp) Time() time.Time

+ func (t Timestamp) Unix() int64

v1.0.4

Dec 17, 2021

v1.0.3

Dec 13, 2021

Changes in this version

+ const ErrorCommon

+ const ErrorFailedToSetWebhook

+ const ErrorKeyIsRequired

+ const ErrorLinkAccount

+ const ErrorMissingSessionKey

+ const ErrorNotAuthorized

+ const ErrorPINNotAuthorized

+ const ErrorServer

+ const ErrorServerReplied

+ const ErrorTitleRequired

+ const ErrorUrlTokenRequired

+ type AltGUID struct

+ ID string

type Metadata

+ AltGUIDs []AltGUID

type Plex

+ DownloadClient http.Client

+ func (p *Plex) Download(meta Metadata, path string, createFolders bool, skipIfExists bool) error

v1.0.2

Feb 15, 2021

Changes in this version

type Metadata

+ OriginalTitle string

v1.0.1

Feb 15, 2021

v1.0.0

Feb 12, 2021

Changes in this version

type UserPlexTV

+ XMLName xml.Name

v0

v0.0.2

Jan 29, 2021

Changes in this version

+ const ErrorInvalidToken

+ func GetMediaType(info MediaMetadata) string

+ func GetMediaTypeID(mediaType string) string

+ type ActivityNotification struct

+ Activity struct{ ... }

+ Event string

+ UUID string

+ type BackgroundProcessingQueueEventNotification struct

+ Event string

+ QueueID int64

+ type BaseAPIResponse struct

+ MediaContainer struct{ ... }

+ type Connection struct

+ Address string

+ Local int

+ Port string

+ Protocol string

+ URI string

+ type CreateLibraryParams struct

+ Agent string

+ Language string

+ LibraryType string

+ Location string

+ Name string

+ Scanner string

+ func LibraryParamsFromMediaType(mediaType string) (CreateLibraryParams, error)

+ type CurrentSessions struct

+ MediaContainer struct{ ... }

+ type DevicesResponse struct

+ ID int

+ LastSeenAt string

+ Name string

+ Product string

+ Version string

+ type Directory struct

+ Agent string

+ AllowSync bool

+ Art string

+ Composite string

+ CreatedAt int

+ Filter bool

+ Key string

+ Language string

+ Location []Location

+ Refreshing bool

+ Scanner string

+ Thumb string

+ Title string

+ Type string

+ UUID string

+ UpdatedAt int

+ type ErrorResponse struct

+ Code int

+ Message string

+ type Friends struct

+ AllowCameraUpload string

+ AllowChannels string

+ AllowSync string

+ Email string

+ FilterAll string

+ FilterMovies string

+ FilterMusic string

+ FilterPhotos string

+ FilterTelevision string

+ Home string

+ ID int

+ Protected string

+ RecommendationsPlaylistID string

+ Restricted string

+ Server struct{ ... }

+ Thumb string

+ Title string

+ Username string

+ type InviteFriendParams struct

+ Label string

+ LibraryIDs []int

+ MachineID string

+ UsernameOrEmail string

+ type LibraryLabels struct

+ AllowSync string

+ Art string

+ Children []struct{ ... }

+ Content string

+ ElementType string

+ Identifier string

+ MediaTagPrefix string

+ MediaTagVersion string

+ Thumb string

+ Title1 string

+ Title2 string

+ ViewGroup string

+ ViewMode string

+ type LibrarySections struct

+ MediaContainer struct{ ... }

+ type Location struct

+ ID int

+ Path string

+ type Media struct

+ AspectRatio float32

+ AudioChannels int

+ AudioCodec string

+ AudioProfile string

+ Bitrate int

+ Container string

+ DeletedAt int

+ Duration int

+ Has64bitOffsets bool

+ Height int

+ ID int

+ OptimizedForStreaming int

+ Part []Part

+ Selected bool

+ VideoCodec string

+ VideoFrameRate string

+ VideoProfile string

+ VideoResolution string

+ Width int

+ type MediaContainer struct

+ AllowSync bool

+ Identifier string

+ LibrarySectionID int

+ LibrarySectionTitle string

+ LibrarySectionUUID string

+ MediaTagPrefix string

+ MediaTagVersion int

+ Metadata []Metadata

+ Size int

+ type MediaMetadata struct

+ MediaContainer MediaContainer

+ type MediaV1 struct

+ AspectRatio float32

+ AudioChannels float32

+ Bitrate int

+ Duration int

+ Has64bitOffsets string

+ Height int

+ ID int

+ OptimizedForStreaming int

+ Part []PartV1

+ Width int

+ type Metadata struct

+ AddedAt int

+ Art string

+ ContentRating string

+ Director []TaggedData

+ Duration int

+ GUID string

+ GrandparentArt string

+ GrandparentKey string

+ GrandparentRatingKey string

+ GrandparentTheme string

+ GrandparentThumb string

+ GrandparentTitle string

+ Index int64

+ Key string

+ LastViewedAt int

+ LibrarySectionID int

+ LibrarySectionKey string

+ LibrarySectionTitle string

+ Media []Media

+ OriginallyAvailableAt string

+ ParentIndex int64

+ ParentKey string

+ ParentRatingKey string

+ ParentThumb string

+ ParentTitle string

+ Player Player

+ Rating float64

+ RatingCount string

+ RatingKey string

+ Session Session

+ SessionKey string

+ Summary string

+ Thumb string

+ Title string

+ TitleSort string

+ Type string

+ UpdatedAt int

+ User User

+ ViewCount json.Number

+ ViewOffset int

+ Writer []TaggedData

+ Year int

+ type MetadataChildren struct

+ MediaContainer MediaContainer

+ type MetadataV1 struct

+ AddedAt string

+ Duration string

+ Index int64

+ LastViewedAt string

+ LibrarySectionID string

+ Media []MediaV1

+ ParentIndex int64

+ Rating string

+ UpdatedAt string

+ ViewOffset string

+ Year string

+ type NotificationContainer struct

+ ActivityNotification []ActivityNotification

+ BackgroundProcessingQueueEventNotification []BackgroundProcessingQueueEventNotification

+ PlaySessionStateNotification []PlaySessionStateNotification

+ ReachabilityNotification []ReachabilityNotification

+ Setting []Setting

+ Size int64

+ StatusNotification []StatusNotification

+ TimelineEntry []TimelineEntry

+ TranscodeSession []TranscodeSession

+ Type string

+ type NotificationEvents struct

+ func NewNotificationEvents() *NotificationEvents

+ func (e *NotificationEvents) OnPlaying(fn func(n NotificationContainer))

+ func (e *NotificationEvents) OnTranscodeUpdate(fn func(n NotificationContainer))

+ type PMSDevices struct

+ AccessToken string

+ ClientIdentifier string

+ Connection []Connection

+ CreatedAt string

+ Device string

+ HTTPSRequired int

+ LastSeenAt string

+ Name string

+ Owned string

+ Platform string

+ PlatformVersion string

+ Presence string

+ Product string

+ ProductVersion string

+ Provides string

+ PublicAddress string

+ PublicAddressMatches string

+ Relay int

+ Synced string

+ type Part struct

+ AudioProfile string

+ Container string

+ Decision string

+ Duration int

+ File string

+ Has64bitOffsets bool

+ HasThumbnail string

+ ID int

+ Key string

+ OptimizedForStreaming bool

+ Selected bool

+ Size int

+ Stream []Stream

+ VideoProfile string

+ type PartV1 struct

+ Duration int

+ Has64bitOffsets string

+ ID int

+ OptimizedForStreaming string

+ Size int

+ Stream []StreamV1

+ type PinResponse struct

+ AuthToken string

+ ClientIdentifier string

+ Code string

+ CreatedAt string

+ Errors []ErrorResponse

+ ExpiresAt string

+ ExpiresIn json.Number

+ ID int

+ Location struct{ ... }

+ Trusted bool

+ func CheckPIN(id int, clientIdentifier string) (PinResponse, error)

+ func RequestPIN(requestHeaders headers) (PinResponse, error)

+ type PlaySessionStateNotification struct

+ GUID string

+ Key string

+ PlayQueueItemID int64

+ RatingKey string

+ SessionKey string

+ State string

+ TranscodeSession string

+ URL string

+ ViewOffset int64

+ type Player struct

+ Address string

+ Device string

+ Local bool

+ MachineIdentifier string

+ Model string

+ Platform string

+ PlatformVersion string

+ Product string

+ Profile string

+ RemotePublicAddress string

+ State string

+ Title string

+ UserID int

+ Vendor string

+ Version string

+ type Plex struct

+ ClientIdentifier string

+ HTTPClient http.Client

+ Headers headers

+ Token string

+ URL string

+ func New(baseURL, token string) (*Plex, error)

+ func SignIn(username, password string) (*Plex, error)

+ func (*Plex) ExtractKeyFromRatingKey(key string) string

+ func (p *Plex) AddLabelToMedia(mediaType, sectionID, id, label, locked string) (bool, error)

+ func (p *Plex) CheckUsernameOrEmail(usernameOrEmail string) (bool, error)

+ func (p *Plex) CreateLibrary(params CreateLibraryParams) error

+ func (p *Plex) DeleteLibrary(key string) error

+ func (p *Plex) DeletePlexToken(token string) (bool, error)

+ func (p *Plex) ExtractKeyAndThumbFromURL(_url string) (string, string)

+ func (p *Plex) ExtractKeyFromRatingKeyRegex(key string) string

+ func (p *Plex) GetDevices() ([]PMSDevices, error)

+ func (p *Plex) GetEpisode(key string) (SearchResultsEpisode, error)

+ func (p *Plex) GetEpisodes(key string) (SearchResultsEpisode, error)

+ func (p *Plex) GetFriends() ([]Friends, error)

+ func (p *Plex) GetLibraries() (LibrarySections, error)

+ func (p *Plex) GetLibraryContent(sectionKey string, filter string) (SearchResults, error)

+ func (p *Plex) GetLibraryLabels(sectionKey, sectionIndex string) (LibraryLabels, error)

+ func (p *Plex) GetMachineID() (string, error)

+ func (p *Plex) GetMetadata(key string) (MediaMetadata, error)

+ func (p *Plex) GetMetadataChildren(key string) (MetadataChildren, error)

+ func (p *Plex) GetOnDeck() (SearchResultsEpisode, error)

+ func (p *Plex) GetPlaylist(key int) (SearchResultsEpisode, error)

+ func (p *Plex) GetPlexTokens(token string) (DevicesResponse, error)

+ func (p *Plex) GetSections(machineID string) ([]ServerSections, error)

+ func (p *Plex) GetServers() ([]PMSDevices, error)

+ func (p *Plex) GetServersInfo() (ServerInfo, error)

+ func (p *Plex) GetSessions() (CurrentSessions, error)

+ func (p *Plex) GetThumbnail(key, thumbnailID string) (*http.Response, error)

+ func (p *Plex) GetTranscodeSessions() (TranscodeSessionsResponse, error)

+ func (p *Plex) InviteFriend(params InviteFriendParams) error

+ func (p *Plex) KillTranscodeSession(sessionKey string) (bool, error)

+ func (p *Plex) RemoveFriend(id string) (bool, error)

+ func (p *Plex) RemoveFriendAccessToLibrary(userID, machineID, serverID string) (bool, error)

+ func (p *Plex) RemoveLabelFromMedia(mediaType, sectionID, id, label, locked string) (bool, error)

+ func (p *Plex) ScanLibrary(key string) error

+ func (p *Plex) Scrobble(key string) error

+ func (p *Plex) Search(title string) (SearchResults, error)

+ func (p *Plex) SearchPlex(title string) (SearchResults, error)

+ func (p *Plex) StopPlayback(machineID string) error

+ func (p *Plex) SubscribeToNotifications(events *NotificationEvents, interrupt <-chan os.Signal, fn func(error))

+ func (p *Plex) TerminateSession(sessionID string, reason string) error

+ func (p *Plex) Test() (bool, error)

+ func (p *Plex) Unscrobble(key string) error

+ func (p *Plex) UpdateFriendAccess(userID string, params UpdateFriendParams) (bool, error)

+ func (p Plex) AddWebhook(webhook string) error

+ func (p Plex) GetWebhooks() ([]string, error)

+ func (p Plex) LinkAccount(code string) error

+ func (p Plex) MyAccount() (UserPlexTV, error)

+ func (p Plex) SetWebhooks(webhooks []string) error

+ type Provider struct

+ Key string

+ Title string

+ Type string

+ type ReachabilityNotification struct

+ Reachability bool

+ type Role struct

+ Role string

+ Thumb string

+ type SearchMediaContainer struct

+ Provider []Provider

+ type SearchResults struct

+ MediaContainer SearchMediaContainer

+ type SearchResultsEpisode struct

+ MediaContainer MediaContainer

+ type SectionIDResponse struct

+ FriendlyName string

+ Identifier string

+ MachineIdentifier string

+ Server []struct{ ... }

+ Size int

+ XMLName xml.Name

+ type ServerInfo struct

+ FriendlyName string

+ Identifier string

+ MachineIdentifier string

+ Server []struct{ ... }

+ Size int

+ XMLName xml.Name

+ type ServerSections struct

+ ID int

+ Key string

+ Title string

+ Type string

+ type Session struct

+ Bandwidth int

+ ID string

+ Location string

+ type Setting struct

+ Advanced bool

+ Default string

+ Group string

+ Hidden bool

+ ID string

+ Label string

+ Summary string

+ Type string

+ Value int64

+ type SignInResponse struct

+ User UserPlexTV

+ type StatusNotification struct

+ Description string

+ NotificationName string

+ Title string

+ type Stream struct

+ AlbumGain string

+ AlbumPeak string

+ AlbumRange string

+ Anamorphic bool

+ AudioChannelLayout string

+ BitDepth int

+ Bitrate int

+ BitrateMode string

+ Cabac string

+ Channels int

+ ChromaLocation string

+ ChromaSubsampling string

+ Codec string

+ CodecID string

+ ColorRange string

+ ColorSpace string

+ Default bool

+ DisplayTitle string

+ Duration string

+ FrameRate float64

+ FrameRateMode string

+ Gain string

+ HasScalingMatrix bool

+ Height int

+ ID int

+ Index int

+ Language string

+ LanguageCode string

+ Level int

+ Location string

+ Loudness string

+ Lra string

+ Peak string

+ PixelAspectRatio string

+ PixelFormat string

+ Profile string

+ RefFrames int

+ SamplingRate int

+ ScanType string

+ Selected bool

+ StreamIdentifier string

+ StreamType int

+ Width int

+ type StreamV1 struct

+ BitDepth int

+ Bitrate int

+ Channels int

+ Default string

+ FrameRate float64

+ HasScalingMatrix string

+ Height int

+ ID int

+ Index int

+ Level int

+ RefFrames int

+ SamplingRate int

+ Selected string

+ StreamType int

+ Width int

+ type TaggedData struct

+ Filter string

+ ID json.Number

+ Tag string

+ type TimelineEntry struct

+ Identifier string

+ ItemID int64

+ MetadataState string

+ SectionID int64

+ State int64

+ Title string

+ Type int64

+ UpdatedAt int64

+ type TranscodeSession struct

+ AudioChannels int64

+ AudioCodec string

+ AudioDecision string

+ Complete bool

+ Container string

+ Context string

+ Duration int64

+ Key string

+ Progress float64

+ Protocol string

+ Remaining int64

+ SourceAudioCodec string

+ SourceVideoCodec string

+ Speed float64

+ Throttled bool

+ TranscodeHwRequested bool

+ VideoCodec string

+ VideoDecision string

+ type TranscodeSessionsResponse struct

+ Children []struct{ ... }

+ ElementType string

+ type UpdateFriendParams struct

+ AllowCameraUpload string

+ AllowChannels string

+ AllowSync string

+ FilterMovies string

+ FilterMusic string

+ FilterPhotos string

+ FilterTelevision string

+ type User struct

+ AuthToken string

+ AuthenticationToken string

+ ConfirmedAt string

+ Email string

+ Entitlements []string

+ ForumID string

+ HasPassword bool

+ ID string

+ JoinedAt string

+ RememberMe bool

+ Roles struct{ ... }

+ Subscription struct{ ... }

+ Thumb string

+ Title string

+ UUID string

+ Username string

+ type UserPlexTV struct

+ AuthToken string

+ AuthenticationToken string

+ ConfirmedAt string

+ Email string

+ Entitlements []string

+ ForumID json.Number

+ HasPassword bool

+ ID int

+ JoinedAt string

+ RememberMe bool

+ Roles struct{ ... }

+ Subscription struct{ ... }

+ Thumb string

+ Title string

+ UUID string

+ Username string

+ type Webhook struct

+ Account struct{ ... }

+ Event string

+ Metadata struct{ ... }

+ Owner bool

+ Player struct{ ... }

+ Server struct{ ... }

+ User bool

+ type WebhookEvents struct

+ func NewWebhook() *WebhookEvents

+ func (wh *WebhookEvents) Handler(w http.ResponseWriter, r *http.Request)

+ func (wh *WebhookEvents) OnPause(fn func(w Webhook)) error

+ func (wh *WebhookEvents) OnPlay(fn func(w Webhook)) error

+ func (wh *WebhookEvents) OnRate(fn func(w Webhook)) error

+ func (wh *WebhookEvents) OnResume(fn func(w Webhook)) error

+ func (wh *WebhookEvents) OnScrobble(fn func(w Webhook)) error

+ func (wh *WebhookEvents) OnStop(fn func(w Webhook)) error

+ type WebsocketNotification struct

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL