plextv

Nov 4, 2026

Changes in this version

+ var ErrCertManagerClosed = errors.New("plextv: certificate manager closed")

type CertManager

+ func (m *CertManager) Close()

Nov 1, 2026

Changes in this version

+ const CertReasonChain

+ const CertReasonDates

+ const CertReasonHandshake

+ const CertReasonIdentity

+ var ErrClaimExchangeFailed = errors.New("plextv: claim exchange failed")

+ func EtherSubtitleMode(mode int) string

type Account

+ Track TrackDefaults

type CertInfo

+ Verified bool

+ VerifyReason string

type CertManager

+ func (m *CertManager) VerifyTrust(ctx context.Context, identityHash, dialAddr string) (bool, string)

type CertManagerOptions

+ TrustRoots *x509.CertPool

+ type ClaimExchangeError struct

+ Err error

+ func (e *ClaimExchangeError) Error() string

+ func (e *ClaimExchangeError) Is(target error) bool

+ func (e *ClaimExchangeError) Unwrap() error

type Friend

+ Share ShareDefaults

+ Track TrackDefaults

type Registrar

+ func (r *Registrar) SyncFriendsOnUnknownToken(ctx context.Context) error

type RegistrarOptions

+ UnknownTokenSyncMinSpacing time.Duration

+ type ShareDefaults struct

+ AllowSync *bool

+ FilterMovies string

+ FilterTelevision string

+ HasSettings bool

+ type TrackDefaults struct

+ AudioLanguage string

+ AutoSelectAudio bool

+ ForcedOnly bool

+ HasProfile bool

+ SubtitleLanguage string

+ SubtitleMode int

+ func (d TrackDefaults) EtherMode() string

Oct 29, 2026

Changes in this version

type CertInfo

+ ReissueRequired bool

type CertManager

+ func (m *CertManager) RequireReissue(ctx context.Context) error

Oct 28, 2026

Changes in this version

type Client

+ func (c *Client) Features(ctx context.Context, token string) ([]Feature, error)

+ type Feature struct

+ ID string

+ UUID string

Oct 28, 2026

Changes in this version

type Client

+ func (c *Client) RemoveDevice(ctx context.Context, token string) (bool, error)

type Status

+ TokenRejected bool

Oct 28, 2026

Changes in this version

type RegistrarOptions

+ OwnerInterval time.Duration

Oct 28, 2026

Changes in this version

type Status

+ OwnerFeatures []string

Oct 27, 2026

Changes in this version

+ type LibrarySection struct

+ Key int

+ Language string

+ Title string

+ Type string

+ UUID string

type Registrar

+ func (r *Registrar) SetLibrarySections(sections []LibrarySection)

type ServerRegistration

+ Libraries []LibrarySection

Oct 20, 2026

Changes in this version

+ const AppProduct

+ const CertTopic

+ const ClaimExchange

+ const ClaimOwnerToken

+ const DefaultAuthAppURL

+ const DefaultBaseURL

+ const DefaultCertSyncInterval

+ const DefaultServerVersion

+ const DefaultServersURL

+ const PubsubTLSName

+ const ServerProduct

+ const SharedCertName

+ var ErrCertUnavailable = errors.New("plextv: plex.direct certificate not available for this server")

+ var ErrPINExpired = errors.New("plextv: sign-in PIN expired")

+ var ErrRateLimited = errors.New("plex.tv rate limit exceeded")

+ var ErrRenewalDeferred = errors.New("plextv: certificate renewal is handled by the cluster leader")

+ func Fingerprint(c *x509.Certificate) string

+ func LatestPublicVersion(ctx context.Context, hc *http.Client, endpoint string) (string, error)

+ func NewerPMSVersion(a, b string) bool

+ func PMSVersion(c config.Config) string

+ func ValidPMSVersion(v string) bool

+ type APIError struct

+ Code int

+ Message string

+ Method string

+ Path string

+ RetryAfter time.Duration

+ Status int

+ func (e *APIError) Error() string

+ func (e *APIError) Is(target error) bool

+ type Account struct

+ AuthToken string

+ Email string

+ FriendlyName string

+ Home bool

+ HomeAdmin bool

