Service: Playout UI - EyevinnOSC/community GitHub Wiki
Playout UI
Playout UI (serviceId birme-playout-ui) is a web application for managing timed playlists (schedules) with a live clock and real-time playlist position tracking. It stores its data in Apache CouchDB. In Eyevinn Open Source Cloud (OSC) it is a long-running service instance. License: MIT.
What it can do
- Show a live clock in the header, in 12-hour or 24-hour format.
- Create, edit and delete playlists and their items (video, audio, image, text, break); set a playlist as active.
- Start and stop playback with progress tracking, current and next item display, automatic progression, optional looping and manual skip to the next item.
- Persist playlists in CouchDB; a green dot in the header shows that the database is connected.
Creating an instance
Create a CouchDB instance first (serviceId apache-couchdb, see CouchDB) with an admin password and confirm it is running. Read its HTTPS URL with describe-service-instance, for example https://mycouchdb.apache-couchdb.auto.prod-se.osaas.io.
Store the CouchDB URL (without embedded credentials) and the password as service secrets with create-service-secret (serviceId birme-playout-ui), for example couchurl and couchpwd. Then call create-service-instance with serviceId: "birme-playout-ui"; the instance name must be alphanumeric and at most 20 characters.
{
"name": "myplayout",
"DbUrl": "{{secrets.couchurl}}",
"Username": "admin",
"Password": "{{secrets.couchpwd}}"
}
Verify with wait-for-service-ready or get-instance-status; describe-service-instance returns the URL of the web interface.
Options
| Option | Required | Type | Meaning |
|---|---|---|---|
| name | Yes | string | Name of the instance. Alphanumeric, at most 20 characters. |
| DbUrl | Yes | string, sensitive | HTTPS URL of the CouchDB instance, without embedded credentials. In OSC it is associated with a CouchDB instance (apache-couchdb). |
| Database | No | string | Name of the CouchDB database. The application default is playout_db. |
| Username | Yes | string | CouchDB username. Default admin. |
| Password | Yes | string, sensitive | Password for the CouchDB user; for an OSC CouchDB instance this is its admin password. |
| CorsOrigins | No | string | Allowed CORS origins used when the application configures CORS on CouchDB so that the browser can reach it. The application default is *; set specific domains for production. |
DbUrl and Password are sensitive: store them as service secrets and pass them as {{secrets.NAME}}, which only works as the entire field value. Overwriting a secret does not restart a running instance.
CouchDB options
Service apache-couchdb (Apache-2.0):
| Option | Required | Type | Meaning |
|---|---|---|---|
| name | Yes | string | Name of the instance. |
| AdminPassword | Yes | string, sensitive | Password of the CouchDB administrator. Can be generated by the system. |
Using the instance
Open the instance URL to reach the Playout UI. The database connection indicator in the header shows whether CouchDB is reachable.
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-se.osaas.io" \
-o Username="admin" \
-o Password="mypassword"