Download the PHP package squareetlabs/laravel-openvidu without Composer

Laravel client for controlling your videocalls from your Openvidu server.

This is a Laravel package wrapping OpenVidu Server REST API

Installation

You can install this package via composer:

Add Service Provider & Facade

For Laravel 5.5+

Once the package is added, the service provider and facade will be autodiscovered.

For Older versions of Laravel

Add the ServiceProvider to the providers array in config/app.php:

Add the Facade to the aliases array in config/app.php:

Run migrations

Configuration

Add your OpenVidu Server configuration values to your config/services.php file:

Set debug to true if you want to debug OpenVidu API consumptions from Guzzle Client

Set use_routes to false if you don't want to use default defined routes.

You must also add the openvidu cache driver to your config/cache.php file:

Usage

Using endpoints

LaravelOpenVidu is very easy to use. By default it exposes 13 different endpoints.

1- Create a token for a new session or an existing session

2- Get an existing session from array stored in memory

3- Get an existing session from OpenVidu Server

4- Returns the list of active sessions

5- Returns the list of active connections to the session

6- Allows publish a Stream (For now can only be IPCAM).

7- Forces some user to unpublish a Stream.

8- Forces the user with connectionId to leave the session

9- Gracefully closes the Session: unpublish all streams and evicts every

10- Checks if a session is being recorded

11- Start recording a session

12- Stop recording a session

13- Get the recording of a session

14- Delete the recording of a session

15- Sends signal to session

Using OpenVidu Facade

Create a token for a new session or an existing session

Get all active session

Get an existing session

Get all active connections from session

Close a session

Publish a stream on session (For now only can be IPCAM)

Forces some user to unpublish a Stream.

Forces the user with connectionId to leave the session.

Checks if a session is being recorded

Start recording a session

Stop recording a session

Get the recording of a session

Delete the recording of a session

Sends signal to session

Available Events

At the moment of raising the OpenVidu server we can indicate multiple configuration options, one of them is if we want to use the webhook service to receive events in an endpoint. In our case the default endpoint is '/openvidu/webhook'

Event ParticipantJoined is launched when a user has connected to a session. Example of use:

Event ParticipantLeft is launched when a user has left a session. Example of use:

Event RecordingStatusChanged is launched when the status of a recording has changed. The status may be: started, stopped, ready, failed. Example of use:

Event SessionCreated is launched when a new session has been created. Example of use:

Event SessionDestroyed is launched when a session has finished. Example of use:

Event WebRTCConnectionCreated is launched when a new media stream has been established. Can be an "INBOUND" connection (the user is receiving a stream from a publisher of the session) or an "OUTBOUND" connection (the user is a publishing a stream to the session). Example of use:

Event WebRTCConnectionCreated is launched when any media stream connection is closed. Example of use:

Event FilterEventDispatched is launched when a filter event has been dispatched. This event can only be triggered if a filter has been applied to a stream and a listener has been added to a specific event offered by the filter. Example of use:

Finally remember to add them to your EventServiceProvider: ``

OpenVidu

Visit OpenVidu Documentation for more information.

Support

Feel free to post your issues in the issues section.

Credits

• Alberto Rial Barreiro
• Jacobo Cantorna Cigarrán
• Desarrollo de software a medida SquareetLabs
• All Contributors

License

The MIT License (MIT). Please see License File for more information.