chindit / plex-api
一个简单的 API 库,用于与 Plex 服务器交互
2.0.1
2024-01-21 12:21 UTC
Requires
- php: ^8.2
- ext-simplexml: *
- chindit/collection: ^1.0
- symfony/http-client: ^7.0
Requires (Dev)
- phpstan/phpstan: ^1.10
- phpunit/phpunit: ^10.5
This package is auto-updated.
Last update: 2024-09-21 14:04:33 UTC
README
安装
composer require chindit/plex-api
使用
创建一个新的 PlexServer 实例
必须传递的最小参数是服务器主机和令牌。
$plex = new Chindit\PlexServer('http://path.to.my.plex', 'MyPlexToken');
您还可以提供第三个参数作为特定端口(默认为 32400),以及一些选项作为第四个参数。选项必须由 Symfony 的 HTTP 客户端支持。
最常见的参数是 max_redirects 和 timeout。
在这种情况下,服务器初始化将如下所示
$plex = new Chindit\PlexServer('http://path.to.my.plex', 'MyPlexToken', 32400, ['timeout' => 10]);
要查找您的 Plex 令牌,请查看此文章
可用方法
一旦创建了您的 $plexserver 实例,以下方法将可用
-
checkConnection(): bool检查是否可以连接到您的 Plex 实例。 -
servers(): array返回您的 Plex 实例的活动服务器列表。响应是
Chindit\Model\Server对象的数组 -
sessionsCount(): int返回服务器上的活动会话数。一个活动会话是一个正在流式传输媒体的设备。 -
libraries(): array返回所有您的库。Plex 库是一个类似于您“电影”或“电视剧”类别的通用部分。所有您的媒体都包含在库中。 -
library(int $libraryId): array返回特定库中的所有媒体。库 ID 可以通过在Library对象上调用getId()获取。示例
$myLibraries = $plexServer->libraries(); $theLibraryIWant = $myLibraries[0]; // Choose any libray you want; $myMedias = $plexServer->library($theLibraryIWant->getId());
响应是
Chindit\Model\Movie和Chindit\Model\Show对象的数组。
需要帮助?
如果您需要特定的调用,有建议或发现了一个错误,请不要犹豫在 问题 标签下留下评论。