PHPackages                             newman/laravel-tms-api-client - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. newman/laravel-tms-api-client

ActiveLibrary[API Development](/categories/api)

newman/laravel-tms-api-client
=============================

Laravel Backscreen Api client.

2.0.2(1y ago)08.7k↓100%[2 issues](https://github.com/edgarsn/laravel-backscreen-api-client/issues)MITPHPPHP ^8.2CI passing

Since Jan 20Pushed 1y ago1 watchersCompare

[ Source](https://github.com/edgarsn/laravel-backscreen-api-client)[ Packagist](https://packagist.org/packages/newman/laravel-tms-api-client)[ RSS](/packages/newman-laravel-tms-api-client/feed)WikiDiscussions 2.x Synced 1mo ago

READMEChangelog (10)Dependencies (9)Versions (16)Used By (0)

Laravel Backscreen API Client
=============================

[](#laravel-backscreen-api-client)

This package helps you to make API calls to Backscreen (a.k.a: Videosher, TET Media Services) API v5.

Upgrade
-------

[](#upgrade)

If you were using 1.x before, follow UPGRADE.md to update your code properly since it contains many breaking changes.

Requirements
------------

[](#requirements)

- Laravel 11.0+, 12.0+
- PHP 8.2+

For laravel versions 9.0, 10.0, see 1.x branch.

Installation
------------

[](#installation)

Require the package via Composer:

```
composer require newman/laravel-tms-api-client
```

Copy config file to your `config` directory.

```
php artisan vendor:publish --tag=backscreen-api-config
```

Add environment variables to your `.env` file.

```
BACKSCREEN_DEFAULT_USERNAME="API Key"
BACKSCREEN_DEFAULT_PASSWORD="API Secret"
```

At last, you can add extra client to your `backscreen-api.php` config file with other credentials or different default settings.

📖 Documentation & Usage
===========================

[](#book-documentation--usage)

Clients
-------

[](#clients)

### Access client from config

[](#access-client-from-config)

```
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

TmsApi::client('default')->run(...);
```

### Create a client dynamically

[](#create-a-client-dynamically)

We recommend to do this on your `AppServiceProvider`, inside `boot` function.

```
use Newman\LaravelBackscreenApiClient\Auth\BasicAuthMethod;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

$client = TmsApi::createClient('live', new BasicAuthMethod('api key', 'api secret'));

// and from now on you can access using client() as well
// TmsApi::client('live')->run(...);
```

### Authenticate via Bearer token

[](#authenticate-via-bearer-token)

There are some endpoints (e.g. `/User/Login`) which doesn't require any authentication at all.

```
use Newman\LaravelBackscreenApiClient\Auth\BearerAuthMethod;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

// 1) Retrieve Bearer token without any authentication.
$response = TmsApi::nullClient()->run(new Login('my@email.com', 'mypassword'));

$bearerToken = $response->json('data.auth_token');

// ... you may want to cache this token for some time

// 2) Override default client dynamically with other auth method.
TmsApi::createClient('default', new BearerAuthMethod($bearerToken));

// 3) now all calls on default client will use Bearer token as auth method.
// TmsApi::client('default')->run(...);
```

### Configure request

[](#configure-request)

**Note:** These parameters will be present only for a single (upcoming) request and then will reset to defaults.

#### `timeout` and `connectTimeout`

[](#timeout-and-connecttimeout)

```
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

TmsApi::client('default')->timeout(30)->connectTimeout(45)->run(...);
```

#### `withMiddleware`

[](#withmiddleware)

Append HTTP middleware to this client upcoming requests.

```
use GuzzleHttp\Middleware;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

TmsApi::client('default')
    ->withMiddleware(
        Middleware::mapRequest(function (RequestInterface $request) {
            $request = $request->withHeader('X-Example', 'Value');

            return $request;
        })
    )
    ->run(....);
```

Response
--------

[](#response)

Response of the request is `\Illuminate\Http\Client\Reponse` object.

Endpoints
=========

[](#endpoints)

We created this package with only few implementations of TMS endpoints. PRs are welcome to add more.

For each endpoint argument (except required ones) you'll find a correspoding setter function.

Here is the list of implemented endpoints:

`/Token`
--------

[](#token)

### Endpoint: `/Token/Generate`

[](#endpoint-tokengenerate)

Generates a new token.

**Accepted Auth Methods:** `Basic`, `Bearer token`, `API Key`

```
use Newman\LaravelBackscreenApiClient\Endpoints\Token\Generate as TokenGenerate;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

$endpoint = new TokenGenerate(123456, TokenGenerate\ItemTypeEnum::MEDIA);

// Optional
$endpoint->allowedCountries(['lv', 'lt', 'ee']);
$endpoint->allowedIp('85.110.62.99');

$endpoint->expireTime(1674074046);
$endpoint->expireTime('2023-01-18 12:34:56');
$endpoint->expireTime(\Carbon\Carbon::now()->addHour());

$endpoint->subitemId(5);
$endpoint->subitemType(TokenGenerate\SubitemTypeEnum::PLAYBACK_HLS);

$response = TmsApi::client('default')->run($endpoint);
```

`/Media`
--------

[](#media)

### Endpoint: `/Media/List`

[](#endpoint-medialist)

Retrieve a list of media.

**Accepted Auth Methods:** `Basic`, `Bearer token`, `API Key`

```
use Newman\LaravelBackscreenApiClient\Endpoints\Media\MediaList;
use Newman\LaravelBackscreenApiClient\EndpointSupport\Enums\OrderDirectionEnum;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

$endpoint = new MediaList();

// Optional
$endpoint->ids([123]); // media IDs
$endpoint->assetIds(['asset_id']);
$endpoint->categoryIds([5]);
$endpoint->onlyAvailable(true);
$endpoint->published(true);
$endpoint->search('lorem ipsum');
$endpoint->tags(['archive']);
$endpoint->return(['embed_player_codes', 'sources']);
$endpoint->imagesFallback(false);

$endpoint->publisherStatus(MediaList\PublisherStatusEnum::PUBLISHED);

$endpoint->status(MediaList\StatusEnum::INGESTED);
$endpoint->status([MediaList\StatusEnum::INGESTED, MediaList\StatusEnum::PLAYABLE]);

$endpoint->createdFrom(1674074046);
$endpoint->createdFrom('2023-01-18 12:34:56');
$endpoint->createdFrom(\Carbon\Carbon::now()->addHour());

$endpoint->createdTo(1674074046);
$endpoint->createdTo('2023-01-18 12:34:56');
$endpoint->createdTo(\Carbon\Carbon::now()->addHour());

$endpoint->updatedFrom(1674074046);
$endpoint->updatedFrom('2023-01-18 12:34:56');
$endpoint->updatedFrom(\Carbon\Carbon::now()->addHour());

$endpoint->updatedTo(1674074046);
$endpoint->updatedTo('2023-01-18 12:34:56');
$endpoint->updatedTo(\Carbon\Carbon::now()->addHour());

$endpoint->limit(5);
$endpoint->offset(10);

$endpoint->orderBy(MediaList\OrderByEnum::CREATED_AT);
$endpoint->orderDir(OrderDirectionEnum::ASC);

$response = TmsApi::client('default')->run($endpoint);
```

### Endpoint: `/Media/Create`

[](#endpoint-mediacreate)

Create media.

**Accepted Auth Methods:** `Basic`, `Bearer token`

```
use Newman\LaravelBackscreenApiClient\Endpoints\Media\Create as MediaCreate;
use Newman\LaravelBackscreenApiClient\EndpointSupport\Callback;
use Newman\LaravelBackscreenApiClient\EndpointSupport\Enums\CallbackHttpMethodEnum;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;
use Newman\LaravelBackscreenApiClient\Endpoints\Media\Create\Files;
use Newman\LaravelBackscreenApiClient\Endpoints\Media\Create\Tags;

$endpoint = new MediaCreate('123');

// Optional
$endpoint->catId(542);
$endpoint->name('Name of media');
$endpoint->description('Description of media');
$endpoint->pgRating('PG-13');
$endpoint->autoTranscode(1);
$endpoint->embedPlayerId(123);
$endpoint->embedAdId(234);
$endpoint->embedProtectionId(345);
$endpoint->metadata([
    'key' => 'value'
]);
$endpoint->timezone('Europe/Riga');

$files = new MediaCreate\Files();
$files->url('https://mysite.com');
$files->username('username');
$files->password('secret');
$files->bitrate(3000);
$files->lang('LV');
$endpoint->files($files);

$tags = new MediaCreate\Tags();
$tags->set(['tag1', 'tag2']);
$tags->add(['tag3']);

$endpoint->callback(new Callback('https://mysite.com', CallbackHttpMethodEnum::POST));

$response = TmsApi::client('default')->run($endpoint);
```

### Endpoint: `/Media/Update`

[](#endpoint-mediaupdate)

Update media.

**Accepted Auth Methods:** `Basic`, `Bearer token`, `API Key`

```
use Newman\LaravelBackscreenApiClient\Endpoints\Media\Update as MediaUpdate;
use Newman\LaravelBackscreenApiClient\EndpointSupport\Callback;
use Newman\LaravelBackscreenApiClient\EndpointSupport\Enums\CallbackHttpMethodEnum;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;
use Newman\LaravelBackscreenApiClient\Endpoints\Media\Update\ByMediaId;
use Newman\LaravelBackscreenApiClient\Endpoints\Media\Update\ByAssetId;

// Select by which identificator to update
// by media ID
$endpoint = new MediaUpdate(new ByMediaId(123));
// by asset ID
$endpoint = new MediaUpdate(new ByAssetId('99_asset_id'));

// Optional
$endpoint->name('Name of media');
$endpoint->description('Description of media');

$images = new MediaUpdate\Images();
$images->thumbnail('thumbnail base64');
$images->placeholder('placeholder base64');
$images->playbutton('playbutton base64');
$images->logo('logo base64');
$endpoint->images($images);

$endpoint->callback(new Callback('https://mysite.com', CallbackHttpMethodEnum::POST));

$response = TmsApi::client('default')->run($endpoint);
```

### Endpoint: `/Media/Delete`

[](#endpoint-mediadelete)

Delete media by ID/s.

**Accepted Auth Methods:** `Basic`, `Bearer token`

```
use Newman\LaravelBackscreenApiClient\Endpoints\Media\Delete as MediaDelete;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

// Multiple IDs.
$endpoint = new MediaDelete([1234, 5678]);

$response = TmsApi::client('default')->run($endpoint);

// Single ID.
$endpoint = new MediaDelete(1234);

$response = TmsApi::client('default')->run($endpoint);
```

### Endpoint: `/Media/Clone`

[](#endpoint-mediaclone)

Clone media by ID.

**Accepted Auth Methods:** `Basic`, `Bearer token`

```
use Newman\LaravelBackscreenApiClient\Endpoints\Media\CloneMedia;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

$endpoint = new CloneMedia(1234, 'asset_id_for_the_new_asset');

// Optional
$endpoint->name('Name for the new asset');

$response = TmsApi::client('default')->run($endpoint);
```

### Endpoint: `/Media/Trim`

[](#endpoint-mediatrim)

**Accepted Auth Methods:** `Bearer token`

```
use Newman\LaravelBackscreenApiClient\Endpoints\Media\Trim;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

$endpoint = new Trim(1234, '00:00:10', '00:59:59', Trim\TypeEnum::NEW);

// Optional
$endpoint->name('Name');

$response = TmsApi::client('default')->run($endpoint);
```

### Endpoint: `/Media/Generateimage`

[](#endpoint-mediagenerateimage)

**Accepted Auth Methods:** `Basic`, `Bearer token`

```
use Newman\LaravelBackscreenApiClient\Endpoints\Media\GenerateImage;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

$endpoint = new GenerateImage(1234);

// Optional
$endpoint->mediaFileId(1902);
$endpoint->thumbnail('01:20:39');
$endpoint->placeholder('00:05:30');

$response = TmsApi::client('default')->run($endpoint);
```

### Endpoint: `/Media/Reset`

[](#endpoint-mediareset)

**Accepted Auth Methods:** `Bearer token`

```
use Newman\LaravelBackscreenApiClient\Endpoints\Media\Reset;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

$response = TmsApi::client('default')->run(new Reset(1234));
```

### Endpoint: `/Media/Transcode`

[](#endpoint-mediatranscode)

**Accepted Auth Methods:** `Bearer token`

```
use Newman\LaravelBackscreenApiClient\Endpoints\Media\Transcode;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

$response = TmsApi::client('default')->run(new Transcode(1234));
```

### Endpoint: `/Media/Canceltranscode`

[](#endpoint-mediacanceltranscode)

**Accepted Auth Methods:** `Bearer token`

```
use Newman\LaravelBackscreenApiClient\Endpoints\Media\CancelTranscode;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

$response = TmsApi::client('default')->run(new CancelTranscode(1234));
```

### Endpoint: `/Media/Updatesubtitlesfromsource`

[](#endpoint-mediaupdatesubtitlesfromsource)

**Accepted Auth Methods:** `Bearer token`

```
use Newman\LaravelBackscreenApiClient\Endpoints\Media\UpdateSubtitlesFromSource;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

$response = TmsApi::client('default')->run(new UpdateSubtitlesFromSource(1234));
```

### Endpoint: `/Media/Regeneratepackages`

[](#endpoint-mediaregeneratepackages)

**Accepted Auth Methods:** `Bearer token`

```
use Newman\LaravelBackscreenApiClient\Endpoints\Media\RegeneratePackages;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

$endpoint = new RegeneratePackages(1234);

// Optional
$endpoint->packageId([10, 15]);

$response = TmsApi::client('default')->run($endpoint);
```

`/Media/Manifest`
-----------------

[](#mediamanifest)

### Endpoint: `/Media/Manifest/List`

[](#endpoint-mediamanifestlist)

Retrieve list of manifests.

**Accepted Auth Methods:** `Basic`, `Bearer token`, `API Key`

```
use Newman\LaravelBackscreenApiClient\Endpoints\Media\Manifest\List\OrderByEnum;
use Newman\LaravelBackscreenApiClient\Endpoints\Media\Manifest\ManifestList;
use Newman\LaravelBackscreenApiClient\EndpointSupport\Enums\OrderDirectionEnum;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

$endpoint = new ManifestList();

// Optional
$endpoint->ids([1, 2]); // manifest IDs
$endpoint->limit(10);
$endpoint->mediaIds([1234]);
$endpoint->offset(10);
$endpoint->orderBy(OrderByEnum::NAME);
$endpoint->orderDir(OrderDirectionEnum::DESC);

$response = TmsApi::client('default')->run($endpoint);
```

### Endpoint: `/Media/Manifest/Create`

[](#endpoint-mediamanifestcreate)

Create a new media manifest.

**Accepted Auth Methods:** `Basic`, `Bearer token`

```
use Newman\LaravelBackscreenApiClient\Endpoints\Media\Manifest\Create as MediaManifestCreate;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

$endpoint = new MediaManifestCreate(1234); // media ID

// Optional
$endpoint->name('Name of the manifest');
$endpoint->default(true);
$endpoint->startAt(1000);
$endpoint->endAt(60000);
$endpoint->files([582, 583]);
$endpoint->packageId(4020);

$response = TmsApi::client('default')->run($endpoint);
```

### Endpoint: `/Media/Manifest/Update`

[](#endpoint-mediamanifestupdate)

Update media manifest by manifest ID.

**Accepted Auth Methods:** `Basic`, `Bearer token`

```
use Newman\LaravelBackscreenApiClient\Endpoints\Media\Manifest\Update as MediaManifestUpdate;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

$endpoint = new MediaManifestUpdate(85291); // manifest ID

// Same optional functions as "/Media/Manifest/Create" endpoint.

$response = TmsApi::client('default')->run($endpoint);
```

### Endpoint: `/Media/Manifest/Delete`

[](#endpoint-mediamanifestdelete)

Delete media manifest by manifest ID.

**Accepted Auth Methods:** `Basic`, `Bearer token`

```
use Newman\LaravelBackscreenApiClient\Endpoints\Media\Manifest\Delete as MediaManifestDelete;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

$response = TmsApi::client('default')->run(new MediaManifestDelete(85291)); // manifest ID
```

`/User`
-------

[](#user)

### Endpoint: `/User/Get`

[](#endpoint-userget)

Return current user info. Returns the same values as login action, but without auth\_token.

**Accepted Auth Methods:** `Bearer token`

```
use Newman\LaravelBackscreenApiClient\Endpoints\User\Get as UserGet;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

$endpoint = new UserGet();

// Optional
$endpoint->return(['client.limits']);

$response = TmsApi::client('default')->run($endpoint);
```

### Endpoint: `/User/Login`

[](#endpoint-userlogin)

Login user by email & password to retrieve Bearer token.

**Accepted Auth Methods:** `Null`

```
use Newman\LaravelBackscreenApiClient\Endpoints\User\Login as UserLogin;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

$endpoint = new UserLogin('my@email.com', 'password');

// Optional
$endpoint->twoFaCode('123456');
$endpoint->return(['client.limits']);

$response = TmsApi::nullClient()->run($endpoint);
```

### Endpoint: `/User/Logout`

[](#endpoint-userlogout)

Logout currently authenticated user.

**Accepted Auth Methods:** `Bearer token`

```
use Newman\LaravelBackscreenApiClient\Endpoints\User\Logout as UserLogout;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

$response = TmsApi::client('default')->run(new UserLogout());
```

`/Live`
-------

[](#live)

### Endpoint: `/Live/List`

[](#endpoint-livelist)

Retrieve a list of livestream.

**Accepted Auth Methods:** `Basic`, `Bearer token`, `API Key`

```
use Newman\LaravelBackscreenApiClient\Endpoints\Live\LiveList;
use Newman\LaravelBackscreenApiClient\EndpointSupport\Enums\OrderDirectionEnum;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

$endpoint = new LiveList();

$endpoint->id(123);
$endpoint->id([123, 456]);
$endpoint->id('123');

$endpoint->idFrom(123);
$endpoint->idTo(123);
$endpoint->imagesFallback(true);
$endpoint->limit(123);
$endpoint->name('name');
$endpoint->offset(123);

$endpoint->createdFrom(1674074046);
$endpoint->createdFrom('2023-01-18 12:34:56');
$endpoint->createdFrom(\Carbon\Carbon::now()->addHour());

$endpoint->createdPeriod(LiveList\PeriodEnum::LAST_HOUR);

$endpoint->createdTo(1674074046);
$endpoint->createdTo('2023-01-18 12:34:56');
$endpoint->createdTo(\Carbon\Carbon::now()->addHour());

$endpoint->orderBy(LiveList\OrderByEnum::CREATED_AT);
$endpoint->orderDir(OrderDirectionEnum::ASC);

$endpoint->return(LiveList\ReturnEnum::CATEGORY);
$endpoint->return([LiveList\ReturnEnum::CATEGORY, LiveList\ReturnEnum::PREVIEW]);

$endpoint->updatedFrom(1674074046);
$endpoint->updatedFrom('2023-01-18 12:34:56');
$endpoint->updatedFrom(\Carbon\Carbon::now()->addHour());

$endpoint->updatedPeriod(LiveList\PeriodEnum::LAST_HOUR);

$endpoint->updatedTo(1674074046);
$endpoint->updatedTo('2023-01-18 12:34:56');
$endpoint->updatedTo(\Carbon\Carbon::now()->addHour());

$response = TmsApi::client('default')->run($endpoint);
```

### Endpoint: `/Live/Create`

[](#endpoint-livecreate)

Create a livestream.

**Accepted Auth Methods:** `Basic`, `Bearer token`, `API Key`

```
use Newman\LaravelBackscreenApiClient\Endpoints\Live\Create;
use Newman\LaravelBackscreenApiClient\EndpointSupport\Images;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

$endpoint = new Create('New Livestream');

$endpoint->name('Different Livestream');
$endpoint->catId(1);
$endpoint->multiLanguages(true);
$endpoint->customOrigin('https://example.com');

$publish = new Create\Publish();
$publish->prefix('prefix');
$endpoint->publish($publish);

$endpoint->embedPlayerId(1);
$endpoint->embedAdId(1);
$endpoint->embedProtectionId(1);

$embed = new Create\Embed();
$embed->enablePublic(true);
$embed->publicPassword('password');
$embed->enablePreview(true);
$endpoint->embed($embed);

$security = new Create\Security();
$security->encryptionMethod(Create\Enums\EncryptionMethodEnum::AES);
$security->useToken(true);
$security->tokenDuration(Create\Enums\TokenDurationEnum::ONE_HOUR);
$endpoint->security($security);

$recording = new Create\Recording\Recording();
$recording->autoDelete(true);
$recording->autoDeleteMedia(true);
$recording->savePassed(true);
$recording->deleteAfterHours(1);
$recording->marginStartSeconds(1);
$recording->marginEndSeconds(1);
$recording->fileNamingPattern('pattern');

$nimbus = new Create\Recording\Nimbus();
$nimbus->syncInterval(1);
$nimbus->channelId(1);
$nimbus->manifestId(1);
$recording->nimbus($nimbus);

$epg = new Create\Recording\EPG();
$epg->hoursBefore(1);
$epg->hoursAfter(1);
$epg->round(0);
$recording->epg($epg);

$endpoint->recording($recording);

$images = new Images();
$images->thumbnail(base64_encode('FILE_CONTENTS'));
$images->placeholder(base64_encode('FILE_CONTENTS'));
$images->playbutton(base64_encode('FILE_CONTENTS'));
$images->logo(base64_encode('FILE_CONTENTS'));
$endpoint->images($images);

$availability = new Create\Availability();
$availability->scheduleStart(1674074046);
$availability->scheduleStart('2023-01-18 12:34:56');
$availability->scheduleStart(\Carbon\Carbon::now()->addHour());
$availability->scheduleEnd(1674074046);
$availability->scheduleEnd('2023-01-18 12:34:56');
$availability->scheduleEnd(\Carbon\Carbon::now()->addHour());
$endpoint->availability($availability);

$input = new Create\Input\Input();
$input->transcode(true);
$input->trancoderId(1);
$input->protocol(Create\Enums\ProtocolEnum::SRT);
$input->srtPassPhrase('passphrase');
$input->srtKeyLength(16);
$input->serverPort(443);
$input->serverApp('app');
$input->autoShutdown(1);
$input->videoPid('videoPID123');

$latvianLanguage = new Create\Input\AudioLanguage();
$latvianLanguage->language('lat');
$latvianLanguage->pid('123');
$latvianLanguage->languageName('Latvian');
$input->audioLanguages([$latvianLanguage]);

$endpoint->input($input);
$endpoint->timezone('Europe/Riga');

$response = TmsApi::client('default')->run($endpoint);
```

### Endpoint: `/Live/Update`

[](#endpoint-liveupdate)

Update an existing livestream.

**Accepted Auth Methods:** `Basic`, `Bearer token`, `API Key`

```
use Newman\LaravelBackscreenApiClient\Endpoints\Live\Update;
use Newman\LaravelBackscreenApiClient\Endpoints\Live\Create;
use Newman\LaravelBackscreenApiClient\EndpointSupport\Images;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

$endpoint = new Update(123);

$endpoint->id(1234);
$endpoint->name('Different Livestream');
$endpoint->catId(1);
$endpoint->multiLanguages(true);
$endpoint->customOrigin('https://example.com');

$publish = new Create\Publish();
$publish->prefix('prefix');
$endpoint->publish($publish);

$endpoint->embedPlayerId(1);
$endpoint->embedAdId(1);
$endpoint->embedProtectionId(1);

$embed = new Create\Embed();
$embed->enablePublic(true);
$embed->publicPassword('password');
$embed->enablePreview(true);
$endpoint->embed($embed);

$security = new Create\Security();
$security->encryptionMethod(Create\Enums\EncryptionMethodEnum::AES);
$security->useToken(true);
$security->tokenDuration(Create\Enums\TokenDurationEnum::ONE_HOUR);
$endpoint->security($security);

$recording = new Create\Recording\Recording();
$recording->autoDelete(true);
$recording->autoDeleteMedia(true);
$recording->savePassed(true);
$recording->deleteAfterHours(1);
$recording->marginStartSeconds(1);
$recording->marginEndSeconds(1);
$recording->fileNamingPattern('pattern');

$nimbus = new Create\Recording\Nimbus();
$nimbus->syncInterval(1);
$nimbus->channelId(1);
$nimbus->manifestId(1);
$recording->nimbus($nimbus);

$epg = new Create\Recording\EPG();
$epg->hoursBefore(1);
$epg->hoursAfter(1);
$epg->round(0);
$recording->epg($epg);

$endpoint->recording($recording);

$images = new Images();
$images->thumbnail(base64_encode('FILE_CONTENTS'));
$images->placeholder(base64_encode('FILE_CONTENTS'));
$images->playbutton(base64_encode('FILE_CONTENTS'));
$images->logo(base64_encode('FILE_CONTENTS'));
$endpoint->images($images);

$availability = new Create\Availability();
$availability->scheduleStart(1674074046);
$availability->scheduleStart('2023-01-18 12:34:56');
$availability->scheduleStart(\Carbon\Carbon::now()->addHour());
$availability->scheduleEnd(1674074046);
$availability->scheduleEnd('2023-01-18 12:34:56');
$availability->scheduleEnd(\Carbon\Carbon::now()->addHour());
$endpoint->availability($availability);

$input = new Create\Input\Input();
$input->transcode(true);
$input->trancoderId(1);
$input->protocol(Create\Enums\ProtocolEnum::SRT);
$input->srtPassPhrase('passphrase');
$input->srtKeyLength(1);
$input->serverPort(443);
$input->serverApp('app');
$input->autoShutdown(1);
$input->videoPid('videoPID123');

$latvianLanguage = new Create\Input\AudioLanguage();
$latvianLanguage->language('lat');
$latvianLanguage->pid('123');
$latvianLanguage->languageName('Latvian');
$input->audioLanguages([$latvianLanguage]);

$endpoint->input($input);
$endpoint->timezone('Europe/Riga');

$response = TmsApi::client('default')->run($endpoint);
```

### Endpoint: `/Live/On`

[](#endpoint-liveon)

Turn on an existing livestream.

**Accepted Auth Methods:** `Basic`, `Bearer token`, `API Key`

```
use Newman\LaravelBackscreenApiClient\Endpoints\Live\On;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

$endpoint = new On(123);

$endpoint->id(1234);

$response = TmsApi::client('default')->run($endpoint);
```

### Endpoint: `/Live/Off`

[](#endpoint-liveoff)

Turn Off an existing livestream.

**Accepted Auth Methods:** `Basic`, `Bearer token`, `API Key`

```
use Newman\LaravelBackscreenApiClient\Endpoints\Live\Off;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

$endpoint = new Off(123);

$endpoint->id(1234);

$response = TmsApi::client('default')->run($endpoint);
```

### Endpoint: `/Live/Record`

[](#endpoint-liverecord)

Start recording an existing livestream.

**Accepted Auth Methods:** `Basic`, `Bearer token`, `API Key`

```
use Newman\LaravelBackscreenApiClient\Endpoints\Live\Record;
use Newman\LaravelBackscreenApiClient\Support\Facades\TmsApi;

$endpoint = new Record(123);

$endpoint->id(1234);

$response = TmsApi::client('default')->run($endpoint);
```

🤝 Contributing
==============

[](#handshake-contributing)

We'll appreciate your collaboration to this package.

When making pull requests, make sure:

- All tests are passing: `composer test`
- Test coverage is not reduced: `composer test-coverage`
- There are no PHPStan errors: `composer phpstan`
- Coding standard is followed: `composer lint` or `composer fix-style` to automatically fix it.

###  Health Score

39

—

LowBetter than 86% of packages

Maintenance46

Moderate activity, may be stable

Popularity21

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity66

Established project with proven stability

 Bus Factor1

Top contributor holds 81.3% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~56 days

Recently: every ~16 days

Total

15

Last Release

418d ago

Major Versions

1.x-dev → 2.0.02025-03-05

PHP version history (2 changes)1.0.0PHP ^8.1

2.0.0PHP ^8.2

### Community

Maintainers

![](https://www.gravatar.com/avatar/23f4f2e71ffb2a4a4b9d187ea266897e49c4747b28ca5102fc841c1fda2a2642?d=identicon)[edgarsn](/maintainers/edgarsn)

---

Top Contributors

[![edgarsn](https://avatars.githubusercontent.com/u/6625918?v=4)](https://github.com/edgarsn "edgarsn (26 commits)")[![DavisPuciriuss](https://avatars.githubusercontent.com/u/65528137?v=4)](https://github.com/DavisPuciriuss "DavisPuciriuss (6 commits)")

---

Tags

apibackscreenlaravelmediateliatettet-media-servicestmsapilaravelmediatmsteliatettet-media-servicescloudycdn

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/newman-laravel-tms-api-client/health.svg)

```
[![Health](https://phpackages.com/badges/newman-laravel-tms-api-client/health.svg)](https://phpackages.com/packages/newman-laravel-tms-api-client)
```

###  Alternatives

[laravel/cashier-paddle

Cashier Paddle provides an expressive, fluent interface to Paddle's subscription billing services.

264778.4k3](/packages/laravel-cashier-paddle)[smodav/mpesa

M-Pesa API implementation

16363.7k1](/packages/smodav-mpesa)[vluzrmos/slack-api

Wrapper for Slack.com WEB API.

102589.1k3](/packages/vluzrmos-slack-api)[simplestats-io/laravel-client

Client for SimpleStats!

4515.5k](/packages/simplestats-io-laravel-client)[bmatovu/laravel-mtn-momo

Laravel MTN MOMO integration.

14310.9k](/packages/bmatovu-laravel-mtn-momo)[dragon-code/laravel-json-response

Automatically always return a response in JSON format

1118.6k1](/packages/dragon-code-laravel-json-response)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)