Schedule

By schedule control, you can implement time-based limitation for your VODs, simulives, and Live-to-VODs replays, ensuring content availability aligns with your scheduling requirements (e.g. specific timeframes or special campaigns).

To enable schedule control and define allowed access times for your content, configure the associated API request body during creation or update it later.

VOD

• Create: POST /bv/cms/v1/vods

• Update: PUT /bv/cms/v1/vods/:id

Configure the schedule request body with the following options:

Query Parameters	Description
enabled	true
start_time	Specify the time when the content will become available in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
end_time	Specify the time when the content will no longer be available in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ

Here is an example of a request body that schedules a video for playback from August 24th, 2023 at 2:15:22 PM UTC to August 31st, 2023 at 2:15:22 PM UTC:

"schedule":{
  "enable":true,
  "start_time":"2023-08-24T14:15:22Z",
  "end_time":"2023-08-31T14:15:22Z"
}

Simulive

When the livestream type is LIVE_TYPE_SIMULIVE, you can schedule its start time:

• Create: POST /bv/cms/v1/lives

• Update: PUT /bv/cms/v1/lives/:id

Configure the scheduled_at request body with the following options:

Query Parameters	Description
scheduled_at	Specify the time when the content will become available in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ

Live-to-VOD

When the live_vod is defined, you can schedule its start time and end time:

• Create: POST /bv/cms/v1/lives

• Update: PUT /bv/cms/v1/lives/:id

Configure the live_vod request body with the following options:

Query Parameters	Description
started_at	Specify the time when the content will become available in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
ended_at	Specify the time when the content will no longer be available in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ

caution

Before the scheduled start or end time is reached, you can edit them using the update API. However, after that point, they will become uneditable.

info

The time zone is automatically detected and set to the local time zone of the user's location. This means that if a user is located in a different time zone than the server, the start_time and end_time will be automatically adjusted to match the user's local time zone.