PHPackages                             bluebillywig/vmsrpc - 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. bluebillywig/vmsrpc

ActiveLibrary[API Development](/categories/api)

bluebillywig/vmsrpc
===================

Composer package allowing to easily connect and communicate with the Blue Billywig VMS API.

0.97.6(4y ago)041.9k↓27%22MITPHPPHP >=7.1.27CI failing

Since Jan 15Pushed 4y ago7 watchersCompare

[ Source](https://github.com/bluebillywig/composer-vmsrpc)[ Packagist](https://packagist.org/packages/bluebillywig/vmsrpc)[ RSS](/packages/bluebillywig-vmsrpc/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (2)Dependencies (2)Versions (9)Used By (2)

VMS RPC
=======

[](#vms-rpc)

The vms rpc client makes it possible to connect to the vms more easily. This is achieved by taking away some of the complexities like connecting to the vms. This document provides a technical summary of the vms rpc client for PHP.

Usage
-----

[](#usage)

### Getting Started

[](#getting-started)

Create a new instance of BlueBillywig\\RPC. This can be done by providing the username and password or the shared secret.

A shared secret can be generated by going to https://*YourPublication*.bbvms.com/ovp/#/publication/api-keys (where *YourPublication* needs to be substituted with the name of your publication) and clicking *CREATE NEW KEY*.

#### Creating instance with username and password

[](#creating-instance-with-username-and-password)

```
require __DIR__ . '/vendor/autoload.php';

use BlueBillywig\VMSRPC\RPC;

$host = 'https://YourPublication.bbvms.com';
$user = 'UserName';
$password = 'Password';

try {
    $vms = new RPC($host, $user, $password);
} catch (\Exception $e) {
    echo $e->getMessage();
}
```

#### Creating instance with shared secret

[](#creating-instance-with-shared-secret)

```
require __DIR__ . '/vendor/autoload.php';

use BlueBillywig\VMSRPC\RPC;

$host = 'https://YourPublication.bbvms.com';
$sharedSecret = '123-1234567890abcdefghijklmnopqrstuv';

try {
    $vms = new RPC($host, null, null, $sharedSecret);
} catch (\Exception $e) {
    echo $e->getMessage();
}
```

#### Quick start

[](#quick-start)

The following example demonstrates how to search for a couple of mediaclips and immediately print the embed code for each mediaclip.

```
require __DIR__ . '/vendor/autoload.php';

use BlueBillywig\VMSRPC\RPC;

$host = 'https://YourPublication.bbvms.com';
$sharedSecret = '123-1234567890abcdefghijklmnopqrstuv';
$arProps = array(
    'query' => 'type:mediaclip AND status:published',
    'limit' => '10',
    'sort' =>'createddate desc'
);

try {
    $vms = new RPC($host, null, null, $sharedSecret);

    $search_result = json_decode($vms->json('search', null, $arProps));

    if($search_result->count > 0) {
        foreach($search_result->items as $oMc) {
            echo '';
        }
    }
} catch (\Exception $e) {
    echo $e->getMessage();
}
```

### Function list

[](#function-list)

Here you can find the available functions within the RPC, which make it possible to execute API requests. More information concerning API requests can be found here:

#### doAction

[](#doaction)

Execute API request/action and return the result as an array.

`array doAction(string $entity, string $action, array $arProps)`

$entity: The relevant api entity that you want to query to obtain the desired result. For example mediaclip, mediacliplist, publication or playout.

$action: The action you want to execute. The actions differ per entity, see the API documentation for details. For example for the mediaclip entity possible actions are get, put or getUsageStats.

$arProps: This array will contain required or optional properties needed for the specific request. For example for the action put of the entity mediaclip you'll need to provide at least the property xml, see the example below.

Here an example to update a mediaclip:

```
require __DIR__ . '/vendor/autoload.php';

use BlueBillywig\VMSRPC\RPC;

$host = 'http://YourPublication.bbvms.com';
$user = 'UserName';
$password = 'Password';

try {
    $vms = new RPC($host, $user, $password);

    //Set the status to draft
    $arProps = array(
        'xml' => ''
    );
    $r = $vms->doAction('mediaclip', 'put', $arProps);
} catch (\Exception $e) {
    echo $e->getMessage();
}
```

And an example to add a new mediaclip including a video-file:

```
require __DIR__ . '/vendor/autoload.php';

use BlueBillywig\VMSRPC\RPC;

$host = 'http://YourPublication.bbvms.com';
$user = 'UserName';
$password = 'Password';

try {
    $vms = new RPC($host, $user, $password);

    //Add a new mediaclip, add a file, set the title and set the status.
    $file = getcwd() . "/someVideo.mp4";
    $arProps = array(
        'xml' => '',
        'Filedata' => '@'.$file
    );

    $r = $vms->doAction('mediaclip', 'put', $arProps);
} catch (\Exception $e) {
    echo $e->getMessage();
}
```

#### JSON

[](#json)

Execute API request/action and return the result in JSON format. At this moment it's **only** possible to get results in JSON format for **'get'** and **'search'** actions on **mediaclips**, **timelines**, **widgets** and **zones**.

`string json(string $entity, int $objectId = null, array $arProps = null)`

$entity: The relevant api entity that you want to query to obtain the desired result. For example mediaclip, mediacliplist, publication or playout.

$objectId: (optional) The id of a certain entity, for example the mediaclipid. If $objectId is set the action will become 'get'.

$arProps: (optional) This array contains required or optional properties needed for the specific request.

Below an example to search for a couple of mediaclips.

```
require __DIR__ . '/vendor/autoload.php';

use BlueBillywig\VMSRPC\RPC;

$host = 'http://YourPublication.bbvms.com';
$user = 'UserName';
$password = 'Password';

try {
    $vms = new RPC($host, $user, $password);

    $arProps = array(
        'query' => 'type:mediaclip','limit' => '10',
        'sort' =>'createddate desc'
    );
    $r = json_decode($vms->json('search', null, $arProps));
} catch (\Exception $e) {
    echo $e->getMessage();
}
```

#### XML

[](#xml)

Execute API request/action and return the result in XML format.

`string xml(string $entity, int $objectId = null, array $arProps = null)`

$entity: The relevant api entity that you want to query to obtain the desired result. For example mediaclip, mediacliplist, publication or playout.

$objectId: (optional) The id of a certain entity, for example the mediaclipid. If $objectId is set the action will become 'get'.

$arProps: (optional) This array contains required or optional properties needed for the specific request. If not set the default action will become 'get'.

Below an example to get global configurations of a publication.

```
require __DIR__ . '/vendor/autoload.php';

use BlueBillywig\VMSRPC\RPC;

$host = 'http://YourPublication.bbvms.com';
$user = 'UserName';
$password = 'Password';

try {
    $vms = new RPC($host, $user, $password);

    $r = $vms->xml('publication');
} catch (\Exception $e) {
    echo $e->getMessage();
}
```

#### URI

[](#uri)

Execute an API request/action and send all properties for the specific request on the query string. This may be useful whether multiple properties with the same key need to be provided, which could be the case for Solr requests.

`string uri(string $apiEntityUrl, string $qs = null)`

$apiEntityUrl: The relevant api entity that you want to query to obtain the desired result. For example json/mediaclip or json/qstats.

$qs: (optional) The Query String to be send with the request'.

Below an example to get the mainconfig.xml, which contains configuration of your publication such as asset-paths.

```
require __DIR__ . '/vendor/autoload.php';

use BlueBillywig\VMSRPC\RPC;

$host = 'http://YourPublication.bbvms.com';
$user = 'UserName';
$password = 'Password';

try {
    $vms = new RPC($host, $user, $password);

    $apiEntityUrl = "";
    $qs = 'mainconfig.xml';

    $r = $vms->uri($apiEntityUrl, $qs);
} catch (\Exception $e) {
    echo $e->getMessage();
}
```

Unit Testing
------------

[](#unit-testing)

To run the PHP unit tests, clone this repository, run `composer install` and copy `tests/config.example.yaml` to `tests/config.yaml`. Update `tests/config.yml` with the settings that apply to your publication.

Run the tests with on of the following commands.

```
./vendor/bin/phpunit
composer test
```

###  Health Score

33

—

LowBetter than 75% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity31

Limited adoption so far

Community22

Small or concentrated contributor base

Maturity51

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 50% 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 ~162 days

Recently: every ~169 days

Total

7

Last Release

1704d ago

PHP version history (3 changes)0.97PHP >=5.6.39

0.97.2PHP >=7.1.30

0.97.4PHP >=7.1.27

### Community

Maintainers

![](https://www.gravatar.com/avatar/e1f4b0048d61164561e20910cf69cd85d7aebec8e8e1c0aad3a354171d01ac37?d=identicon)[martijnbots](/maintainers/martijnbots)

![](https://www.gravatar.com/avatar/3083f712d716d30fbedd4e71a9c6b0bdce2ececc5953660d081c0cd97ef325f2?d=identicon)[bluebillywig-pkgs](/maintainers/bluebillywig-pkgs)

---

Top Contributors

[![RobertBoes](https://avatars.githubusercontent.com/u/2871897?v=4)](https://github.com/RobertBoes "RobertBoes (4 commits)")[![fgroenendijk](https://avatars.githubusercontent.com/u/3890475?v=4)](https://github.com/fgroenendijk "fgroenendijk (2 commits)")[![ghultink](https://avatars.githubusercontent.com/u/9196789?v=4)](https://github.com/ghultink "ghultink (1 commits)")[![SanderMuller](https://avatars.githubusercontent.com/u/9074391?v=4)](https://github.com/SanderMuller "SanderMuller (1 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/bluebillywig-vmsrpc/health.svg)

```
[![Health](https://phpackages.com/badges/bluebillywig-vmsrpc/health.svg)](https://phpackages.com/packages/bluebillywig-vmsrpc)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90821.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

74513.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)

PHPackages © 2026

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