New Updates came to the video model as of 2023-06-22.
{
"id": "63fcdbd82eec9b89aa5bfdf3",
"created_at": "2023-02-27T16:35:36.008Z",
"updated_at": "2023-02-27T16:55:26.156Z",
"deleted_at": null,
"title": "WeAreGoingOnBullrun",
"uuid": "17008615-2fd2-46f3-bb85-2ad4ca0466e1",
"coid": "omega-cop-f60d8a4c",
"status": "process-completed",
"privacy": "private",
"playback": {
"hls": "s3://dev-processed-media/69e4ed89/video/17008615-2fd2-46f3-bb85-2ad4ca0466e1/playlist.m3u8",
"dash": "s3://dev-processed-media/69e4ed89/video/17008615-2fd2-46f3-bb85-2ad4ca0466e1/playlist.mpd",
"audio": "s3://dev-processed-media/69e4ed89/video/17008615-2fd2-46f3-bb85-2ad4ca0466e1/audio.aac",
"r_1080p": null,
"r_720p": "s3://dev-processed-media/69e4ed89/video/17008615-2fd2-46f3-bb85-2ad4ca0466e1/720p.mp4",
"r_360p": "s3://dev-processed-media/69e4ed89/video/17008615-2fd2-46f3-bb85-2ad4ca0466e1/360p.mp4",
"r_480p": "s3://dev-processed-media/69e4ed89/video/17008615-2fd2-46f3-bb85-2ad4ca0466e1/480p.mp4",
"r_240p": "s3://dev-processed-media/69e4ed89/video/17008615-2fd2-46f3-bb85-2ad4ca0466e1/240p.mp4"
},
"playback_v2": {
"hls": "https://api.omegastream.net/stream/company/dev-processed-media/69e4ed89/video/17008615-2fd2-46f3-bb85-2ad4ca0466e1/playlist.m3u8?s=AUTH_SIGNATURE",
"dash": "https://api.omegastream.net/stream/company/dev-processed-media/69e4ed89/video/17008615-2fd2-46f3-bb85-2ad4ca0466e1/playlist.mpd?s=AUTH_SIGNATURE",
"audio": "https://api.omegastream.net/stream/company/dev-processed-media/69e4ed89/video/17008615-2fd2-46f3-bb85-2ad4ca0466e1/audio.aac?s=AUTH_SIGNATURE",
"r_1080p": null,
"r_720p": "https://api.omegastream.net/stream/company/dev-processed-media/69e4ed89/video/17008615-2fd2-46f3-bb85-2ad4ca0466e1/720p.mp4?s=AUTH_SIGNATURE",
"r_360p": "https://api.omegastream.net/stream/company/dev-processed-media/69e4ed89/video/17008615-2fd2-46f3-bb85-2ad4ca0466e1/360p.mp4?s=AUTH_SIGNATURE",
"r_480p": "https://api.omegastream.net/stream/company/dev-processed-media/69e4ed89/video/17008615-2fd2-46f3-bb85-2ad4ca0466e1/480p.mp4?s=AUTH_SIGNATURE",
"r_240p": "https://api.omegastream.net/stream/company/dev-processed-media/69e4ed89/video/17008615-2fd2-46f3-bb85-2ad4ca0466e1/240p.mp4?s=AUTH_SIGNATURE"
},
"input": {
"width": 1280,
"height": 720
},
"duration": 47,
"size": 59039744,
"ready_to_stream": true,
"thumbnail": "s3://dev-processed-media/69e4ed89/video/17008615-2fd2-46f3-bb85-2ad4ca0466e1/thumbnail.png",
"thumbnail_timestamp_pct": null,
"storage": {
"bucket": "dev-processed-media",
"raw_bucket": "raw-client-media",
"provider": "omega",
"source": {
"key": "raw-client-media/69e4ed89/17008615-2fd2-46f3-bb85-2ad4ca0466e1.mp4",
"size": 13183260
},
"meta": null
},
"meta": {
"downloaded_from": "http://commondatastorage.googleapis.com/gtv-videos-bucket/sample/WeAreGoingOnBullrun.mp4"
}
}
| Field | Type | Description | Nullable |
|---|---|---|---|
| id | string | video db id | NO |
| created_at | string | time of video creation RFC3339 formatted. | NO |
| updated_at | string | time of the latest video update RFC3339 formatted. | NO |
| deleted_at | string | time of the video deletion RFC3339 formatted. You can use it to determine if the video is marked for deletion or not. | YES |
| title | string | video title | NO |
| coid | string | company’s omega id. | NO |
| status | string | video current status. for more | NO |
| Privacy | string | video current privacy. private and public |
NO |
| entity_id | string | video s3 storage id. | YES |
| playback_v2 | Playback V2 | playback options. | YES |
| playback Deprecated | Playback | playback options. This field is deprecated See playback_v2 | YES |
| input | Input | uploaded video size details. | YES |
| size | integer | video size in bytes. | YES |
| duration | integer | video duration in seconds. | YES |
| ready_to_watch | boolean | video completion flag to show that the video can be streamed. | NO |
| thumbnail | string | video generated thumbnail, captured from 00:00:01.000 timestamp. | YES |
| storage | Storage | video storage details | YES |
| meta | map[string]string | video metadata. | NO |
videos status is an enum with values:
uploaded video has been uploaded to our systems and ready to be processed.
in-progress video processing is triggered and awaiting the worker.
process-failed video process failed for some reason. (see Video Failure)
process-completed video is ready to be watched. (see Playback)
Video status are very important when receiving webhooks events.
This the exact same as Playback but with the following changes:
You can use this link directly in the browser to stream the video.
We prefixed the streaming link with s3:// to indicate that this is a direct link to the video.
We added ?s=AUTH_SIGNATURE to the end of the link to indicate that this link is signed and can be used for a limited time.
Signature is auto generated and can be used indefinitely.
| Field | Type | Description | Nullable |
|---|---|---|---|
| hls | string | direct video streaming url | YES |
| dash | string | direct video streaming url | YES |
| audio | string | direct audio streaming url (AAC) | YES |
| r_1080p | string | direct link for 1080p resolution | YES |
| r_720p | string | direct link for 720p resolution | YES |
| r_480p | string | direct link for 480p resolution | YES |
| r_360p | string | direct link for 360p resolution | YES |
| r_240p | string | direct link for 240p resolution | YES |
Because we are in a transition phase, you will find that some videos have playback_v2 equals null and playback has a value.
This field has been deprecated, please use Playback V2 instead.
| Field | Type | Description | Nullable |
|---|---|---|---|
| hls | string | video hls streaming url | YES |
| dash | string | video dash streaming url | YES |
| audio | string | direct audio streaming url (AAC) | YES |
| r_1080p | string | direct link for 1080p resolution | YES |
| r_720p | string | direct link for 720p resolution | YES |
| r_480p | string | direct link for 480p resolution | YES |
| r_360p | string | direct link for 360p resolution | YES |
| r_240p | string | direct link for 240p resolution | YES |
| Field | Type | Description | Nullable |
|---|---|---|---|
| bucket | string | processed video storage bucket. | NO |
| raw_bucket | string | raw video storage bucket. | NO |
| meta | map[string]string | additional storage metadata | YES |
| Field | Type | Description | Nullable |
|---|---|---|---|
| width | integer | original video width in px. | NO |
| height | integer | original video height in px. | NO |
Video failure is indicated by status process-failed and failure reason can be found in meta.failure.
Example:
{
"downloaded_from" : "https://example.com/dashboard/download/storage/VEc5dVp5QndiMnhzSUhKbGNYVmxjM1J6SUhkcGRHZ2dUR0Z5WVhabGJDNXRjRFE9",
"failure" : "AccessDenied: Access Denied\n\tstatus code: 403, request id: 588945944CC48625:B, host id: btRoYPJTQm8NRBFi3Pc07IkikXlsK7QHfC8XuCI9kN1T5DtP26rg7PIkLgU5GLaeeJ80rjoBgx1K"
}