video_entityis created every time a video is uploaded to Uiza via a URL which redirects Uiza to your video storage to retrieve the video file. This URL could be either a direct HTTP/HTTPS link or a URL that leads to your FTP or S3 storage.
idstringThe unique identifier for the video entity.
namestringThe name of your video entity.
descriptionstringDescribes the content of the video entity. Often useful for displaying to viewers.
short_descriptionstringA shortened version of your
viewnumberThe number of times that the video has been viewed.
posterstringThe URL of the video entity's poster image.
thumbnailstringThe URL of the video entity's thumbnail image.
input_typestringIt could be either
dvrindicates that your
video_entitywas created from a live record, and
s3-uizaindicates it was created by a user uploading a VOD through the Uiza dashboard.
durationnumberThe duration of your video entity in seconds. It is measured up to one millionth of a second.
publish_to_cdnstringThe status indicates whether your video entity had been published to Uiza's CDN or not. There are 4 possible statuses:
not-readyis returned when Uiza receives no request to publish the video entity yet.
queueis returned when your video entity is in the queue to be published.
successis returned when your video entity has been successfully published and your viewers are able to watch the video.
failedis returned when something goes wrong during the publishing process of your video entity.
playbackobjectContains the playback URL for different streaming protocols including HLS fMP4 (
hls), HLS ts (
hls_ts) and MPEG-dash (
mpd). Use this URL to configure your player to play the video.