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

Parameters

Name

Sub-array name

Type

Value

Required

system_id
String
Yes
cat_id

Integer

number

No

title
String
No
thumbnail_img

Array


No


protocolStringhttp / https / ftp / s3Yes

hostString
Yes

pathString
Yes

usernameString
No

passwordString
No
embed
Array
No

protocolStringhttp / httpsYes

player_typeStringregular / VRYes

stream_protocolStringhls / dashYes

aspect_ratioString4:3 / 5:4 / 16:9 / 21:9 / 2:1Yes

player_widthInteger
Yes

autoplayInteger1 / 0 No

muteInteger1 / 0 No

start_timeIntegernumberNo

start_randomInteger1 / 0 No

enable_publicInteger1 / 0 No

autosubsInteger1 / 0No
placeholder_img
Array
No

generate_from_mediaInteger1 / 0No

protocolStringhttp / https / ftp / s3Yes

hostString
Yes

pathString
Yes

usernameString
No

passwordString
No
playbutton_img
Array
No

protocolStringhttp / https / ftp / s3Yes

hostString
Yes

pathString
Yes

usernameString
No

passwordString
No
logo_img
Array
No

protocolStringhttp / https / ftp / s3Yes

hostString
Yes

pathString
Yes

usernameString
No

passwordString
No
player
Array
No

hide_optionsInteger1 / 0No

hide_volumeInteger1 / 0No

hide_subtitlesInteger1 / 0No

hide_progress_barInteger1 / 0No

hide_bg_imageInteger1 / 0No

hide_play_buttonInteger1 / 0No

hide_timelineInteger1 / 0No

hide_fullscreenInteger1 / 0No

use_facebookInteger1 / 0No

use_twitterInteger1 / 0No

use_linkedinInteger1 / 0No

subtitle_colorString
No

subtitle_bgcolorString
No

subtitle_fontString
  • Arial, Helvetica, sans-serif
  • 'Times New Roman', Times, serif
  • 'Courier New', Courier, monospace
  • Verdana, Geneva, sans-serif
  • Georgia, 'Times New Roman', Times, serif
  • 'Palatino Linotype', 'Book Antiqua', Palatino, serif
  • 'Comic Sans MS', Textile, cursive
  • 'Trebuchet MS', Helvetica, sans-serif
  • 'Arial Black', Gadget, sans-serif
  • Impact, Charcoal, sans-serif
No

loopInteger1 / 0No
assets
Array
No

protocolString
Yes

hostString
Yes

pathString
Yes

usernameString
No

passwordString
No

bitrateInteger
No

langStringISO 639-2 standard https://en.wikipedia.org/wiki/ISO_639-2No
ads
Array
No

urlString
Yes

typeStringpre / mid / postYes

offsetStringif mid ( % or time hh:mm:ss)Yes
security
Array
No

encryption_methodStringdrm / aes / drmaes / noneNo

expire_timeDatetime
No

use_tokenInteger1 / 0No

token_durationString1h / 3h / 6h / 12h / 1d / 1w / 2w / 1mNo

allowed_embed_hostsString
No

ip_blacklistString
No

ip_whitelistString
No

allowed_countriesArrayISO 3166-1 alpha-2 standard https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2No
transcode_preset_id
Integer
No
auto_transcode
Integer1 / 0No

Parameters can directly contain the parameters array OR it can contain an array of parameter arrays to update multiple media with one call.

Example

$data = array('object' => 'media', 'action' => 'update', 'parameters' => array(
    'system_id' => '353456',
    'title' => 'New title',
    'embed' => array(
        'stream_protocol' => 'dash',
        'aspect_ratio' => '21:9',
        'start_random' => 1,
        'enable_public' => 0,
    )
);

$data = array('object' => 'media', 'action' => 'update', 'parameters' => array(
    array(
        'system_id' => '353456',
        'title' => 'New title1',
        'embed' => array(
            'stream_protocol' => 'dash',
            'aspect_ratio' => '21:9',
            'start_random' => 1,
            'enable_public' => 0,
        )
    ),
    array(
        'system_id' => '353457',
        'title' => 'New title2',
        'embed' => array(
            'stream_protocol' => 'dash',
            'aspect_ratio' => '21:9',
            'start_random' => 1,
            'enable_public' => 0,
        )
    )
);

Response

Response FieldsTypeSample ValueComment
statusCodeInteger00 - Success
statusMessageString

"Items saved for asset update"

Error or confirmation message




  • No labels