Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: - Added preload_content

...

Name

Sub-array nameSub-sub-array name

Type

Value

Required

system_id

String
Yes
cat_id

Integer

number

No

title

String
No
thumbnail_img

Array


No


protocol
Stringhttp / https / ftp / s3Yes

host
String
Yes

path
String
Yes

username
String
No

password
String
No
embed

Array
No

protocol
Stringhttp / httpsYes

player_type
Stringregular / VRYes

stream_protocol
Stringhls / dashYes

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

player_width
Integer
Yes

autoplay
Integer1 / 0 No

mute
Integer1 / 0 No

start_time
IntegernumberNo

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 / s3Yes

host
String
Yes

path
String
Yes

username
String
No

password
String
No
playbutton_img

Array
No

protocol
Stringhttp / https / ftp / s3Yes

host
String
Yes

path
String
Yes

username
String
No

password
String
No
logo_img

Array
No

protocol
Stringhttp / https / ftp / s3Yes

host
String
Yes

path
String
Yes

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 (of {asset}s)
No

0
Array
No





{asset}

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 (of {ad}s)
No

0
Array
No


{ad}

urlString
Yes

typeStringpre / mid / postYes

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

Array
No

expire_time
Datetime
No

token_duration
String1h / 3h / 6h / 12h / 1d / 1w / 2w / 1mNo

allowed_embed_hosts
String
No

ip_blacklist
String
No

ip_whitelist
String
No

allowed_countries
ArrayISO 3166-1 alpha-2 standard https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2No
transcode_preset_id

Integer
No
auto_transcode

Integer1 / 0No

...