+ ID int64

+ Restricted bool

+ Subscription Subscription

+ Thumb string

+ Title string

+ UUID string

+ Username string

+ func (a *Account) DisplayName() string

+ type CertBundle struct

+ CertPEM []byte

+ Hash string

+ KeyPEM []byte

+ Leaf *x509.Certificate

+ Subject string

+ func GenerateSelfSigned(hosts []string, hash string, validity time.Duration) (*CertBundle, error)

+ type CertInfo struct

+ CertFile string

+ Custom bool

+ DNSNames []string

+ Fingerprint string

+ Hash string

+ KeyFile string

+ LastAttempt time.Time

+ LastError string

+ NextAttempt time.Time

+ NotAfter time.Time

+ NotBefore time.Time

+ Present bool

+ RetryAfter time.Duration

+ SelfSigned bool

+ Subject string

+ type CertManager struct

+ func NewCertManager(o CertManagerOptions) (*CertManager, error)

+ func (m *CertManager) Ensure(ctx context.Context, serverToken string, hosts []string, force bool) (CertInfo, error)

+ func (m *CertManager) GetCertificate(*tls.ClientHelloInfo) (*tls.Certificate, error)

+ func (m *CertManager) Info() CertInfo

+ func (m *CertManager) Install(b *CertBundle) error

+ func (m *CertManager) NeedsRenewal() bool

+ func (m *CertManager) RunSharedSync(ctx context.Context, every time.Duration)

+ func (m *CertManager) SetEventBus(bus EventBus)

+ func (m *CertManager) SetRenewalAllowed(fn func() bool)

+ func (m *CertManager) SyncShared(ctx context.Context) (bool, error)

+ func (m *CertManager) TLSConfig() *tls.Config

+ type CertManagerOptions struct

+ Client *Client

+ ClientErrorRetryAfter time.Duration

+ CustomCertFile string

+ CustomKeyFile string

+ Dir string

+ Logger *slog.Logger

+ Now func() time.Time

+ RenewBefore time.Duration

+ Request CertRequest

+ RetryAfter time.Duration

+ SelfSignedValidity time.Duration

+ Shared SharedCertStore

+ type CertRequest struct

+ InvalidIn int

+ Key crypto.Signer

+ PollInterval time.Duration

+ Reason string

+ Timeout time.Duration

+ type ClaimResult struct

+ Method string

+ Owner Account

+ ServerToken string

+ type Client struct

+ func New(o Options) (*Client, error)

+ func (c *Client) AccessTokens(ctx context.Context, serverToken string) ([]Friend, error)

+ func (c *Client) AuthURL(pin *PIN, forwardURL string) string

+ func (c *Client) BaseURL() string

+ func (c *Client) CertificateSubject(ctx context.Context, serverToken string) (cn, hash string, err error)

+ func (c *Client) CheckPIN(ctx context.Context, id int64, code string) (*PIN, error)

+ func (c *Client) Claim(ctx context.Context, userToken string) (*ClaimResult, error)

+ func (c *Client) ClaimToken(ctx context.Context, userToken string) (string, error)

+ func (c *Client) CreatePIN(ctx context.Context) (*PIN, error)

+ func (c *Client) ExchangeClaim(ctx context.Context, claimToken string) (string, error)

+ func (c *Client) FindServer(ctx context.Context, token, machineID string) (*Resource, error)

+ func (c *Client) Friends(ctx context.Context, serverToken string) ([]Friend, error)

+ func (c *Client) HomeUserToken(ctx context.Context, ownerToken string, id int64, pin string) (string, error)

+ func (c *Client) Identity() Identity

+ func (c *Client) PublishConnections(ctx context.Context, serverToken string, uris []string) error

+ func (c *Client) PublishConnectionsWith(ctx context.Context, serverToken string, uris []string, flags *PublishFlags) error

+ func (c *Client) PubsubServers(ctx context.Context, serverToken string) ([]string, error)

+ func (c *Client) RegisterServer(ctx context.Context, serverToken string, reg ServerRegistration) error

+ func (c *Client) ReportConnectivity(ctx context.Context, serverToken string) (string, error)

