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

Parameters

Name

Sub-array name

Type

Value

Required

asset_id

String
Yes
cat_id

Integer


No

title

String
No
description

String
No
pg_rating

String
No
thumbnail_img

Array


No


protocol
Stringhttp / https / ftp / s3No

host
String
No

path
String
No

username
String
No

password
String
No
embed

Array
No

protocol
Stringhttp / httpsNo

player_type
Stringregular / VRNo

stream_protocol
Stringhls / dashNo

aspect_ratio
String4:3 / 5:4 / 16:9 / 21:9 / 2:1No

player_width
Integer
No

autoplay
Integer1 / 0 No

mute
Integer1 / 0 No

start_time
Integer
No

start_random
Integer1 / 0 No

enable_public
Integer1 / 0 No

autosubs
Integer1 / 0No
placeholder_img

Array
No

generate_from_media
Integer1 / 0No

protocol
Stringhttp/ https/ ftp/ s3No

host
String
No

path
String
No

username
String
No

password
String
No
playbutton_img

Array
No

protocol
Stringhttp/ https/ ftp/ s3No

host
String
No

path
String
No

username
String
No

password
String
No
logo_img

Array
No

protocol
Stringhttp/ https/ ftp/ s3No

host
String
No

path
String
No

username
String
No

password
String
No
player

Array
No

hide_options
Integer1 / 0No

hide_volume
Integer1 / 0No

hide_subtitles
Integer1 / 0No

hide_progress_bar
Integer1 / 0No

hide_bg_image
Integer1 / 0No

hide_play_button
Integer1 / 0No

hide_timeline
Integer1 / 0No

hide_fullscreen
Integer1 / 0No

use_facebook
Integer1 / 0No

use_twitter
Integer1 / 0No

use_linkedin
Integer1 / 0No

subtitle_color
String
No

subtitle_bgcolor
String
No

subtitle_font
String
  • 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

loop
Integer1 / 0No

preload_content
Integer1 / 0No
assets

Array
Yes

0


Yes


protocolString
Yes


hostString
Yes


pathString
Yes


usernameString
No


passwordString
No


bitrateInteger
No


langStringISO 639 2 or 3 letter codeNo
ads

Array
No

0
Array
No


urlString
Yes


typeStringpre / mid / postYes


adsTypeStringVAST / VPAID / VMAPYes


offsetStringif mid ( % or time hh:mm:ss)Yes
ads_interval

Integer1 / 0No
ads_block

Integer1 / 0No
security

Array
No


encryption_methodStringdrm / aes / drmaes / noneNo


expire_timeString (Datetime)Y-m-d H:i:sNo


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
published

Integer1 / 0No
callback

Array
No

url
Stringif contains SYSTEM_ID or ASSET_ID, then will be replaced with system valuesYes

action
Stringget / postYes

Example

$data = array('object' => 'media', 'action' => 'upload', 'parameters' => array(

    array(

        'assset_id' => 'Some_asset_id',

        'title' => 'Video 20180417 03',

        'cat_id' => 1498,

        'transcode_preset_id' => 33,

        'auto_transcode' => 1,

        'embed' => array(

            'protocol' => 'https',

            'player_type' => 'VR',

            'stream_protocol' => 'dash',

            'aspect_ratio' => '21:9',

            'player_width' => 1280,

            'autoplay' => 0,

            'mute' => 1,

            'start_time' => 0,

            'start_random' => 1,

            'enable_public' => 0,

            'autosubs' => 0

        ),

        'placeholder_img' => array(

            'generate_from_media' => 1,

            'protocol' => 'ftp',

            'host' => 'ftp.ams.128BE.teliasoneracdn.net',

            'path' => '/',

            'username' => 'user',

            'password' => 'pwd'

        ),

        'player' => array(

            'hide_options' => 1,

            'hide_volume' => 1,

            'hide_subtitles' => 1,

            'hide_progress_bar' => 1,

            'hide_bgimage' => 1,

            'hide_play_button' => 1,

            'hide_timeline' => 1,

            'hide_fullscreen' => 1,

            'use_facebook' => 1,

            'use_twitter' => 1,

            'use_linkedin' => 1,

            'subtitle_color' => '#444222',

            'subtitle_bgcolor' => '#FFFFFF',

            'subtitle_font' => 'Arial',

            'loop' => 1

        ),

        'assets' => array(

            array(

                'protocol' => 'http',

                'host' => 'techslides.com',

                'path' => '/demos/sample-videos/small.mp4',

                'username' => '',

                'password' => ''

            ),

            array(

                'protocol' => 'ftp',

                'host' => 'ftp.telia.lv',

                'path' => '/somefolder/file.jpg',

                'username' => 'user',

                'password' => 'pwd'

            )

        ),

        'ads' => array(

            array(

                'url' => '//b.adbox.lv/emiter/bx_vast.js?id=vid_mid&consumer=84195a670bdd3b335&lang=lv',

                'type' => 'mid',

                'offset' => '50%'

            )

        ),

        'security' => array(

            'encryption_method' => 'drmaes',

            'expire_time' => '2018-05-01 00:00:00',

            'use_token' => 1,

            'token_duration' => '1h',

            'allowed_embed_hosts' => 'www.telia.lv',

            'ip_blacklist' => '10.1.1.1',

            'ip_whitelist' => '10.2.2.2',

            'allowed_countries' => array('LV','EE','LT','PL')

        ),

        'callback' => array(

            "url" => "http://www.telia.lv/?telia_system_media_id=SYSTEM_ID&telia_system_asset_id=ASSET_ID",

            "action" => "get"

        )

    )

);

Response

Response FieldsTypeSample ValueComment
statusCode


Integer00 - Success
statusMessage


String"Items saved for upload"Error or confirmation message
data


Array
Array of responses for ingested {Media asset}s




{Media asset}


0

Array


statusCode
Integer00 - Success

statusMessage
String"Item saved for upload"Error or confirmation message

data
Array



idInteger111System ID for the new media
  • No labels