Service: SVT Encore GUI - EyevinnOSC/community GitHub Wiki

SVT Encore GUI

SVT Encore GUI (serviceId eyevinn-encore-ui) is an open-source (MIT) React web interface for SVT Encore, the cloud-native video transcoding system. In Eyevinn Open Source Cloud (OSC) it is a long-running service instance.

What it can do

  • Submit transcoding jobs from the browser by providing a source video URL and selecting an Encore profile.
  • Monitor queue status and job progress in real time.
  • Inspect job results and details.

Creating an instance

Create an SVT Encore instance first (encore) and confirm it is running. Both instances must be created in the same environment, because the GUI reaches Encore through its internal cluster DNS name. Get that name with describe-service-instance (the serviceDns field, the "Internal DNS" line in the CLI output).

Then call create-service-instance with serviceId: "eyevinn-encore-ui"; the name must be alphanumeric and at most 20 characters.

{ "name": "myencoreui", "EncoreUrl": "<internal-dns-name-of-your-encore-instance>" }

Verify with wait-for-service-ready or get-instance-status; describe-service-instance returns the URL of the dashboard.

Options

Option Required Type Meaning
name Yes string Name of the instance. Alphanumeric, at most 20 characters.
EncoreUrl Yes string Internal DNS name of your Encore instance. In OSC it is associated with an Encore instance (encore, internal routing).
OscAccessToken No string, sensitive OSC access token, needed if the Encore instance is not publicly accessible. Store it as a service secret and pass it as {{secrets.NAME}}, which only works as the entire field value.

SVT Encore options

Service encore (EUPL-1.2), the transcoding backend. See its own page for details.

Option Required Type Meaning
name Yes string Name of the Encore instance.
profilesUrl No string URL pointing to a list of transcoding profiles.
s3AccessKeyId No string, sensitive Access key id for S3 storage.
s3SecretAccessKey No string, sensitive Secret access key for S3 storage.
s3SessionToken No string, sensitive Session token for temporary S3 credentials.
s3Region No string AWS region used for S3 access, for example eu-north-1. Encore defaults to us-east-1 if unset (AWS_REGION).
s3Endpoint No string Endpoint of the S3 service. In OSC it is associated with a MinIO instance (minio-minio, internal routing).

Using the instance

The GUI has no login of its own; access is controlled by the OSC platform. Open the instance URL, provide the source video URL and select an Encore profile. Progress and output details are shown in real time.

To submit a job through the Encore API directly:

curl -X POST https://<encore-instance-url>/encoreJobs \
  -H "Content-Type: application/json" \
  -d '{
    "profile": "program",
    "outputFolder": "/outputs/myvideo",
    "baseName": "myvideo",
    "inputs": [{"uri": "https://example.com/source.mp4", "copyTs": true}]
  }'

CLI:

# Get the internal DNS name of your Encore instance
npx -y @osaas/cli describe encore myencore

# Create the GUI instance
npx -y @osaas/cli create eyevinn-encore-ui myencore-ui \
  -o EncoreUrl="<internal-dns-name-from-above>"

Limitations

  • The internal DNS name only resolves within the Kubernetes cluster the Encore instance runs on, so both instances must be in the same environment.

Resources