Skip to navigation
CLOUD PLAYOUT APILoop programs

Create a program

This endpoint creates a program on a Cloud Playout loop channel. A program is an ordered block of content, and a loop channel plays its programs in order and then repeats them for as long as the channel runs.

Programs apply to loop channels only. Creating a program on a schedule channel is rejected, because a schedule channel is built from timed events instead.

How it works

  1. Make a POST request to this endpoint with a name for the program.

  2. The program is created empty and is appended after the channel’s existing programs. Add content to it with the media, live, and playlist endpoints.

  3. The response returns the program, including the duration and mediaCount that FastPix maintains as you add content to it.

A program can be added while the channel is still being set up, and also while it is on air. When the channel is already running, the program is placed so that it does not disturb the item that is currently playing or one that is about to play.

Example

A broadcaster building a 24x7 channel creates a “Morning block” program, then adds the episodes that should play in that part of the loop.

Authentication

AuthorizationBasic

FastPix APIs are secured with Basic Authentication. Use your Access Token ID as the username and Secret Key as the password in the Authorization header of each API request.

  • Username: Access Token ID
  • Password: Secret Key

Activate your FastPix account to generate your API credentials. See the guide here

Path parameters

channelIdstringRequiredformat: "uuid"
The unique identifier of the loop channel the program belongs to.

Request

This endpoint expects an object.
namestringRequired3-25 characters
A name for the program. It must be between 3 and 25 characters and can contain only alphanumeric characters, hyphens, underscores, and spaces.

Response

Program created successfully
successbooleanOptional
Shows the request status. Returns true for success and false for failure.
dataobjectOptional
A program on a Cloud Playout loop channel.