Version API #3
Avaliable for firmwares version linux-qt 4.0.11 or higher.
Some new methods are avaliable in API #2 mode for firmwares 3.9.x or higher.

Set-top-boxes TVIP display Web-content using WebKit engine.

JavaScript API in Set-top-boxes Tvip is based on the following main objects:

• window.TvipStb contains basic methods for operating with hardware;
• window.TvipPlayer contains methods for control mediaplayer;
• window.TvipRecorder contains methods for recorder control;
• window.TvipEvent contains callback methods;

Objects do not require an explicit creation or any initialization and is accessible from any Web-page that is open in STB browser.

• Subtitles support.
• CAS/DRM support.
• Deviceid support.
• UDP proxy and web-proxy setup.

Add or change mount point with indicated id. If temp equal false, then mount point will be saved after device reload, if true - then mount point will be deleted after reload or application restart.The possible mount points types (type): 1 - SMB, 2 - NFS. Point name at mount system (for example, at pop-up message): name. Parameter options set specific options as object:

SMB:

{
  "address": <address>,
  "folder": <folder>,
  "username": <username>,
  "password": <password>
}

Here, <address> - IP-adress, domain or NetBIOS-server name, <folder> - name of sharing content, <username> и <password> - optional authorization credentials.

NFS:

{
  "address": <address>,
  "folder": <folder>
}

Here, <address> - IP-adress or domain server name, <folder> - full path to sharing catalog.

Enable CAS/DRM support for media streams that played from current portal. CAS/DRM type is specified be name. CAS/DRM specific options are taken from key-value options object.

Enable/disable spatial navigation for current web portal. It means keyboard navigation over buttons and links.

Returns API version.

Returns id of currently active interface language ('en', 'ru').

Returns currently time zone (for example, Europe/Moscow).

Returns device model indetifier (like s410).

Returns current display mode (“1080i”, “1080p”, “720p”, “576i”, etc).

Returns directory list in a specified directory.

[ "Dir1", "Dir2", "Dir3" ]

Returns file objects list in a specified directory directory. Object contains file name and file size.

[
  {
    "name": "file1",
    "size": 1234567
  },
  
  {
    "name" : "file2",
    "size" : 44444
  }
]

name -file name, size - file size in bytes.

Gets variable from the browser store. If name not found, empty string returns.

Returns main MAC address as string. Usually it's Ethernet interface MAC.

Returns windows network workgroup list. Example:

['WORKGOUP', 'MYGROUP']

Performs servers search in specified group network group and returns NetBIOS server names
Example:

['MYPC', 'USER2']

Returns names of available network shares by NetBIOS or IP address defined by server parameter. Example:

['shared folder', 'Downloads']

Returns true, if device was transferred to Sleep/StandBy with setStandBy command. Returns false otherwise. Only for “Whole system” mode.

Returns all mounted devices (local and network)

[
 {
   "label": <label>,
   "path" : <ospath>,
   "fstype" : <file_system>,
   "writable": <writable>,
   "status": <status>,
   "size": <size>,
   "free" <free>
 },

]

