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
thumbnail_img

Array


No


protocolStringhttp / https / ftp / s3No

hostString
No

pathString
No

usernameString
No

passwordString
No
embed
Array
No

protocolStringhttp / httpsNo

player_typeStringregular / VRNo

stream_protocolStringhls / dashNo

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

player_widthInteger
No

autoplayInteger1 / 0 No

muteInteger1 / 0 No

start_timeInteger
No

start_randomInteger1 / 0 No

enable_publicInteger1 / 0 No

autosubsInteger1 / 0No
placeholder_img
Array
No

generate_from_mediaInteger1 / 0No

protocolStringhttp/ https/ ftp/ s3No

hostString
No

pathString
No

usernameString
No

passwordString
No
playbutton_img
Array
No

protocolStringhttp/ https/ ftp/ s3No

hostString
No

pathString
No

usernameString
No

passwordString
No
logo_img
Array
No

protocolStringhttp/ https/ ftp/ s3No

hostString
No

pathString
No

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
Yes

protocolString
Yes

hostString
Yes

pathString
Yes

usernameString
No

passwordString
No

bitrateInteger
No

langStringISO 639-2 CodeNo
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_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
callback
Array
No

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

actionStringget / 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
statusCodeInteger00 - Success
statusMessageString"Items saved for upload"Error or confirmation message
  • No labels