Skip to main content
Version: v1

Video on Demand (VOD)

The VOD feature enables the transformation of video files into streamable content, providing users with instant access to video.

warning

Only MP4 video files are supported.

To enable VOD, you need to:

  • Create a VOD object, specifying the video source where the video files are stored.
    The source can be a domain or an S3 bucket connected to the CDN.
  • Enable the VOD feature for the created object and wait for the related task to complete.
  • You can track the task status by its ID.
  • Once the VOD feature is activated, the vod_domain field of the previously created VOD object will contain the CDN domain name.
  • Choose an appropriate streaming protocol (HLS, DASH, or MSS) and construct the URL to access the playlists.
info

URL patterns for playlists depending on the selected protocol:

  • HLS: https://{vod_domain}/hls/{filename}/master.m3u8
  • DASH: https://{vod_domain}/dash/{filename}/manifest.mpd
  • MSS: https://{vod_domain}/mss/{filename}/manifest

If an S3 bucket is used as the video source, the URL will also include the bucket name:

  • HLS: https://{vod_domain}/hls/{bucket_name}/{filename}/master.m3u8
  • DASH: https://{vod_domain}/dash/{bucket_name}/{filename}/manifest.mpd
  • MSS: https://{vod_domain}/mss/{bucket_name}/{filename}/manifest

The VOD object contains information about the video source, the status of the VOD feature, and data for accessing the video.

vod Object

ParameterTypeDescription
idintegerVOD object ID
vod_domainstringDomain name for VOD
source_typestringType of video source
source_idintegerVideo source ID
is_activebooleanVOD feature status