README

eyeson.team PHP 库 - 按需创建强大的视频会议，并轻松将 eyeson 集成到您的 PHP 应用程序中。

此库提供了 eyeson.team 的基本功能。查看 API 文档 获取完整概述，如果您发现错误或有功能请求，请创建一个 问题。如果您有任何一般性问题，请随意在文档仓库中添加 问题。

用法

提供您的 API 密钥，并使用 join 方法快速加入任何房间。您可以选择作为第三个参数提供 配置选项。

$eyeson = new Eyeson('<your-eyeson-api-key>');
// Join a new eyeson video meeting by providing a user's name.
$room = $eyeson->join('Mike', 'standup meeting');
$room->getUrl(); // https://app.eyeson.team?<token> URL to eyeson.team video GUI
// If you do not provide a room name, eyeson will create one for you. Note that
// users **will join different rooms on every request**.
$room = $eyeson->join('mike@eyeson.team');
// You can add additional details to your user, which will be shown in the
// GUI. Choosing a unique identifier will keep the user distinct and ensures
// actions are mapped correctly to this record. E.g. joining the room twice will
// not lead to two different participants in a meeting.
$user = [
  'id' => 'mike@eyeson.team',
  'name' => 'Mike',
  'avatar' => 'https://mikes.website/avatar.png'
];
$room = $eyeson->join($user, 'daily standup');

您可以使用加入的房间来控制会议，操作将由加入的用户触发，按需使用控制用户。

// Force stop a running meeting.
$eyeson->shutdown($room);
// Start and stop a recording.
$recording = $eyeson->record($room);
$recording->isActive(); // true
$recording->stop();

在您的应用程序中注册钩子以接收更新，如新会议或录制。

// Register a webhook
$eyeson->addWebhook('https://my.application/hooks/recordings',
                    'recording_update');

您可以从自动布局处理切换到自定义布局，并为视频讲台设置最多四个用户位置。注意：使用空字符串表示空位置。此外，您还可以隐藏/显示视频中的名称插入。

$layout = $eyeson->getLayout($room);
$layout->update($userList); // ["5eb3a...994", "5eb3a...d06"]
$layout->useAuto();
$layout->showNames();
$layout->hideNames();

使用 Composer 安装库

# required php version >= 5.4
$ composer require eyeson/eyeson-php

开发

您可以使用 docker 运行测试套件，有关详细信息，请参阅 Makefile。

$ make build
$ make test