README

api.video PHP 客户端

api.video 是产品构建者的视频基础设施。提供快速的视频 API，以集成、扩展和管理应用中的按需和低延迟直播功能。

项目描述

api.video 的 PHP API 客户端简化了编码过程。文件分块、分页和令牌刷新都由您处理。

入门

安装

composer require api-video/php-api-client

初始化

由于 PHP PSR 支持，您必须使用 3 到 5 个参数初始化客户端

基础 URI，可以是 https://sandbox.api.video 或 https://ws.api.video
您的 API 密钥，可在您的帐户中找到
HTTP 客户端
(请求工厂)
(流工厂)

注意：如果 HTTP 客户端还实现了 RequestFactoryInterface 和 StreamFactoryInterface，则不需要通过第 4 和第 5 个参数传递此对象。

Symfony HTTP 客户端示例

Symfony HTTP 客户端具有三项优势，即充当 HTTP 客户端，同时也是 请求工厂 和 流工厂。因此，只需将其作为参数传递三次即可。

如果 HTTP 客户端尚未在您的项目中，您可以使用以下方法添加它

composer require symfony/http-client
composer require nyholm/psr7

代码示例

客户端初始化

<?php
require __DIR__ . '/vendor/autoload.php';

$httpClient = new \Symfony\Component\HttpClient\Psr18Client();
$client = new \ApiVideo\Client\Client(
    'https://sandbox.api.video',
    'YOUR_API_KEY',
    $httpClient
);
?>

创建视频

$payload = (new VideoCreationPayload())
    ->setTitle('Test video creation');

// the `$client` must already be initialized.
$video = $client->videos()->create($payload);

上传视频

$payload = (new VideoCreationPayload())
    ->setTitle('Test video creation');

$video = $client->videos()->create($payload);

// the `$client` must already be initialized.
$client->videos()->upload(
    $video->getVideoId(),
    new SplFileObject(__DIR__.'/../earth.mp4')
);

文档

API 端点

AnalyticsApi

CaptionsApi

ChaptersApi

LiveStreamsApi

PlayerThemesApi

UploadTokensApi

VideosApi

WatermarksApi

WebhooksApi

模型

身份验证

某些端点不需要身份验证。这些可以通过使用带有null API密钥的客户端调用

<?php
require __DIR__ . '/vendor/autoload.php';

$httpClient = new \Symfony\Component\HttpClient\Psr18Client();
$client = new \ApiVideo\Client\Client(
    'https://sandbox.api.video',
    null,
    $httpClient
);
?>

块

视频自动分割为50 Mb的块。

要修改块的大小，请如下填写最后一个参数$contentRange

bytes 0-{size}/0 其中 {size} 是块的大小。

例如：bytes 0-500000/0 表示500 Kb的块。

块的大小值必须在5 Mb到128mb之间。

测试

要运行PhpUnit测试，必须在命令行中输入两个变量

BASE_URI（例如：https://sandbox.api.video）
API_KEY

这些标识符必须属于真实的api.video账户。

$ BASE_URI="" API_KEY="..." vendor/bin/phpunit

您是否从这个 API 客户端中获得了帮助？

请花点时间在客户端上留下一个星号⭐

这有助于其他用户找到客户端，也帮助我们了解哪些客户端最受欢迎。谢谢！

贡献

由于此API客户端是从OpenAPI描述生成的，我们无法接受直接提交到仓库的pull请求。如果您想贡献，可以在我们的客户端生成器仓库上打开pull请求。否则，您也可以简单地在这个仓库上打开一个问题，详细说明您的需求。

api-video / php-api-client

维护者

详细信息