server

package
v1.0.0-rc.21 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 10, 2026 License: MIT Imports: 12 Imported by: 0

Documentation

Overview

Package server 是媒体服务器的客户端:Emby、Jellyfin 与 Plex。整理入库后通知媒体服务器扫描新目录 (按路径或刷新整个媒体库),也能测试连通性、按 TMDB 或 IMDb 编号查一个条目是不是已经入库。

Index

Constants

This section is empty.

Variables

View Source
var (
	// ErrUnauthorized 表示 API Key 或 Token 不对,或者没有管理员权限。
	ErrUnauthorized = errors.New("媒体服务器拒绝了请求:API Key 或 Token 不对,或者没有管理员权限")
	// ErrUnavailable 表示连不上媒体服务器,或它回了其它错误。
	ErrUnavailable = errors.New("连不上媒体服务器")
	// ErrRedirect 表示媒体服务器回了跳转:不跟着跳(会把 Token 发到别的地址)。
	ErrRedirect = errors.New("媒体服务器回了跳转(3xx):地址要填完整的最终地址,例如 https:// 与端口")
	// ErrNoLibrary 表示 Plex 里没有包含这个路径的媒体库。
	ErrNoLibrary = errors.New("Plex 里没有包含这个路径的媒体库:检查媒体服务器的路径映射")
	// ErrBadConfig 表示配置不对(错误信息写明哪一项)。
	ErrBadConfig = errors.New("媒体服务器配置无效")
)

Functions

func CheckURL

func CheckURL(raw string) (string, error)

CheckURL 检查媒体服务器地址:http 或 https,有主机,不带查询参数与片段;返回去掉末尾 / 的地址。

func NewHTTPClient

func NewHTTPClient() *http.Client

NewHTTPClient 是访问媒体服务器用的 http.Client:15 秒超时,不跟跳转。媒体服务器一般在局域网里,不走代理。

Types

type Client

type Client interface {
	// Test 用 API Key 或 Token 访问一次,返回服务器名称与版本。
	Test(ctx context.Context) (Info, error)
	// RefreshPaths 通知媒体服务器这些目录(媒体服务器里看到的路径)有新内容。
	RefreshPaths(ctx context.Context, paths []string) error
	// RefreshAll 刷新整个媒体库。
	RefreshAll(ctx context.Context) error
	// Exists 报告条目是不是已经入库。
	Exists(ctx context.Context, q Query) (bool, error)
}

Client 是一个媒体服务器。

func New

func New(cfg Config) (Client, error)

New 按种类建客户端。

type Config

type Config struct {
	Kind  string
	URL   string
	Token string
	// HTTPClient 为空时用默认的(15 秒超时、不跟跳转)
	HTTPClient *http.Client
}

Config 是建客户端用的配置。

type Info

type Info struct {
	Name      string `json:"name"`
	Version   string `json:"version"`
	Libraries int    `json:"libraries,omitempty"`
}

Info 是测试连通性时读到的服务器信息。

type Query

type Query struct {
	Kind   string // movie 或 tv
	TMDBID int
	IMDbID string
	Title  string
}

Query 是「是不是已经入库」的查询:按名字找,再比对 TMDB 或 IMDb 编号。

Jump to

Keyboard shortcuts

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