Service: Web Video Review - EyevinnOSC/community GitHub Wiki
Web Video Review
Web Video Review (serviceId eyevinn-web-video-review) streams and analyzes broadcast video files stored in S3-compatible storage, in the browser. In Eyevinn Open Source Cloud (OSC) it is a long-running service instance with up to 50 GiB of storage per instance. License: MIT. Source: Eyevinn/web-video-review.
What it can do
- Stream videos directly from an S3 bucket with real-time HLS, transcoding on demand for various formats (MP4, MOV, AVI, MKV, MXF, MPEG-TS, M2TS).
- Measure EBU R128 loudness, show audio waveforms and generate video thumbnails.
- Navigate with a dynamic, frame-accurate timeline with thumbnails.
- Review and switch between multiple audio tracks.
- Cache thumbnails and analysis data for performance.
Creating an instance
You need a bucket with video files in S3-compatible storage, for example a MinIO instance on OSC (minio-minio, see Service: MinIO). Confirm it is running first.
- Store the storage credentials as service secrets with
create-service-secret(serviceIdeyevinn-web-video-review), for exampleaccesskeyidandsecretaccesskey. The credentials needs3:ListBucketands3:GetObjecton the bucket. - Create the instance with
create-service-instance,serviceId: "eyevinn-web-video-review":
{
"name": "videoreview",
"AccessKeyId": "{{secrets.accesskeyid}}",
"SecretAccessKey": "{{secrets.secretaccesskey}}",
"Bucket": "your-video-bucket-name",
"s3Endpoint": "https://your-minio-endpoint.com"
}
Use wait-for-service-ready or get-instance-status, then describe-service-instance for the instance URL. With the OSC CLI:
npx -y @osaas/cli create eyevinn-web-video-review video-review \
-o AccessKeyId="{{secrets.accesskeyid}}" \
-o SecretAccessKey="{{secrets.secretaccesskey}}" \
-o Bucket="your-video-bucket-name" \
-o s3Endpoint="https://your-minio-endpoint.com"
For AWS S3, omit s3Endpoint and set s3Region, for example:
npx -y @osaas/cli create eyevinn-web-video-review post-production \
-o AccessKeyId="{{secrets.accesskeyid}}" \
-o SecretAccessKey="{{secrets.secretaccesskey}}" \
-o Bucket="post-production-files" \
-o s3Region="us-west-2"
Options
| Option | Required | Type | Meaning |
|---|---|---|---|
| name | Yes | string | Name of the instance. Alphanumeric, at most 20 characters. |
| AccessKeyId | Yes | string, sensitive | Access key ID for the S3-compatible storage (AWS S3, MinIO and others) holding the videos. Maps to S3_ACCESS_KEY_ID. |
| SecretAccessKey | Yes | string, sensitive | Secret access key paired with the access key ID. Maps to S3_SECRET_ACCESS_KEY. |
| Bucket | Yes | string | Name of the S3 bucket containing the video files, for example my-video-bucket. Maps to S3_BUCKET. |
| s3Region | No | string | S3 region of the bucket, for example us-east-1 (upstream default). Maps to S3_REGION. |
| s3Endpoint | No | string | Endpoint URL for S3-compatible storage such as MinIO, for example https://your-minio-endpoint.com. Leave empty for AWS S3. Maps to S3_ENDPOINT; path-style access is used. |
| awsSessionToken | No | string, sensitive | Temporary session token, needed only with temporary AWS (STS) credentials. Maps to AWS_SESSION_TOKEN; leave empty for long-lived keys. |
The credential options are secrets: pass them as {{secrets.NAME}}, as the entire field value.
Using the instance
Open the instance URL in a browser. The video library in the sidebar mirrors your bucket structure; select a file to load it for review. The application handles transcoding for various formats automatically.
Typical uses: reviewing broadcast-ready content (MXF files, audio levels, technical specs) and post-production review (final cuts, audio synchronization) before distribution.
Troubleshooting
- Videos not loading: verify the S3 credentials are correct and the bucket is accessible.
- Access denied: check that the credentials have read permissions (
s3:ListBucket,s3:GetObject) on the bucket. - Playback issues: make sure the files are in a supported format and stored in S3.
- Slow loading: check network connectivity to the S3 endpoint; a CDN can help.