+ func (c *Client) RequestPlexDirectCertificate(ctx context.Context, serverToken string, req CertRequest) (*CertBundle, error)

+ func (c *Client) Resources(ctx context.Context, token string) ([]Resource, error)

+ func (c *Client) ShareWith(ctx context.Context, token, email string, sections []int) error

+ func (c *Client) SharedServers(ctx context.Context, ownerToken string) ([]Friend, error)

+ func (c *Client) User(ctx context.Context, token string) (*Account, error)

+ func (c *Client) UserServices(ctx context.Context, serverToken string) ([]Service, error)

+ func (c *Client) UserSubscriptions(ctx context.Context, serverToken string) ([]SharedUser, error)

+ func (c *Client) Users(ctx context.Context, ownerToken string) ([]SharedUser, error)

+ func (c *Client) WaitPIN(ctx context.Context, pin *PIN, interval time.Duration) (string, error)

+ func (c *Client) WithIdentity(id Identity) *Client

+ type ConfigStore interface

+ Get func() config.Config

+ Update func(fn func(*config.Config) error) error

+ type EventBus interface

+ Publish func(ctx context.Context, topic string, payload []byte) error

+ Subscribe func(topic string, fn func([]byte)) (unsubscribe func())

+ type Friend struct

+ AllLibs bool

+ Email string

+ Home bool

+ Owned bool

+ Pending bool

+ PlexID int64

+ Restricted bool

+ Sections []string

+ Thumb string

+ Title string

+ Token string

+ UUID string

+ Username string

+ func (f Friend) DisplayName() string

+ type Identity struct

+ ClientIdentifier string

+ Device string

+ DeviceName string

+ Platform string

+ PlatformVersion string

+ Product string

+ Provides string

+ Version string

+ func AppIdentity(cfg config.Config, version string) Identity

+ func ServerIdentity(cfg config.Config, version string) Identity

+ type Options struct

+ AuthAppURL string

+ BaseURL string

+ HTTPClient *http.Client

+ Identity Identity

+ Logger *slog.Logger

+ RetryBackoff time.Duration

+ VersionSource func() string

+ type PIN struct

+ AuthToken string

+ ClientIdentifier string

+ Code string

+ ExpiresAt time.Time

+ ExpiresIn int

+ ID int64

+ Trusted bool

+ type PortMapper interface

+ Close func(ctx context.Context)

+ Ensure func(ctx context.Context, internal, external int) (remote.MappingStatus, error)

+ Status func() remote.MappingStatus

+ type Presence struct

+ func NewPresence(o PresenceOptions) *Presence

+ func (p *Presence) Run(ctx context.Context)

+ func (p *Presence) Status() PresenceStatus

+ type PresenceOptions struct

+ Client *Client

+ Credentials func() (ownerID int64, machineID, token string, ok bool)

+ IdleTimeout time.Duration

+ MaxBackoff time.Duration

+ MinBackoff time.Duration

+ OnMessage func(PubsubMessage)

+ StreamClient *http.Client

+ StreamURL func(host string, ownerID int64, machineID, token string) string

+ type PresenceStatus struct

+ Connected bool

+ Host string

+ LastError string

+ LastMessage string

+ Since time.Time

+ type PublishFlags struct

+ DNSRebindingProtection bool

+ HTTPSEnabled bool

+ HTTPSRequired bool

+ NATLoopbackSupported bool

+ type PubsubMessage struct

+ Address string

+ AsyncIdentifier string

+ Command string

+ Connectivity string

+ Port string

+ Raw string

+ func (m PubsubMessage) Reachable() bool

+ type Registrar struct

+ func NewRegistrar(o RegistrarOptions) (*Registrar, error)

+ func (r *Registrar) CheckReachability(ctx context.Context) remote.Reachability

+ func (r *Registrar) Claim(ctx context.Context, userToken string) (*ClaimResult, error)

+ func (r *Registrar) Client() *Client

+ func (r *Registrar) NodeURIs(ctx context.Context) []string

+ func (r *Registrar) PublishNow(ctx context.Context) error

+ func (r *Registrar) RefreshOwner(ctx context.Context) error

+ func (r *Registrar) RenewCertificate(ctx context.Context, force bool) error

