Control Panel — API documentation

Please provide a valid credit card using the credit card form on the billing page. Update Card Details

Embeds

Embed code object Read-only

The Embed endpoint generates embed player code based on a Player object. The types of embed codes are embed, short, and iframe.

Types

Embed: Html div and inline javascript. The content is static and will not be updated when modifying the player object.

Short: Html div and external javascript. The external javascript will embed the current version of a player on each page load.

Iframe: loads the embed code as an Iframe that uses the current version of the player.

Descriptions

code String Autogenerated

Embed code

Sample value:<div id="se_video_12345678-1234-1234-1234-123445678901"></div> <script type="text/javascript" src="//username-player.secdn.net/fulljs/12345678-1234-1234-1234-123445678901.js"></script>

format String Other Required

Embed Type

Enum:embed, short, iframe

Sample value:short

option:related String

Include related object in results

Default:none

Sample value:players

cdn_id Integer Autogenerated

The CDN ID that owns this object.

Sample value:8123

uuid String Autogenerated

Universally Unique Identifier

Sample value:ed6c1e8b-4c13-41dc-b065-34cbffcdc1c7

name String Normal Required

Player Name

Default:

Sample value:My Player Name

app String Normal Required

Application Name

Default:

Sample value:username-origin

stream String Normal

Stream Name

Default:

Sample value:mystreamname

Only for: embed_type: live

play_path String Normal

Path to the Video-on-Demand file

Default:

Sample value:sestore1/username/play_this_file.mp4

Only for: embed_type: vodembed_type: vod-playlist

is_smil Boolean Normal

Multibitrate stream or file

Default:

Sample value:

embed_type String Normal Required

Player Type

Enum:live, vod, vod-playlist

Default:

Sample value:vod

protocol String Normal Required

Player Protocol

Enum:auto, hls, rtmp, dash

Default:

Sample value:hls

player String Normal Required

Player software to use

Enum:clappr, jwplayer

Default:

Sample value:clappr

player_version String Normal Required

Player Version

Default:

Sample value:0.3.8

width Integer Normal

Player Width

Default:0

Sample value:1280

height Integer Normal

Player Height

Default:0

Sample value:720

aspect_ratio String Normal

Player Aspect Ratio

Default:

Sample value:16/9

watermark_image String Normal

Watermark Image

Default:

Sample value:https://my.domain.com/watermark.jpg

watermark_position String Normal

Watermark Position on the Player

Enum:bottom-left, bottom-right, top-left, top-right

Default:top-left

Sample value:bottom-right

watermark_url String Normal

Watermark Link URL

Default:

Sample value:https://my.domain.com/

poster_url String Normal

Poster Image URL

Default:auto

Sample value:https://my.domain.com/poster.jpg

ga_key String Normal

Google Analytics

Default:

Sample value:UA-123456-1

vast_url String Normal

Vast URL

Default:

Sample value:https://path/to/vast.xml

domain_lock String Normal

[Not Implemented]Locks the player to one or more domains

Default:

Sample value:

limit_resolution Boolean Normal

Limits the Resolution to the height and width provided

Default:0

Sample value:1

auto_play Boolean Normal

Start playing when page loads

Default:0

Sample value:0

sevu Boolean Normal

SEVU Enabled

Default:0

Sample value:0

responsive Boolean Normal

Enables response sizing for the Player

Default:0

Sample value:0

Related endpoints

Players

Player settings

Examples

Get the Embeds object with id .

Example URL

https://api.scaleengine.net/v2/embeds/

Example cURL

curl --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://api.scaleengine.net/v2/embeds/

Example request body

None

Example response data

{
    "code": "<div id=\"se_video_12345678-1234-1234-1234-123445678901\"></div>\r\n<script type=\"text/javascript\" src=\"//username-player.secdn.net/fulljs/12345678-1234-1234-1234-123445678901.js\"></script>"
}

This object is read-only and cannot be created.

This object is read-only and cannot be updated.

This object is read-only and cannot be deleted.

Errors

ACCESS_VIOLATION

You do not have access to modify this field