Getting Started

Playout UI is a media scheduling and playout management interface with live time display and real-time progress tracking. It uses Apache CouchDB as its backend store and is suited for broadcast and streaming environments where you need to organise, edit, and control media playback. Available as a service in Eyevinn Open Source Cloud, you can launch your own playout dashboard in minutes.

Prerequisites

Step 1: Create a CouchDB instance

Playout UI requires an Apache CouchDB instance. Navigate to the CouchDB service in the Eyevinn OSC web console. Click Create couchdb, enter a name and an admin password, and wait for the status to show Running.

Once running, click the instance card and note the HTTPS URL (e.g. https://mycouchdb.apache-couchdb.auto.prod.osaas.io).

Step 2: Store credentials as secrets

Navigate to the Playout UI service page and switch to the Service Secrets tab.

Create the following secrets:

  • couchurl — the HTTPS URL of your CouchDB instance (without embedded credentials)
  • uipassword — the admin password for the Playout UI

Step 3: Create the Playout UI instance

Switch to the My playout-uis tab and click Create playout-ui. Fill in:

  • Name: a name for your instance (alphanumeric only)
  • DbUrl: {{secrets.couchurl}}
  • Username: admin (or a custom admin username)
  • Password: {{secrets.uipassword}}

Click Create and wait for the status to show Running.

Step 4: Access Playout UI

Click the instance card and open the URL to reach the Playout UI web interface. Log in with the username and password you set in Step 3.

Using the CLI

# Create a CouchDB database
osc create apache-couchdb myplayoutdb -o AdminPassword="mypassword"

# Create the Playout UI instance
osc create birme-playout-ui myplayout \
  -o DbUrl="https://myplayoutdb.apache-couchdb.auto.prod.osaas.io" \
  -o Username="admin" \
  -o Password="mypassword"

Resources