+ func (r *Registrar) RequestPublish()

+ func (r *Registrar) RunPortMapping(ctx context.Context)

+ func (r *Registrar) SignInClient() *Client

+ func (r *Registrar) Start(ctx context.Context) error

+ func (r *Registrar) Status() Status

+ func (r *Registrar) Stop()

+ func (r *Registrar) SyncFriendsNow(ctx context.Context) error

+ func (r *Registrar) Trigger()

+ func (r *Registrar) Unclaim(ctx context.Context) error

+ type RegistrarOptions struct

+ AddressInterval time.Duration

+ BaseURL string

+ CertInterval time.Duration

+ Certs *CertManager

+ Client *Client

+ Config ConfigStore

+ FriendSyncInterval time.Duration

+ LAN func() ([]net.IP, error)

+ Logger *slog.Logger

+ Mapper PortMapper

+ MappingInterval time.Duration

+ NodeMapping bool

+ Now func() time.Time

+ PeerURIs func() []string

+ PublishInterval time.Duration

+ PublishPlexDirect bool

+ Reach *remote.ReachabilityChecker

+ ReachabilityInterval time.Duration

+ Tick time.Duration

+ Users UserSync

+ Version string

+ WAN WANDetector

+ type Resource struct

+ AccessToken string

+ ClientIdentifier string

+ Connections []ResourceConnection

+ CreatedAt flexTime

+ DNSRebindingProtection bool

+ Device string

+ HTTPSRequired bool

+ Home bool

+ LastSeenAt flexTime

+ Name string

+ NatLoopbackSupported bool

+ Owned bool

+ OwnerID *int64

+ Platform string

+ PlatformVersion string

+ Presence bool

+ Product string

+ ProductVersion string

+ Provides string

+ PublicAddress string

+ PublicAddressMatches bool

+ Relay bool

+ SourceTitle string

+ Synced bool

+ func (r *Resource) UnmarshalJSON(b []byte) error

+ func (r Resource) LastSeen() time.Time

+ func (r Resource) ProvidesServer() bool

+ type ResourceConnection struct

+ Address string

+ IPv6 bool

+ Local bool

+ Port int

+ Protocol string

+ Relay bool

+ URI string

+ func (c *ResourceConnection) UnmarshalJSON(b []byte) error

+ type ServerRegistration struct

+ Address string

+ LocalAddresses []string

+ MappingState string

+ Name string

+ Now time.Time

+ Port int

+ PrivateAddress string

+ PrivatePort int

+ Version string

+ type Service struct

+ Endpoint string

+ Identifier string

+ PlexID int64

+ Status string

+ type SharedCertStore interface

+ Get func(ctx context.Context, name string) ([]byte, int64, error)

+ Put func(ctx context.Context, name string, data []byte) (int64, error)

+ Version func(ctx context.Context, name string) (int64, error)

+ type SharedUser struct

+ Email string

+ Home bool

+ PlexID int64

+ PlexPass bool

+ PlexPassKnown bool

+ Restricted bool

+ Servers []string

+ Thumb string

+ Title string

+ UUID string

+ Username string

+ type Status struct

+ Cert CertInfo

+ CertError string

+ Claimed bool

+ Connections []remote.Connection

+ FriendSyncError string

+ Friends int

+ LANAddresses []string

+ LastFriendSync time.Time

+ LastPublish time.Time

+ LastPublishError string

+ Listed bool

+ MachineIdentifier string

+ OwnerUsername string

+ PlexPass bool

+ PlexReachable *bool

+ Presence PresenceStatus

+ PublicAddress string

+ PublicIP string

+ PublicIPErr string

+ PublishedURIs []string

+ Reachability *remote.Reachability

+ RegisterError string

+ RemoteAccess bool

+ ResourceConnections []ResourceConnection

+ UPnP remote.MappingStatus

+ type Subscription struct

+ Active bool

+ Features []string

+ Plan string

+ Status string

+ type UserSync interface

+ SetOwner func(ctx context.Context, owner Account, serverToken string) error

+ SyncFriends func(ctx context.Context, friends []Friend) error

+ type WANDetector interface

+ Detect func(ctx context.Context) (net.IP, error)