Skip to content
CF MEDIA

Start address

Everything starts with your server’s /cfmedia/start.json file. That is what CF media looks for when the user types the address.

How the address becomes a URL

The user typesThe app fetches
yourhost.comhttp://yourhost.com/cfmedia/start.json
192.168.0.10:8080http://192.168.0.10:8080/cfmedia/start.json
https://yourhost.com or the https lock turned onhttps://yourhost.com/cfmedia/start.json
yourhost.com/folder/start.jsonthe .json file given

The start.json file

cfmedia/start.json
{
  "name": "My Media",
  "version": "1.0.0",
  "parameter": "menu:{PREFIX}{SERVER}/cfmedia/menu.json",
  "launcher": { "icon": "perm_media" }
}
FieldRequiredDescription
namecheck_circleYesName shown on the confirmation and splash screens
versionVersion of your content (informational)
parametercheck_circleYesWhat to open (see below)
launcher.iconIcon (Material Icons) for the confirmation and splash screens
launcher.imageImage (URL) instead of the icon: your service’s logo
tips_and_updates
The app fetches start.json again every time it opens: changes on your server arrive by themselves. Without internet, it uses the last copy it received.

The parameter

ValueWhat it does
menu:URLOpens a menu (side menu + pages)
content:URLOpens a content page, without a menu
redirect:URLReads another start.json and uses its parameter (up to 4 redirects)
any actionRuns it directly. Example: video:http://{SERVER}/media/welcome.mp4 plays a video

Variables

The app replaces these words in any URL in your pages:

VariableBecomesExample
{SERVER}The address typed (with port)192.168.0.10:8080
{PREFIX}http:// or https://, according to the lockhttp://
{PLATFORM}Where the app runsandroid, web, tizen, webos
{LANGUAGE}Language chosen in the apppt-BR, en…
{WIDTH} / {HEIGHT}Actual screen size, in pixels1920 / 1080
{CLIENT}App identificationcfmedia
{PLAYER}Player usedhtml5
{HOST}, {SECURE}Where the launcher itself is (advanced use)—
{ID}Always empty: CF media does not give any device identifier to servers