Control Panel — API documentation

Thumbnails

Bifs object

Used to create, show, and delete thumbnail files for a given VOD file. When called with the path to an MP4 file, it will operate on a thumbnail that corresponds to that video.

A thumbnail can be created with the create method or the update method, the create method will not do anything if a thumbnail already exists, the update method will create a thumbnail regardless of whether one already exists.

A fetch will show some information on the thumbnail file. To see details about the file in storage itself, use the files endpoint. See the files page for more information.

Delete will remove a thumbnail for a video file. It is also possible to delete the thumbnail directly using the files endpoint, for cases such as if the video file has been moved or deleted.

Descriptions

path String Immutable

Path to the VOD item the thumbnail is for

String

Sample value:/recordings/my-vod.mp4

thumbnail_path String Synthetic

File path to the thumbnail, for use with files endpoint

Sample value:/recordings/my-vod.jpg

frame_size Integer Normal

Size of the thumbnail, in pixels of height

Range:64 - 1080

Default:480

Sample value:240

option:related String

Include related object in results

Default:none

Sample value:file

None

Related endpoints

File

List files in storage

Examples

Get the Thumbnails object with id recordings/my-vod.mp4.

Example URL

https://jb-sestore.secdn.net/dev/v1/thumbnails/recordings/my-vod.mp4

Example cURL

curl --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://jb-sestore.secdn.net/dev/v1/thumbnails/recordings/my-vod.mp4

Example request body

None

Example response data

{
    "path": "/recordings/my-vod.mp4",
    "thumbnail_path": "/recordings/my-vod.jpg",
    "frame_size": "240"
}

Create a new Thumbnails object.

Example URL

https://jb-sestore.secdn.net/dev/v1/thumbnails

Example cURL

curl -X PUT --data-binary @/path/to/request/body --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://jb-sestore.secdn.net/dev/v1/thumbnails

Example request body

{
    "path": "/recordings/my-vod.mp4",
    "frame_size": "240"
}

Example response data

{
    "path": "/recordings/my-vod.mp4",
    "thumbnail_path": "/recordings/my-vod.jpg",
    "frame_size": "240"
}

Update the Thumbnails object with id recordings/my-vod.mp4.

Example URL

https://jb-sestore.secdn.net/dev/v1/thumbnails/recordings/my-vod.mp4

Example cURL

curl -X POST --data-binary @/path/to/request/body --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://jb-sestore.secdn.net/dev/v1/thumbnails/recordings/my-vod.mp4

Example request body

{
    "frame_size": "240"
}

Example response data

{
    "path": "/recordings/my-vod.mp4",
    "thumbnail_path": "/recordings/my-vod.jpg",
    "frame_size": "240"
}

Delete the Thumbnails object with id recordings/my-vod.mp4.

Example URL

https://jb-sestore.secdn.net/dev/v1/thumbnails/recordings/my-vod.mp4

Example cURL

curl -X DELETE --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://jb-sestore.secdn.net/dev/v1/thumbnails/recordings/my-vod.mp4

Example request body


			
			
Example response data


None


			
				


	








	
Errors





	

			

			
				ACCESS_VIOLATION
			
			
You do not have access to modify this field

		

			

			
				TYPE_MISMATCH
			
			
Data type does not conform to required field type

		

			

			
				MAX_LENGTH_EXCEEDED
			
			
The value exceeded maximum length allowed

		

			

			
				INVALID_RANGE
			
			
The value must be between the predefined range