mmsccons/opentok-laravel

此包已被废弃且不再维护。作者建议使用 cumulati/opentok-laravel 包。

OpenTok PHP SDK 的 Laravel 扩展包

1.3.0 2019-10-17 16:14 UTC

This package is auto-updated.

Last update: 2019-10-17 16:16:15 UTC


README

这是一个用于 OpenTok SDK 的 Laravel 5 包装库。OpenTok 是由 TokBox 提供的产品,它利用 WebRTC 技术实现点对点视频、音频和消息。请注意:此仓库与 TokBox 没有任何关联。

安装

要获取 OpenTok Laravel 的最新版本,只需使用 Composer 引入项目。

$ composer require mmsccons/opentok-laravel

当然,您也可以手动更新 require 块并运行 composer update

{
    "require": {
        "mmsccons/opentok-laravel": "dev-master"
    }
}

安装 OpenTok Laravel 后,您需要注册服务提供者。打开 config/app.php 文件,并将以下内容添加到 providers 键中。

  • OpentokLaravel\ServiceProvider::class

您可以在 config/app.php 文件的 aliases 键中注册 OpentokApi 门面。

  • 'Opentok' => OpentokLaravel\Facades\Opentok::class

配置

默认值设置在 `config/opentok.php'。将此文件复制到您的配置目录以修改值。您可以使用以下命令发布配置:

php artisan vendor:publish --provider="OpentokLaravel\ServiceProvider"

从您的 OpenTok 账户获取 api_key 和 api_secret,并用配置文件中的占位符替换。要配置多个项目,请参见以下内容。

在深入研究之前...

虽然直接开始操作很有吸引力,但为了避免挫折,我强烈建议您查看 OpenTok 简介 并在网站上浏览并阅读他们的文档。我的文档非常 糟糕,仅旨在使 Laravel 开发者更容易使用,绝对不能代替 OpenTok 文档(它非常好)。

了解总体流程、使用的技术以及它们的定义(例如,会话、发布者、订阅者、令牌等)绝对是一个好主意。

一般用法

首先,您需要创建一个会话,以便您的订阅者和/或发布者有与之关联的内容。

// new session
$session    = Opentok::createSession();
$sessionId  = $session->getSessionId();

// check if it's been created or not (could have failed)
if (empty($sessionId)) {
    throw new \Exception("An open tok session could not be created");
}

现在我们需要为发布者创建一个令牌,以便他们实际上可以发布。请注意,您将需要在客户端使用 API 密钥,因此像这样就可以了:(这可以避免在您的 JS 文件或模板中硬编码)

// use the necessary files
use Config;
use Opentok; // Facade
use OpenTok\Role;
use OpenTokException;

// get your API key from config
$api_key = Config::get('opentok.api_key');

// then create a token (session created in previous step)
try {
    // note we're create a publisher token here, for subscriber tokens we would specify.. yep 'subscriber' instead
    $token = Opentok::generateToken($sessionId,
        array(
            'role' => Role::PUBLISHER
        )
    );
} catch(OpenTokException $e) {
    // do something here for failure
}

// pass these to your view where you're broadcasting from as you'll need them...
return View::make('your/view')
    ->with('session_id', $sessionId)
    ->with('api_key', $api_key)
    ->with('token', $token)

有关视频/音频/消息发布的 JS/HTML 等,请参阅 OpenTok 的 快速入门指南文档,并浏览他们的“如何做”示例等,它们相当不错!

希望您会发现这个库很有用,如果有,请随时告诉我,并请随时提出任何评论、问题或改进建议!

多个项目

您可能需要定义多个 OpenTok 项目,例如为 Safari 11 提供支持。要添加另一个项目,请将项目设置添加到 config/opentok.php 文件中。

要按名称引用项目

// projectName is as defined in the configuration file.
$session = Opentok::project('projectName')->createSession();

// to access the default project, you can do either
$session = Opentok::project('defaultProjectName')->createSession();
// or..
$session = Opentok::createSession();