Page tree
Skip to end of metadata
Go to start of metadata

Options

Name

Data Type

Value

Required

Comment

date_from

String (Datetime)

Y-m-d H:i:s

No


date_toString (Datetime)Y-m-d H:i:sNo
item_idInteger
No
idsArray of integers
NoFilter of system id
id_fromInteger
No

Range fields from system id

id_toInteger
No
item_asset_idString / array of strings
No
cat_idInteger
NoCategory id
item_titleString
NoItem title (Wildcard)
item_statusString / array of strings


{List of available values listed in 'Media status list'}


No

default values: array("play multi", "play single")

optional can get "all"

offsetInteger
No
limitInteger
No

Media status list

statusstatus_name
ingestedingested
ingestingingesting
playableplay single
validatevalidate
validatingvalidating
validatedvalidated
approvedtranscode
processingtranscoding
processedplay multi
prioritypriority
errorerror
warningwarning

status_name is NOT an alternative name for status. One media asset can have different status than status_name.

For example, a media asset is playable, but encountered an error it could have 'status' => 'playable', but 'status_name' => 'error' 


Example request

$data = array('object' => 'media', 'action' => 'list',

'options' => array(

'date_from' => '2016-05-24 20:00:00',

'date_to' => '2016-06-24 20:00:00',

'item_id' => '234',

'item_asset_id' => 'test_id',

'item_title' => 'filename’

'item_status' => 'playable'

)

);

Response

Response FieldsData TypeSample ValueComment
statusCode




Integer00 - success
statusMessage




String""Error or confirmation message
data




Array
Array of {Media asset}s
{Media asset}0



Array


id


Integer123System ID of the asset

title


String"Movie"Asset title

asset_id


String"45678_43"Asset ID set by customer

cat_id


Integer321Category ID. To obtain the list use function Category: List

category


String"Movies\Horror"Category full name and path in the category tree

video_ln


String""Video track language (if any)

audio_ln


String"eng,deu,fra"Audio tracks languages

sub_ln


String"eng,deu,fra"Subtitle tracks languages

use_token


Integer0Whether token will be added to URL in embed. (0 or 1)

token_duration


String"1h"Token validity duration

status_name


String"Play Multi"Asset status - visual name

status


String"playable"Asset status - internal name

allowed_embed_hosts


String"www.domain.com"Hosts where embedding is allowed

allowed_regions


String"US,GB,DE"Regions where content is allowed

ip_whitelist


String"1.2.3.4,5.6.7.8"Allowed IP address list

ip_blacklist


String"4.3.2.1,8.7.6.5"Blacklisted IP addresses

duration


String"00:10:00"Asset duration (H:i:s)

url


Array
Direct playback URLs


hls

String"https:\/\/...\/playlist.m3u8"


dash

String"https:\/\/...\/manifest.mpd"


hds

String"https:\/\/...\/manifest.f4m"

manifests


Array
Array of media manifests


source

Array
Array of defined source manifests ({Source manifest})







{Source manifest}



0
Array




idInteger234Manifest ID



nameString"Source manifest"Manifest name



start_timeInteger0Fragment start time



end_timeInteger0Fragment end time



defaultInteger0This is default manifest (0 or 1)



embed_codeString"[iframe src=\"\/\/...\" width=\"1024\" height=\"576\"><\/iframe>"Embed code of manifest



responsive_embed_codeString
"<div style= ... <iframe ... ></iframe></div>"
Responsive embed code of manifest



hlsString"https:\/\/...\/playlist.m3u8"Direct playback HLS URL of manifest



dashString"https:\/\/...\/manifest.mpd"Direct playback DASH URL of manifest



hdsString"https:\/\/...\/manifest.f4m"Direct playback HDS URL of manifest


transcode

Array
Array of defined transcode manifests({Transcode manifest})







{Transcode manifest}



0
Array




idInteger235Manifest ID



nameString"Default manifest"Manifest name



start_timeInteger0Fragment start time



end_timeInteger0Fragment end time



defaultInteger1This is default manifest (0 or 1)



embed_codeString"<iframe src=\"\/\/..." width=\"1024\" height=\"576\"><\/iframe>"Embed code of manifest



responsive_embed_codeString
"<div style= ... <iframe ... ></iframe></div>"
Responsive embed code of manifest



hlsString"https:\/\/...\/playlist.m3u8"Direct playback HLS URL of manifest



dashString"https:\/\/...\/manifest.mpd"Direct playback DASH URL of manifest



hdsString"https:\/\/...\/manifest.f4m"Direct playback HDS URL of manifest

sources


Array
Array of source files ({Source file})






{Source file}








0

Array



id
Integer1234Source file ID


name
String"movie.mp4"Source file name


link
String"\/\/download.cloudycdn.services\/..."Download URL (need to add token)


extension
String"mp4"Source file extension


type
String"video"File type


bitrate
Integer30000Bitrate


duration
String"00:10:00"File duration (H:i:s)


language
String"eng"File language

transcodes


Array
Array of transcoded files ({Transcoded files})






{Transcoded files}


0

Array



id
Intger3456Transcoded file ID


name
String"movie_mp4_ikzdddj3_mp4"Transcoded file name


link
String"\/\/download.cloudycdn.services\/..."Download URL (need to add token)


extension
String"mp4"Transcoded file extension


type
String"video"File type


bitrate
Integer600Bitrate


duration
String"00:10:00"File duration (H:i:s)


language
String"lav"File language

embed_url


String"\/\/embed.cloudycdn.services\/..."Embed code URL (src field from iframe without params)

embed_code


String"<iframe src=\"\/\/...\" width=\"1024\" height=\"576\"><\/iframe>"Embed code

responsive_embed_code


String
"<div style= ... <iframe ... ></iframe></div>"
Responsive embed code

public_url


String"\/\/embed.cloudycdn.services\/...\/public\/"Public URL

tags


Array
Array of transcoded files ({Tags})
{Tag}
0

Array




tag
String"Horror"Name of the tag



color
String"#000000"Hex representation of the color



class
String"tag-hued-light"

Special class of the tag. Returns null or a string of class.

"tag-hued-light" when the background is so dark, that light text should be used on top.




rgb_value
String"rgba(0,0,0,1)"RGBA representation of the color

created_at


String"2019-10-03T06:35:33.000000Z"Asset creation date and time

updated_at


String"2019-10-03T06:35:33.000000Z"Asset last update date and time

thumbnail_url


String"\/\/embed.cloudycdn.services\/...\/out10.jpg"

URL of thumbnail image


placeholder_url


String"\/\/embed.cloudycdn.services\/...\/default-poster.jpg"URL of placeholder image
offset




Integer1First response record position
limit




Integer10Max. number of records in the respons
total




Integer1Number of records in response



  • No labels