Skip to content

Clipping features docs#512

Open
dcoffey3296 wants to merge 8 commits intomainfrom
clipping-vod-docs-updates
Open

Clipping features docs#512
dcoffey3296 wants to merge 8 commits intomainfrom
clipping-vod-docs-updates

Conversation

@dcoffey3296
Copy link
Collaborator

@dcoffey3296 dcoffey3296 commented Feb 3, 2026

moving changes from rhfitz into a branch for the feedback process


Open with Devin

moving into the repo for easier feedback
@github-actions
Copy link
Contributor

github-actions bot commented Feb 3, 2026

PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://THEOplayer.github.io/documentation/pr-preview/pr-512/

Built to branch gh-pages at 2026-03-20 05:16 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@MattiasBuelens MattiasBuelens changed the title Clipping features docs (#511) Clipping features docs Feb 3, 2026
@dcoffey3296
Copy link
Collaborator Author

please don't merge these changes yet as the features are not complete

With [Stream Recordings](/millicast/distribution/stream-recordings/index.mdx) you will want to be able to retrieve and operate on any media assets that are created. You can do this manually using the [Streaming Dashboard](/millicast/streaming-dashboard/index.mdx) or automate workflows using the [Media Assets](/millicast/api/media-assets-list-media-assets.api.mdx) REST endpoints. There are also [Media Webhooks](/millicast/webhooks/media.md) available for building event-driven integrations.

## Recordings in the Dashboard
_Note: At this time, **Stream Recordings** are currently visible in the dashboard, for **live-to-vod** and **media uploads**, you must use the API to retrieve your assets. Creating live-to-vod assets requires consultation with the Dolby team to enable the workflow._
Copy link
Collaborator

@rhfitz rhfitz Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Live-to-vod clips are also visible on the dashboard
Edit: only mp4, not HLS

Media assets are media recordings that are created one of several ways:

- **[Stream Recordings](/millicast/distribution/stream-recordings/):** Media captured by enabling _recording_ on a token, the entire stream from first to last frame is stored in the cloud as a single-layer "mezzanine" recording, usually stored in an MP4 container
- **[Live-to-VOD clips](/millicast/distribution/stream-recordings/live-clipping/):** These assets are "clipped" out of a live streaming workflow as a servable HLS manifest that can be used for distribution and replays of the stream. These are referred to as "live clips" or "live clipping"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are millicast mp4 clips also included in live-to-vod?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, i made an update but it will be confusing for customers only using theo and not being able to generate an mp4. I assume we don't handle that case? Probably something we should pick up for consistency.

@MattiasBuelens MattiasBuelens marked this pull request as draft February 9, 2026 09:20
@rhfitz rhfitz marked this pull request as ready for review March 20, 2026 05:08
devin-ai-integration[bot]

This comment was marked as resolved.

…ts.mdx

Co-authored-by: devin-ai-integration[bot] <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Devin Review found 4 new potential issues.

View 4 additional findings in Devin Review.

Open in Devin Review

### How-to Retrieve a Media Asset

Recordings will typically be stored on Dolby's servers and made available for retrieval. You'll need to know the `mediaAssetId` of the item you want to download.
Media Assets are typically be stored on Dolby's servers and made available for retrieval. You'll need to know the `mediaAssetId` of the item you want to download. This includes all media types including stream recordings, live-to-vod clips, and media uploads.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Grammar error: "typically be stored" should be "typically stored"

When rewriting the sentence from "Recordings will typically be stored" to use "Media Assets are", the word "be" was left behind, resulting in the ungrammatical phrase "Media Assets are typically be stored". It should read "Media Assets are typically stored".

Suggested change
Media Assets are typically be stored on Dolby's servers and made available for retrieval. You'll need to know the `mediaAssetId` of the item you want to download. This includes all media types including stream recordings, live-to-vod clips, and media uploads.
Media Assets are typically stored on Dolby's servers and made available for retrieval. You'll need to know the `mediaAssetId` of the item you want to download. This includes all media types including stream recordings, live-to-vod clips, and media uploads.
Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.


# Live Clipping

Live clipping allows you to create CDN servable media files from your HLS stream while it is in progress. This requires a Real-time streaming account and [API key](/millicast/api/millicast-api) in addition to your THEOlive channe. For more details on the capabilties of the Media Asset API, refer to our [Media Asset API guide](/millicast/distribution/stream-recordings/how-to-get-media-assets/) and contact your Dolby Account Team to help you get set up.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Typos: "channe" (missing 'l') and "capabilties" (missing 'i')

Line 7 of the new live-clipping page contains two typos: "THEOlive channe." should be "THEOlive channel." and "capabilties" should be "capabilities". These appear in the introductory paragraph that users will read first.

Suggested change
Live clipping allows you to create CDN servable media files from your HLS stream while it is in progress. This requires a Real-time streaming account and [API key](/millicast/api/millicast-api) in addition to your THEOlive channe. For more details on the capabilties of the Media Asset API, refer to our [Media Asset API guide](/millicast/distribution/stream-recordings/how-to-get-media-assets/) and contact your Dolby Account Team to help you get set up.
Live clipping allows you to create CDN servable media files from your HLS stream while it is in progress. This requires a Real-time streaming account and [API key](/millicast/api/millicast-api) in addition to your THEOlive channel. For more details on the capabilities of the Media Asset API, refer to our [Media Asset API guide](/millicast/distribution/stream-recordings/how-to-get-media-assets/) and contact your Dolby Account Team to help you get set up.
Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

Media assets are media recordings that are created one of several ways:

- **[Stream Recordings](/millicast/distribution/stream-recordings/):** Media captured by enabling _recording_ on a token, the entire stream from first to last frame is stored in the cloud as a single-layer "mezzanine" recording, usually stored in an MP4 container
- **[Live-to-VOD clips](/millicast/distribution/stream-recordings/live-clipping/):** These assets are "clipped" out of a live streaming workflow as a servable HLS manifest that can be used for distribution and replays of the stream. These are referred to as "live clips" or "live clipping". You can also extract a single MP4 mezzanine "clip" appropriate or social sharing or archive
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Missing word "for" in bullet point: "appropriate or social sharing"

Line 8 says "a single MP4 mezzanine 'clip' appropriate or social sharing or archive" — the word "for" is missing. It should read "appropriate for social sharing or archive".

Suggested change
- **[Live-to-VOD clips](/millicast/distribution/stream-recordings/live-clipping/):** These assets are "clipped" out of a live streaming workflow as a servable HLS manifest that can be used for distribution and replays of the stream. These are referred to as "live clips" or "live clipping". You can also extract a single MP4 mezzanine "clip" appropriate or social sharing or archive
- **[Live-to-VOD clips](/millicast/distribution/stream-recordings/live-clipping/):** These assets are "clipped" out of a live streaming workflow as a servable HLS manifest that can be used for distribution and replays of the stream. These are referred to as "live clips" or "live clipping". You can also extract a single MP4 mezzanine "clip" appropriate for social sharing or archive
Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

Using the response fields _from the previous API call_, upload the media asset files to the specified S3 location.

```
$ AWS_ACCESS_KEY_ID=<from-above> AWS_SECRET_ACCESS_KEY=<from-above> AWS_SESSION_TOKEN=<from-above> \ aws s3 cp <filepath> s3://<bucketName>/<objectPrefix>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Stray backslash in shell command causes invalid command name

The shell example $ AWS_ACCESS_KEY_ID=<from-above> ... AWS_SESSION_TOKEN=<from-above> \ aws s3 cp ... has a stray \ (backslash-space) before aws. In bash, \ escapes the space making it part of the next word, so the shell would try to execute aws (with a leading space) as the command name, which would fail with "command not found". The \ should be removed so that the environment variables are set inline before the aws command.

Suggested change
$ AWS_ACCESS_KEY_ID=<from-above> AWS_SECRET_ACCESS_KEY=<from-above> AWS_SESSION_TOKEN=<from-above> \ aws s3 cp <filepath> s3://<bucketName>/<objectPrefix>
$ AWS_ACCESS_KEY_ID=<from-above> AWS_SECRET_ACCESS_KEY=<from-above> AWS_SESSION_TOKEN=<from-above> aws s3 cp <filepath> s3://<bucketName>/<objectPrefix>
Open in Devin Review

Was this helpful? React with 👍 or 👎 to provide feedback.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants