.png){kind=logo}
Video object
- Print
Video object
- Print
Article summary
Did you find this summary helpful?
Thank you for your feedback
Video object
Property name | Type | Description |
|---|---|---|
videoId | Long! | Automatically generated identifier of the video. (numeric) |
customerVideoId | String? | Customer's video ID and must be unique(defined by the customer) |
title | String! | Title of the video. max. 255 characters. |
description | String? | Description of the video. max. 65535 characters. |
tags | List? | Tag of the video. max 10 tags |
fileName | String! | Original filename when the video was uploaded. |
width | Integer! | Width of the video in pixels. |
height | Integer! | Height of the video in pixels. |
filesize | Long! | File size of the video in bytes. |
videoSourceUrl | String! | Uploaded file URL of the video. |
thumbnailImageUrl | String? | Thumbnail image URL of the video. If not specified, Shoplive automatically generates a thumbnail image URL when creating a video. |
vodStreamUrl | String? | Automatic quality HLS(m3u8) replay video URL. |
vodStreamUrls | Map? | All HLS(m3u8) video URLs to selectively retrieve m3u8 url for specific purpose (ei. preview ) |
duration | Long! | Length of the video in milliseconds. |
uploadProgress | Integer! | Upload progress of the video. (0-100) It will be 100(%) when all transcoding is finished. |
createdAt | String! | Created DateTime when the video is created (format: |
updatedAt | String! | Updated DateTime when the video is created (format: |
Sample
{
"videoId": "100",
"customerVideoId": "SHOPLIVE_VIDEO_1",
"title": "Shoplive Introduction Video",
"description": "Introduction video description",
"tags": ["interstitial","cocacola","cpg","test"],
"width": 720,
"height": 1280,
"filesize": "38128539",
"videoSourceUrl": "https://resource.shoplive.cloud/videos/vod/archive/{accessKey}/{streamKey}.mp4",
"thumbnailImageUrl": "https://image.shoplive.cloud/{streamKey}.jpg",
"vodStreamUrl": "https://api.shoplive.cloud/v1/videos/{accessKey}/rt_1240.m3u8",
"vodStreamUrls": {
"320p": "https://api.shoplive.cloud/v1/videos/uv9CGthPzlvsInZerCw0/rt_2259/320p.m3u8?service=pre-campaign&_ci=1&vid=2259&ak=uv9CGthPzlvsInZerCw0&stream_key=1-1MCtBgefTymPFcc-an2&source=video",
"480p": "https://api.shoplive.cloud/v1/videos/uv9CGthPzlvsInZerCw0/rt_2259/480p.m3u8?service=pre-campaign&_ci=1&vid=2259&ak=uv9CGthPzlvsInZerCw0&stream_key=1-1MCtBgefTymPFcc-an2&source=video",
"720p": "https://api.shoplive.cloud/v1/videos/uv9CGthPzlvsInZerCw0/rt_2259/720p.m3u8?service=pre-campaign&_ci=1&vid=2259&ak=uv9CGthPzlvsInZerCw0&stream_key=1-1MCtBgefTymPFcc-an2&source=video"
},
"duration": 202000,
"uploadProgress": 100,
"createdAt": "2022-12-09T09:17:04Z",
"updatedAt": "2022-12-09T09:23:15Z"
}