README

这是一个为 OpenTok SDK 制作的 Laravel 5 封装库。OpenTok 是 TokBox 的产品，它使用 WebRTC 技术来实现点对点的视频、音频和消息通信。请注意：此仓库与 TokBox 没有任何关联。

对于 Laravel 4，请使用 1.0 分支！

安装

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

$ composer require jlorente/opentok-laravel

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

{
	"require": {
		"jlorente/opentok-laravel": "^1.1"
	}
}

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

• Tomcorbett\OpentokLaravel\ServiceProvider::class

您可以将 OpentokApi 外观注册到您的 config/app.php 文件的 aliases 键中。

• 'OpentokApi' => Tomcorbett\OpentokLaravel\Facades\OpentokApi::class

配置

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

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

从您的 OpenTok 账户获取 api_key 和 api_secret，并在配置文件中的占位符处替换它们。

在深入之前...

虽然直接深入是很吸引人的，但为了避免挫败感，我强烈建议您查看 OpenTok 简介，并在网站上浏览并阅读他们的文档。我的文档是 很糟糕的，并且仅旨在使 Laravel 开发者更容易使用，绝不是 OpenTok 文档（非常好）的替代品。

了解通用的流程、使用的技术及其定义（例如，会话、发布者、订阅者、令牌等）绝对是一个好主意。

通用用法

首先，您需要创建一个会话，以便您的订阅者或/和发布者有所关联。

// new session
$session    = OpentokApi::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 Tomcorbett\OpentokLaravel\Facades\OpentokApi;
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 = OpentokApi::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 的 快速入门指南 和 文档，并浏览他们的如何操作示例等，它们相当不错！

希望您会发现这个库很有用，如果是这样，请随时告诉我，并且欢迎提出任何评论、问题或改进建议！