Object fields:
label - Resource name(label) visible to user;
path - mount point
fstype - FS type (e.g. vfat, ntfs, ext2, ext3, nfs, cifs;
writable - write access (“1” - yes, “0” - no);
status - mount point status (“0” - need mount, “1” - mount in progress, “2” - mount successfully, “3” - mount error, “4” - umount in progress, “5” - unmounted, “6” - umount error),
size - FS size,
free - Available free space.

Returns UDP proxy settings, specified in preferences.

Returns security (parental control) code, specified in security preferences. If Security is disabled, returns empty value.

Returns true, if directory osPath exists. Otherwise returns false.

Returns true, if file (not directory) with defined name osPath exists, false otherwise.

Removes file in path. Only works for allowed directories.

Launches system preferences Tvip.

Launch Web browser and open page from url. If browser is exited, portal from backUrl will be loaded.

Outputs debugging message to terminal(Linux) or logcat(Android).

Reboots system.

Removes mount point from mount manager. id - Mount point identifier

Setups UI color that could be consider as transparent for video layer. color in RGB model.

Defines HTTP-header for browser. header - header name, value - header value. If value is empty, previously defined header will be purged.

Saves variable in browsers persistent storage. All variables are available for all browser pages.

Setups filename filter for getDirectoryFiles and getDirectoryDirs. | Will be count as delimiter.
? and * applicable as well.
e.g. *.avi|*.mp3

If enabled=true, Cursor key press(on remote) event will be pass to Java Script directly, instead of default virtual keyboard handler.

If enabled==true, Remote “Menu” button press event will be pass to JS, instead of Tvip menu call.

If enabled==true, remote press “S.INFO” event will be passed to JS, instead of Tvip system info call.

If enabled==true, remote press “Settings” will be passed to JS, instead of Tvip settings menu call.

Switches STB in sleep mode (enabled==true) or return it to operation mode (enabled==false). Only for “Whole system” mode.

Sets Web-proxy server address for using with current portal. All following http requests will be made over this proxy. Params: proxy - proxy server address, exclude - array with web-servers, that should not go over proxy (IP subnet or domain).

Virtual keyboard show (show=true) or hide (show=false).

Resets settings:
transparent color;
HTTP-header;
file filter.

Resets playback. If we don't need playback after page change this routine should be called.

Starts playback defined URL(local path also welcome).

Parameter mode can be:

vod - URL contains VOD-file (with final length specified);

live - URL contains live TV-stream (Timeshift and DVR are welcome);

Examples:

playUrl ("udp://239.1.1.1", "live"); // Start play multicast-stream;
playUrl ("http://domain.tv/movies/movie.mkv", ""); // Start play file via http;
playUrl ("http://domain.tv/hls/playlist.m3u8", ""); // Start play HLS-video;

Sets up video window size. Position seting up according current video out mode.

If w = 0 и h = 0, Full screen mode used.

If onTop = true, video window drows above UI.

Stops playback if any.

sets playback on pause.

Continues playback.

Sets playback position in milliseconds. Keep in mind that beginning of playback is minPosition see below

Add subtitles from an external file (from url) to currently played media. This method should be called after playUrl. Optional parameter encoding sets up character encoding of subtitle file.

Returns URL of current or last played stream.

Returns mode (second param of playUrl) of current or last played stream.

Returns current playback position.

Returns minimal playback position (e.g. content beginning)

Returns maximum playback position (e.g. content ends).

Sets volume level from 0 to 100

Returns current volume level from 0 to 100

Turns off (mute=true) or turns on (mute=false) sound.

Returns true, if muted, otherwise false;

Returns the type of container being played (e.g. mpegts, avi, matroska)

Returns content being played media streams count (audio, video, subtitles etc)

Returns an object with media stream info

{
  "type": <videotype>,
  "id": <id>,
  "codec": <codec>,
  "lang" : <lang>
}

Here:
videotype - media stream type;
“v” - video,
“a” - audio,
“s” - subtitles;
id - PID;
codec - codec name;
lang - Audio stream ISO 639 language code.

Returns currently played video stream index.

Returns currently played audio stream index.

Returns currently played subtitle stream index.

Sets active audio stream (index).

Sets active subtitle stream (index).

Sets aspect ratio.
Available values:
“box” - Original
“full” - Full screen
“zoom” - Zoomed.

Adds new record job.
Here:
name - record name,
url - stream URL (MPEGTS via UDP, RTP, HTTP are supported.)
path - Local path to record,
start и end - start/stop time in UNIX TIMESTAMP or “YYYYMMDDTHHmmss” format.
Returns unique record job id.

Removes record job by id. If removeFile=true, stream stored to storage also will be removed.
Returns true in success.

Updates start time or(and) end time of recording id. If we need to set only one parameter leave second one empty.
Fromat for start end see at addRecord

Returns currently added jobs list.

Returns object (by id) with record parameters.

{
  "id": <id>,
  "name": <name>,
  "startTime": <start>,
  "endTime" : <end>,
  "url" : <url>,
  "status" : <status>
}

Here:
<id>, <name>, <start>, <end> - corresponds with addRecord routine parameter;
<status> - record status:
“waiting” - waiting for record,
“recording” - record in progress,
“finished” - record finished,
“error” - error occurred.

TvipEvent consist of Callback functions, which may be overloaded for events capturing.

onPlayerStateChange(int oldState, int newState);

Calls on mediaplayer playback status change. oldState - previous player status, newState - new player status.

Player possible status:

• 1 - Retrieving new URL;
• 2 - получение метаданных;
• 3 - Metadata received;
• 4 - Decoders preparation;
• 5 - Playback;
• 6 - End of content;
• 7 - Stopping playback;
• 8 - Playback stopped;
• 9 - Playback on hold;
• 10 - Seek new position is in progress;
• 11 - Error occured;

onSystemEvent(String codename, Object args);

On system event.
Examples codename:

• “mounted” - External storage connected and ready to use (args[“label”] - device label).
• “unmounted” - External storage is gone (args[“label”] - device label).
• “onpause” - Web-app window goes to background (eg, active Home or Settings screen).
• “onresume” - Web-app window become active (Calls on application resume).
• “cec_sleep” - HDMI connected TV turns OFF.
• “cec_wake” - HDMI connected TV turns ON.