francis94c/vimeo-livestream

用于Vimeo直播流的PHP客户端库

dev-master 2020-09-23 10:36 UTC

This package is auto-updated.

Last update: 2024-09-23 19:30:52 UTC


README

build Coverage Status Maintainability Scrutinizer Code Quality

vimeo-livestream

用于Vimeo直播流的PHP客户端库。

当前功能包括

  • 创建新事件。
  • 更新事件。
  • 获取相关账户。
  • 获取特定账户。
  • 更新事件海报。
  • 删除事件。

安装

此直播流API作为 francis94c/vimeo-livestream 在 Packagist 上可用

$ composer require francis94c/vimeo-livestream:dev-master

用法

创建LiveStream实例。

use LiveStream\LiveStream;

$livestream = new LiveStream('[YOUR_API_KEY]');

在继续之前,请注意,返回null的$livestream函数调用表示请求的资源未找到。总之,调用结果收到了404 HTTP响应码。

除了200和201之外的所有HTTP响应码都会抛出异常。

获取账户

获取与当前API密钥链接的所有LiveStream账户。

$accounts = $livestream->getAccounts(); // Returns an array of account resources.

获取特定账户

获取特定的LiveStream账户。

$account = $livestream->getAccount(23456 /*Account ID*/); // Returns \LiveStream\Resources\Account.

创建事件

use LiveStream\Resources\Event;

$event = new Event("A Career Master Class" /*fullName*/);
// See https://livestream.com/developers/docs/api/#event-object
$event->setShortName("Master Class"); /*Or*/ $event->shortName = 'Master Class';
$event->setStartTime("2020-07-20 23:56:20"); /*Or*/ $event->startTime = /*Time in ISO8601 date time format*/

更新事件

use LiveStream\Resources\Event;

$event = new Event("Physics Live Class on Motions.");

$event->setDescription("Motion")
    ->setStartTime(date('Y-m-d H:i:s'))
    ->setEndTime(date('Y-m-d H:i:s'))
    ->setShortName("Physics Short Name")
    ->setIsDraft(false)
    ->addTag('a')
    ->addTag('a')
    ->setId(3456343);

$livestream = new LiveStream('abc');

$livestream->updateEvent(5637245, $event);

获取RTMP密钥

$key = $livestream->getRtmpKey(3456 /*Account ID*/, 4567, /*Event ID*/); // Returns \LiveStream\Resources\RTMPKey.
echo $key->id . ' --- ' . $key->rtmpUrl;
// OR
echo $key->getId() . ' --- ' . $key->getRtmpUrl();

重置RTMP密钥

$key = $livestream->resetRtmpKey(3456 /*Account ID*/, 4567, /*Event ID*/);