README

PHP APIs to manage rooms and to create access tokens. This library is designed to work with livekit-server. Use it with a PHP backend to manage access to LiveKit.

Installation

Requirements

php: >= 8

Composer

composer require agence104/livekit-server-sdk

Usage

Environment Variables

You may store credentials in environment variables. If host, api-key or api-secret is not passed in when creating a RoomServiceClient or AccessToken, the values in the following env vars will be used:

LIVEKIT_HOST
LIVEKIT_API_KEY
LIVEKIT_API_SECRET

Creating Access Tokens

Creating a token for participant to join a room.

use Agence104\LiveKit\AccessToken;
use Agence104\LiveKit\AccessTokenOptions;
use Agence104\LiveKit\VideoGrant;

// If this room doesn't exist, it'll be automatically created when the first
// client joins.
$roomName = 'name-of-room';
// The identifier to be used for participant.
$participantName = 'user-name';

// Define the token options.
$tokenOptions = (new AccessTokenOptions())
  ->setIdentity($participantName);

// Define the video grants.
$videoGrant = (new VideoGrant())
  ->setRoomJoin();
  ->setRoomName($roomName);

// Initialize and fetch the JWT Token. 
$token = (new AccessToken('api-key', 'secret-key'))
  ->init($tokenOptions)
  ->setGrant($videoGrant)
  ->toJwt();

By default, the token expires after 6 hours. you may override this by passing in ttl in the access token options. ttl is expressed in seconds (as number) .

Parsing the Access Tokens

Converting the JWT Token into a ClaimGrants.

use Agence104\LiveKit\AccessToken;

// Initialize and parse the JWT Token. 
$claimGrants = (new AccessToken('api-key', 'secret-key'))  
  ->fromJwt($token);

Permissions in Access Tokens

It's possible to customize the permissions of each participant:

use Agence104\LiveKit\VideoGrant;

$videoGrant = (new VideoGrant())
  ->setRoomJoin() // TRUE by default.
  ->setRoomName('name-of-room')
  ->setCanPublish(FALSE)
  ->setCanSubscribe() // TRUE by default.
  ->setGrant($videoGrant);

This will allow the participant to subscribe to tracks, but not publish their own to the room.

Managing Rooms

RoomServiceClient gives you APIs to list, create, and delete rooms. It also requires a pair of api key/secret key to operate.

use Agence104\LiveKit\RoomServiceClient;
use Agence104\LiveKit\RoomCreateOptions;

$host = 'https://my.livekit.host';
$svc = new RoomServiceClient($host, 'api-key', 'secret-key');

// List rooms.
$rooms = $svc->listRooms();

// Create a new room.
$opts = (new RoomCreateOptions())
  ->setName('myroom')
  ->setEmptyTimeout(10)
  ->setMaxParticipants(20);
$room = $svc->createRoom($opts);

// Delete a room.
$svc->deleteRoom('myroom');

Running Tests

We'll utilize Lando to streamline the test execution process. However, should you choose to run the tests on your local environment directly, you can certainly proceed with that approach.

Step 1:

Generate your environment file by duplicating example.dev and renaming the copy to .env, then enter your credentials accordingly.

Step 2:

Start the lando project.

lando start

Step 3:

Set up a LiveKit project with the livekit-cli by executing the command below, which will prompt you to provide some API credentials.

lando create-project

Step 4:

Generate the LiveKit room that will serve as the testing environment for the majority of the test cases.

lando create-test-room

Step 5:

Initialize 5 test users within the room. Run this command in a separate terminal window.

lando start-test-users

Step 6:

Time to get busy testing.

lando test

Step 7:

Once tests are completed, it is time to clean up.

End the lando start-test-users command.
Run lando delete-test-room to delete the test room.

agence104 / livekit-server-sdk

Maintainers

Details