wedgehr/opentok-laravel

A laravel bundle for the OpenTok PHP SDK

2.1.0 2022-07-24 20:56 UTC

This package is auto-updated.

Last update: 2023-01-24 21:57:54 UTC


README

This is a Laravel 5 wrapper library for the OpenTok SDK. OpenTok is a product by TokBox which utilizes WebRTC to enable peer to peer video, audio and messaging. Please note: this repository is in NO WAY associated with TokBox.

Installation

To get the latest version of OpenTok Laravel, simply require the project using Composer:

$ composer require wedgehr/opentok-laravel

Instead, you may of course manually update your require block and run composer update if you so choose:

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

Once OpenTok Laravel is installed, you need to register the service provider. Open up config/app.php and add the following to the providers key.

  • OpentokLaravel\ServiceProvider::class

You can register the OpentokApi facade in the aliases key of your config/app.php file if you like.

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

Configuration

The defaults are set in `config/opentok.php'. Copy this file to your own config directory to modify the values. You can publish the config using this command:

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

Get your api_key and api_secret from your OpenTok account and replace the placeholders in your config file. To configure multiple projects, see below.

Before you dive in...

Although it's very tempting to dive straight in, to avoid frustration, I would highly reccomend that you take a look at the Intro to OpenTok and also click around the site and read their docs. My documentation is terrible and only intended to make it easier to use for laravel developers and in no way is it a replacement for the OpenTok documentation (which is really good).

It's definitely a good idea to get to grips with the general flow, the technologies used and also their definitions e.g. session, publisher, subscriber, token etc.

General Usage

First you need to create a session so your subscribers and/or publishers have something to assiciate with

// 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");
}

Now we need to create a token for your publisher to use so they can actually publish Please note that you will need to API key on the client side to use in the JS so something like this would be fine: (saves you hardcoding in your JS file or template)

// 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)

For the JS/HTML etc. for publishing video/audio/messages please see the OpenTok Quick Start Guide and Documentation and take a browse around their How To examples etc. they're pretty good!

Hopefully you will find this library useful, if so please feel free to let me know, and feel free to drop any comments, questions or suggestions to improve!

Multiple Projects

You may want to define multiple OpenTok projects, for example for Safari 11 support. To add an additional project, add the project settings to the config/opentok.php file.

To reference a project by name:

// 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();