plexguid

package

v0.3.2 Latest Latest Go to latest Published: Nov 3, 2026 License: GPL-3.0 Imports: 19 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/braedonsaunders/ether

Links

Open Source Insights

Documentation ¶

Overview ¶

Package plexguid maps verified external identities through Plex's metadata provider. It never invents plex:// IDs or grants Plex account entitlements.

Index ¶

Variables
func ClientIdentifier(plexClientID, machineID string) string
type Options
type Service
- func New(db *sql.DB, o Options) *Service

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrAmbiguous = errors.New("plexguid: ambiguous identity")

ErrAmbiguous is returned when one Plex GUID is stored for more than one local title, or the stored title's kind does not match the GUID kind.

Functions ¶

func ClientIdentifier ¶ added in v0.3.0

func ClientIdentifier(plexClientID, machineID string) string

ClientIdentifier is the X-Plex-Client-Identifier sent to Plex's metadata and discover providers: the install's Plex client id (minted on first run), else the server's machine identifier, else a fresh random id, so installs never share one fixed identifier.

Types ¶

type Options ¶

type Options struct {
	HTTP *http.Client
	// ClientIdentifier is the per-install X-Plex-Client-Identifier.
	ClientIdentifier func() string
	BaseURL          string
	Token            func() string
	Background       bool
}

type Service ¶

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

func New ¶

func New(db *sql.DB, o Options) *Service

func (*Service) Cached ¶

func (s *Service) Cached(ctx context.Context, k core.RatingKey) string

Cached is safe for lists: no network requests or credentials are needed.

func (*Service) CachedMany ¶

func (s *Service) CachedMany(ctx context.Context, keys []core.RatingKey) map[core.RatingKey]string

CachedMany batch-loads cached non-empty plex:// GUIDs for keys without network activity.

func (*Service) ClientIdentifier ¶ added in v0.3.0

func (s *Service) ClientIdentifier() string

ClientIdentifier returns the per-install X-Plex-Client-Identifier used by s.

func (*Service) Close ¶

func (s *Service) Close()

func (*Service) ExactKey ¶ added in v0.2.57

func (s *Service) ExactKey(ctx context.Context, guid string) (core.RatingKey, error)

ExactKey returns the single local title already stored for guid. It does not call Plex and it does not derive an episode from a show's TMDB id. A miss is core.ErrNotFound.

func (*Service) Lookup ¶ added in v0.2.45

func (s *Service) Lookup(ctx context.Context, guid string) (core.RatingKey, error)

Lookup reverses a verified Plex movie/show identity. It returns an identity, not a visibility decision: callers must load and authorize the title. A cold lookup accepts only an exact provider GUID with one TMDB identity.

func (*Service) Resolve ¶

func (s *Service) Resolve(ctx context.Context, k core.RatingKey) (string, error)

func (*Service) Schedule ¶

func (s *Service) Schedule(keys ...core.RatingKey)

Schedule queues keys for asynchronous plex:// GUID resolution when Background is enabled. Safe to call on hot render paths.

func (*Service) Wait ¶

func (s *Service) Wait()

Wait blocks until all queued background GUID resolutions finish.

Source Files ¶

View all Source files

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