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

Options

Name

Type

Value

Required

date_from

String (Datetime)

Y-m-d H:i:s

No

date_toString (Datetime)Y-m-d H:i:sNo
item_idInteger
No
item_titleStringWildcardNo
offsetInteger
No
limitInteger
No
idsArray
No
id_fromInteger
No
id_toInteger
No

Embed url GET parameters: 

NameParameter NameValue
AutoplayautoplayAutoplay player
AutosubtitlesautosubsAutomatically enable subtitles
Start mutedmuteStart player muted
Start timestartTimetime from sec. / random

Example

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

'options' => array(

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

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

'item_id' => '159',

'item_title' => 'filename’

)

);

Response

Response FieldsTypeSample ValueComment
statusCode




Integer00 - success
statusMessage




String""Error or confirmation message
data




Array
Array of {Found channel}s













{Found channel}

0



Array


id


Integer2402Id of the channel

title


String"Channel 1"Title of the channel

use_token


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

url


Array
Array of playback URLs


hls

String
"https://test.cloudycdn.services/slive/ ... /playlist.m3u8"
HLS playback URL


dash

String
"https://test.cloudycdn.services/slive/ ... /manifest.mpd"
DASH playback URL


hds

String
"https://test.cloudycdn.services/slive/ ... /playlist.m3u8"
HDS playback URL

embed_code


String
"<iframe src="//adm ... allowfullscreen></iframe>"
Embed code of channel

responsive_embed_code


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

thumbnail_url


String
URL to channel thumbnail image

placeholder_url


String
"//embeddev.cloudycdn.services/assets/dist/img/default-poster.jpg"
URL to channel placeholder image

manifests


Array
Array of {Channel manifest}s





{Channel manifest}

0

Array



id
Integer445Id of the manifest


name
String"Default"Name of the manifest


default
Integer1If this is default manifest (0 or 1)


url
Array
Array of playback URLs for specific manifest



hlsString
"https://test.cloudycdn.services/slive/ ... /playlist.m3u8"
HLS playback URL for specific manifest



dashString
"https://test.cloudycdn.services/slive/ ... /manifest.mpd"
DASH playback URL for specific manifest

security




Array of channel security information


encryption_method

String"none"Encryption method used for viewing the channel


use_token

Integer0If the channel uses token authentication (0 or 1)


token_duration

String"1d"How long the token lasts


restricted_domains

String"domain.com"If not empty, then file can only be embedded in set domains


ip_blacklist

String"111.111.111.111"If connecting IP is in this list, access will be blocked


ip_whitelist

String"222.222.222.222"If not empty, only these IPs will have access to the channel


allowed_countries

String"EE,LV,LT"Regions that are allowed to access file ("all" gives access to any region)

ads


Array
Array of {ad}s for this channel




{ad}

0

Array



url
String"http://adurl.com"URL to ad VAST


type
String"MID"Type of ad (PRE, MID, POST)


offset
String"00:10:00"Only present if type is MID. Offset of ad insertion in channel from beginning


adsType
String"VAST"Type of ad. "VAST", "VPAID" or "VMAP"
offset




Integer1First response record position
limit




Integer10Max. number of records in the respons
total




Integer1Number of records in response
  • No labels