-
Notifications
You must be signed in to change notification settings - Fork 11
Clipping features docs #512
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
dcoffey3296
wants to merge
5
commits into
main
Choose a base branch
from
clipping-vod-docs-updates
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
78 changes: 78 additions & 0 deletions
78
millicast/distribution/stream-recordings/how-to-upload-media-assets.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| --- | ||
| title: How-to Upload Media Assets | ||
| --- | ||
|
|
||
| You can upload your own media assets to OptiView storage to be played back via the OptiView CDN. These are files that are pre-transcoded before upload for distribution and are served over Dolby's CDN and can be a single asset such as an MP4 or a multi-file asset such as an HLS asset that has a series of manifests and media files. | ||
|
|
||
| The steps are as follows. | ||
|
|
||
| 1. Generate Upload Credentials | ||
| 1. Upload to Dolby's S3-Compatible Storage | ||
| 1. Register Media Asset | ||
|
|
||
| ## Generate Upload Credentials | ||
|
|
||
| Use the [Generate Upload Credentials](/millicast/api/media-assets-get-upload-credentials.api.mdx) endpoint to generate credentials and an S3 compatible upload location. | ||
| These credentials will last for 1 hour. Please upload and register media assets within the hour. | ||
|
|
||
| This is an example response. | ||
|
|
||
| ``` | ||
| { | ||
| "status": "success", | ||
| "data": { | ||
| "path": "string", | ||
| "bucketName": "string", | ||
| "objectPrefix": "string", | ||
| "accessKeyId": "string", | ||
| "secretAccessKey": "string", | ||
| "sessionToken": "string", | ||
| "expiration": "2026-01-12T01:27:13Z" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Upload to Dolby's S3-Compatible Storage | ||
|
|
||
| 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> | ||
| ``` | ||
|
|
||
| ## Register Media Asset | ||
|
|
||
| After completing upload make a [registration call](/millicast/api/media-assets-register-media-asset.api.mdx). | ||
|
|
||
| The `mediaAssetId` returned in the response body can be used for inspecting, retrieving and deleting the media asset. | ||
|
|
||
| This endpoint does not give immediate feedback on whether the media asset has been successfully created. Please use the [Read Media Asset](/millicast/api/media-assets-read-media-asset.api.mdx) endpoint to inspect the outcome of registration and retrieve the download url. | ||
|
|
||
| ### Example Usage 1 - Upload A Single File Asset | ||
|
|
||
| If your asset has a single file such as an mp4 file, append the filename to the `objectPrefix` obtained from the [Generate Upload Credentials](/millicast/api/media-assets-get-upload-credentials.api.mdx) response. | ||
| The [Register Media Asset](/millicast/api/media-assets-register-media-asset.api.mdx) request would look like | ||
|
|
||
| ``` | ||
| { | ||
| "objectPrefix": <object-prefix-from-above>/user-file.mp4 | ||
| } | ||
| ``` | ||
|
|
||
| Assuming on inspection our service finds an object key that is an exact match of `objectPrefix`, OptiView will obtain and serve that single file. | ||
| If there are any additional files uploaded to `s3://<bucketName>/<objectPrefix>/*` they will be ignored. | ||
|
|
||
| ### Example Usage 2 - Upload A Multi File Asset | ||
|
|
||
| If your asset has multiple files such as an HLS asset with a main manifest and related manifests/media files, the [Register Media Asset](/millicast/api/media-assets-register-media-asset.api.mdx) request should look like this. | ||
|
|
||
| ``` | ||
| { | ||
| "objectPrefix": <object-prefix-from-api-response>, | ||
| "entrypoint": "main.m3u8" | ||
| } | ||
| ``` | ||
|
|
||
| Since the `entrypoint` is specified, the discovery url for downloading the media asset via the CDN will be a link to a copy of `main.m3u8`. | ||
|
|
||
| Assuming on inspection our service _does not_ find an object key which exactly matches the `objectPrefix`, OptiView will obtain and serve all the contents uploaded to `s3://<bucketName>/<objectPrefix>/*`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| --- | ||
| sidebar_position: 11 | ||
| --- | ||
|
|
||
| # 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. | ||
|
|
||
| To create a clip for a live stream, call the [Create Media Asset](/millicast/api/media-assets-create-media-asset) endpoint, specifying your `channelId`, `startTime` and "Hls" as the `targetFormat`. See below for an example request. | ||
|
|
||
| ```curl | ||
| curl --request POST \ | ||
| --url https://api.millicast.com/api/v3/media/assets \ | ||
| --header 'Authorization: Bearer abc123' \ | ||
| --data ' | ||
| { | ||
| "channelId": <channelId>, | ||
| "startTime": "2026-01-15T01:33:33Z", | ||
| "stopTime": "2026-01-15T01:34:33Z", | ||
| "targetFormat": "Hls" | ||
| } | ||
| ' | ||
| ``` | ||
|
|
||
| Use the `mediaAssetId` in the response to check the completion status of the clip and retrieve a download URL via the [Read Media Asset](/millicast/api/media-assets-read-media-asset/) endpoint. | ||
|
|
||
| For more information on live-to-VOD clipping please see [here](/millicast/distribution/stream-recordings/live-clipping). For more information on how to retrieve your clips please see [here](/millicast/distribution/stream-recordings/how-to-get-media-assets). | ||
|
|
||
| Please contact your Dolby Account Team if you would like to have this feature enabled. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
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