Control Panel — API documentation

Playlist Items

Playlist Item object

The playlist item object defines an individual item on a playlist for a channel. Playlist items cannot be edited directly, but are embedded into the playlist itself. Playlist items are an individual item of content that is scheduled to play in a specific order within the playlist.

Descriptions

id Integer Autogenerated

Unique identifier for this object.

Sample value:N/A

playlist Integer Autogenerated

The playlist this item belongs to

Sample value:N/A

video String Normal Required

The playlist item

String

Sample value:mp4:sestore3/username/directory/filename.mp4

start Integer Normal

How many seconds into this item to start playing

Integer

Default:0

Sample value:0

length Integer Normal

How many seconds to play this item for (-1 = full length)

Integer

Default:-1

Sample value:120

sort_order Integer Normal

The order of the item within the playlist

Integer

Default:0

Sample value:7

is_ad Boolean Normal

Is this video item an advertisement

Boolean

Default:

Sample value:false

option:related String

Include related object in results

Default:none

Sample value:playlists

video String Normal

The playlist item

Sample value:mp4:sestore3/username/directory/filename.mp4

start Integer Normal

How many seconds into this item to start playing

Sample value:0

length Integer Normal

How many seconds to play this item for (-1 = full length)

Sample value:120

sort_order Integer Normal

The order of the item within the playlist

Sample value:7

is_ad Boolean Normal

Is this video item an advertisement

Sample value:false

None

Related endpoints

Playlists

Examples

Get the Playlist_items object with id N/A.

Example URL

https://api.scaleengine.net/v2/playlist_items/N/A

Example cURL

curl --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://api.scaleengine.net/v2/playlist_items/N/A

Example request body

None

Example response data

{
    "id": "N/A",
    "playlist": "N/A",
    "video": "mp4:sestore3/username/directory/filename.mp4",
    "start": "0",
    "length": "120",
    "sort_order": "7",
    "is_ad": "false"
}

Create a new Playlist_items object.

Example URL

https://api.scaleengine.net/v2/playlist_items

Example cURL

curl -X PUT --data-binary @/path/to/request/body --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://api.scaleengine.net/v2/playlist_items

Example request body

{
    "video": "mp4:sestore3/username/directory/filename.mp4",
    "start": "0",
    "length": "120",
    "sort_order": "7",
    "is_ad": "false"
}

Example response data

{
    "id": "N/A",
    "playlist": "N/A",
    "video": "mp4:sestore3/username/directory/filename.mp4",
    "start": "0",
    "length": "120",
    "sort_order": "7",
    "is_ad": "false"
}

Update the Playlist_items object with id N/A.

Example URL

https://api.scaleengine.net/v2/playlist_items/N/A

Example cURL

curl -X POST --data-binary @/path/to/request/body --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://api.scaleengine.net/v2/playlist_items/N/A

Example request body

{
    "video": "mp4:sestore3/username/directory/filename.mp4",
    "start": "0",
    "length": "120",
    "sort_order": "7",
    "is_ad": "false"
}

Example response data

{
    "id": "N/A",
    "playlist": "N/A",
    "video": "mp4:sestore3/username/directory/filename.mp4",
    "start": "0",
    "length": "120",
    "sort_order": "7",
    "is_ad": "false"
}

Delete the Playlist_items object with id N/A.

Example URL

https://api.scaleengine.net/v2/playlist_items/N/A

Example cURL

curl -X DELETE --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://api.scaleengine.net/v2/playlist_items/N/A

Example request body


			
			
Example response data


None


			
				


	








	
Errors





	

			

			
				ACCESS_VIOLATION
			
			
You do not have access to modify this field

		

			

			
				REQUIRED_FIELD
			
			
Missing one or more required fields

		

			

			
				TYPE_MISMATCH
			
			
Data type does not conform to required field type

		

			

			
				MAX_LENGTH_EXCEEDED
			
			
The value exceeded maximum length allowed