05.08.2010

JavaScript Extension for Dib-120

Дарофф
JavaScript Api для приставок DLink Dib-120

1.        Introduction

JavaScript Extension

1.1         Using Method

1.1.1    Property

You can READ/WRITE it, except some read-only property.
Ex: device.cpufreq

1.1.2    Function

You can call it with/without parameter (by function)
Ex: stb.reboot()

1.1.3    Object Collection (JavaScript Array)

You can use array index to retrieve one object among this collection
Ex: dvb.channels[]   —- Object Collection
Ex: dvb.channels[0]  —- One Object

2.        API

API/Property Declaration and Definition.

2.1         Hardware Environment

2.1.1 Get Serial Number

Description
Get Serial Number of STB
Property
device.sn

2.1.2 Get MAC Address

Description
Get MAC Address of STB Ethernet Card
Property
device.macaddr

2.1.3 Get DRAM size

Description
Get DRAM size of STB
Property
device.memsize

2.1.4 Get Flash memory size

Description
Get Flash memory size of STB
Property
device.memsize

2.1.5 Get Name and Model Number of STB’s CPU

Description
Get Name and Model Number of STB’s CPU.
Property
device.cpuname

2.1.6 Get CPU Frequency

Description
Get CPU Frequency of STB
Property
device.cpufreq

2.1.7 Get Model Number and Name of STB

Description
Get Model Number and Name of STB. E.g. AST1100-C0
Property
device.model

2.1.8 Get STB Internal HardDisk exist status

Description
Get Internal HardDisk Exist Status
Property
stb.hd_exist
Value
True
HD Exist
false
HD not Exist
or
HardDisk Fail

2.1.9 Get STB Internal HardDisk free size

Description
Get Internal HardDisk free size (unit: MB)
Property
stb.hd_freesize
Value
HD free size (in MB)

2.2         System Setting

2.2.1 Get/Set MENU TYPE

Description
This setting is used to identify Function Scope
(ex: VOD/IPTV/DVB/PVR) for internal requirement.
We use this setting for IR-Controller Shortcut-Key(HOME/VOD/IPTV/DVB/PVR/INTERNET)
*You need to manually set this property by JavaScript when page is loaded
Property
stb.menutype
Value
0
HOME
1
VOD
2
IPTV
3
DVB
4
PVR
5
INTERNET

2.2.2 Get/Set IP Address of Time Server

Description
Get/Set Time Server of STB
Property
stb.timeServer

2.2.3 Get/Set TimeZone

Description
Get/Set Time Zone of STB
Property
stb.timeZone
Value
Value
 TimeZone
Time
1
USA
-10
2
USA
-9
3
USA
 -8
4
USA
-7
5
USA
-6
6
USA
-5
7
Faroe_Islands
0
8
Ireland
0
9
Portugal
0
10
UK
0
11
Austria
1
12
Belgium
1
13
Bosnia_Herzegovina
1
14
Croatia
1
15
Czech_Republic
1
16
Denmark
1
17
France
1
18
Germany
1
19
Hungary
1
20
Italy
1
21
Luxembourg
1
22
Macedonia
1
23
Malta
1
24
Namibia
1
25
Netherlands
1
26
Norway
1
27
Poland
1
28
Slovakia
1
29
Slovenia
1
30
Spain
1
31
Sweden
1
32
Switzerland
1
33
Belarus
2
34
Estonia
2
35
Finland
2
36
Greece
2
37
Israel
2
38
Latvia
2
39
Lithuania
2
40
Moldova
2
41
Romania
2
42
Russian_Federation
2
43
South_Africa
2
44
Turkey
2
45
Ethiopia
3
46
Russian_Federation
3
47
Iran
3.5
48
Azerbaijan
4
49
Mauritius
4
50
Russian_Federation
4
51
Pakistan
5
52
Russian_Federation
5
53
India
5.5
54
Sri_Lanka
5.5
55
Russian_Federation
6
56
Indonesia
7
57
Russian_Federation
7
58
Thailand
7
59
Vietnam
7
60
Australia
8
61
Brunei
8
62
China
8
63
Hong_Kong
8
64
Indonesia
8
65
Malaysia
8
66
Philippines
8
67
Russian_Federation
8
68
Singapore
8
69
Taiwan
8
70
Australia
9
71
Indonesia
9
72
Russian_Federation
9
73
South_Korea
9
74
Australia
10
75
Russian_Federation
10
76
Australia
11
77
Russian_Federation
11
78
New_Zealand
12
79
Russian_Federation
12

2.2.4 Get/Set Password

Description
Get/Set Password of STB
Property
stb.adminPassword

2.2.5 Get/Set URL of Firmware Update

Description
Get/Set Firmware Update URL of STB
Property
stb.fwUpdateUrl

2.2.6 Get/Set Time Calibration Mode

Description
Get/Set Time Calibration Mode of STB
Property
stb.timeMethod
Value
0: Manual Set(No Calibration)
1: NTP Calibration
2: DVB Calibration

2.2.7 Get/Set Daylight Saving Time Option

Description
Get/Set Daylight Saving Time Option
Property
stb.daylight
Value
0: Disable Daylight Saving Time
1: Enable Daylight Saving Time
CAUTION: You should call NTP Update (stb.ntpUpdate) after setting this. Because the daylight saving time will apply to system time after time calibration.

2.2.8 Get/Set Device Name of STB

Description
Get/Set Device Name of STB
Property
stb.deviceName

2.2.9 Get/Set System Language

Description
Get/Set System Default Language of STB
Property
stb.language
Value
«en»: English
“tw”: Chinese Traditional
“zh”: Chinese Simplified

2.2.10 Get System Modal State

Description
Get System is modal state or not
Property
stb.ismodal
Value
0: Not Modal State
1: In Modal State (ex: Firmware Update)
PS: You must carefully set this property and manage its status.

2.2.11 Get/Set Display Mode

Description
Get/Set Display Mode
Property
stb.displaymode
Value
0
NTSC
1
NTSC-JAPAN
2
PAL-M
3
PAL-N
4
PAL-NC
5
PAL-B
6
PAL-B1
7
PAL-D
8
PAL-D1
9
PAL
10
PAL-H
11
PAL-K
12
PAL-I
13
SECAM
14
480P
15
576P
16
1080I
17
1080I-50HZ
18
1080P
19
1080P-24HZ
20
1080P-25HZ
21
1080P-30HZ
22
1250I-50HZ
23
720P
24
720P-50HZ
25
 720P-24HZ
PS: These Value and Order may be changed in the future!

2.2.12 Get/Set System Aspect Ratio

Description
Get/Set Aspect Ratio of TV
Property
stb.aspect
Value
0: 4:3
1: 16:9
CAUTION: This setting is in order to indicate your TV Aspect Ratio. To set this value correct to real TV’s aspect ratio. You will get a correct output. This value will co-work with Content Mode.

2.2.13 Get/Set System Output Type

Description
Get/Set System ‘s output type
Property
stb.outputtype
Value
0: RGB(Component)
1: YPbPr(YcbCr)

2.2.14 Get/Set System Content Mode

Description
Get/Set System ‘s Content Mode
Property
stb.content
Value
0
Zoom
1
Box
2
PanScan
3
Full
4
Full-NonLiner
CAUTION: There are several limit when you set this value.
  1. It must be Full-Screen Mode (Player Window Size).
  2. It still depends on Aspect-Ratio Setting and video stream Aspect-Ratio. So you will see different result between video stream and different Aspect-Ratio Setting.

2.2.15 Get System Contrast Value

Description
Get System Contrast Value
Property
stb.contrast
Value
1~20
PS: get value only, set this value will be nothing happened.

2.2.16 Increase/Decrease System Contrast Value

Description
Increase/Decrease System Contrast Value
Function
stb.contrast_add(var operation)
Parameter
[operation]
-1:Decrease
1:Increase
Return Value
true: Success
false: Fail

2.2.17 Get System Brightness Value

Description
Get System Brightness Value
Property
stb.brightness
Value
1~20
PS: get value only, set this value will be nothing happened.

2.2.18 Increase/Decrease System Brightness Value

Description
Increase/Decrease System Brightness Value
Function
stb.brightness_add(var operation)
Parameter
[operation]
-1:Decrease
1:Increase
Return Value
true: Success
false: Fail

2.2.19 Get System Sharptness Value

Description
Get System Sharpness Value
Property
stb.sharpness
Value
1~20
PS: get value only, set this value will be nothing happened.

2.2.20 Increase/Decrease System Sharpness Value

Description
Increase/Decrease System Sharpness Value
Function
stb.sharpness_add(var operation)
Parameter
[operation]
-1:Decrease
1:Increase
Return Value
true: Success
false: Fail

2.2.21 Get System Saturation Value

Description
Get System Saturation Value
Property
stb.saturation
Value
1~20
PS: get value only, set this value will be nothing happened.

2.2.22 Increase/Decrease System Saturation Value

Description
Increase/Decrease System Saturation Value
Function
stb.saturation_add(var operation)
Parameter
[operation]
-1:Decrease
1:Increase
Return Value
true: Success
false: Fail

2.2.23 Get System Hue Value

Description
Get System Hue Value
Property
stb.hue
Value
1~20
PS: get value only, set this value will be nothing happened.

2.2.24 Increase/Decrease System Hue Value

Description
Increase/Decrease System Hue Value
Function
stb.hue_add()
Parameter
-1:Decrease
1:Increase
Return Value
true: Success
false: Fail

2.2.25 Save Current Volume to Configuration

Description
Save Current Volume Value to Configuration
Function
stb.save_vol()
Parameter
Nothing
Return Value
true: Success
false: Fail

2.2.26 Save Current OSD Setting to Configuration

Description
Save Current OSD Value to Configuration
[DisplayMode/Outputtype/Aspect/ContentMode/Contrast/Brightness/Sharpness/Saturation/Hue and so on.]
Function
stb.save_osd()
Parameter
Nothing
Return Value
true: Success
false: Fail
CAUTION: You “MUST” call this function to save setting after you set up [DisplayMode/Outputtype/Aspect/ContentMode/Contrast/Brightness/Sharpness/Saturation/Hue/Volume]

2.2.27 Get/Set Internal Key Process Function Switch

Description
Get/Set Internal key process function switch
Property
stb.disableinternalkey
Value
True: Disable internal key process function
False: Enable internal key process function(Default)

2.2.28 Set STB event callback

Description
Set STB event callback(HDMI/Power)
Property
stb.onevent
Value
Function name(string)
For example:
function stbevt(eventtype)
{
switch(eventtype)
{
case 0://Standby
break;
case 1://Resume from Standby
break;
case 2://HDMI plugged
break;
case 3://HDMI unplugged
break;
}
}
stb.onevent=”stbevt”;

2.3         System Control

2.3.1 Reboot STB

Description
Force STB to reboot
Function
stb.reboot()
Parameter
Nothing
Return Value
true: Success
false: Fail

2.3.2 StandBy STB

Description
Force STB to enter Stand-By Mode
Function
stb.standby()
Parameter
Nothing
Return Value
true: Success
false: Fail

2.3.3 Restore Default Settings

Description
Restore the Default System Settings
Function
stb.restoreDefault()
Parameter
Nothing
Return Value
true: Success
false: Fail

2.3.4 NTP Update

Description
NTP Update
Function
stb.ntpUpdate()

2.3.5 Cancel NTP Update

Description
Cancel NTP Update
Function
stb.cancelNTPUpdate()

2.3.6 Get NTP Update Status

Description
Get NTP Update Status
Property
stb.ntpUpdateStatus
Value
-1: NTP Update Fail
1: Connecting to NTP server
2: NTP Update Success

2.3.7 Set System Time

Description
Set System Time
Function
stb.setSystemTime(var Year, var Month, var Date, var Hour, var Minute, var Second)

2.3.8 Upgrade Firmware

Description
Upgrade Firmware
Function
stb.fwUpgrade(var Source)
Parameter
1
Upgrade form Network
2
Upgrade from USB

2.3.9 Cancel Upgrade Firmware

Description
Cancel Upgrade Firmware
Function
stb.cancelFWUpgrade()
Note: For system protection, this function only works before writing firmware.

2.3.10 Get Firmware Upgrade Status

Description
Get Firmware Upgrade Status
Property
stb.fwUpgradeStatus
Value
0
 FWUP_UNKNOW_STATUS
1
 FWUP_WAIT_STATUS
2
 FWUP_BUSY_STATUS
3
 FWUP_DOWNLOAD_START
4
 FWUP_DOWNLOAD_FINISH
5
 FWUP_INFO_DOWNLOAD_START
6
 FWUP_INFO_DOWNLOAD_FINISH
7
 FWUP_WRITE_START
8
 FWUP_WRITE_FINISH
9
 FWUP_DOWNLOAD_FAIL
10
 FWUP_INFO_DOWNLOAD_FAIL
11
 FWUP_WRITE_FAIL
12
 FWUP_RAMDISK_FAIL
13
 FWUP_USB_FAIL
14
 FWUP_FIRM_FILE_FAIL
15
 FWUP_URL_FILE_FAIL
16
 FWUP_INFO_FILE_FAIL
17
 FWUP_EXECMD_FAIL
18
 FWUP_FIRM_MD5_FAIL
19
 FWUP_USER_CANCEL
PS: When Finish Updating Firmware, device will reboot automatically.

2.3.11 Get Rate of Firmware Download Progress

Description
Get Rate of Firmware Download Progress
Property
stb.fwUpgradeDownloadPercent
Value
0 ~ 100

2.3.12 Upgrade Daylight Saving Configuration file

Description
Upgrade DST (Daylight Saving Time) configuration file
Function
stb.dstConfigUpdate(var URL)
Parameter
The full url of DST configuration file.

2.3.13 Control LED Status

Description
Control LED State
Function
stb.setled(var led_index ,var state_index)
Parameter
[led_index] (PS: Network LED can’t controlled)
0:Power LED
[state_index]
0:OFF
1:ON
Return Value
true:Success
false:Fail

2.3.14 Log Message to System Log

Description
Write message to System Log File for analyze.
Function
stb.log(var txt_message)
Return Value
true:Success
false:Fail

2.3.15 Print Message to Console Port

Description
Write message to Console Window.
(You must have console port connected)
Function
stb.print(var txt_message)
Return Value
true:Success
false:Fail

2.4         Software Environment

2.4.1 Get OS Version

Description
Get OS Version of STB
Property
software.osVersion

2.4.2 Get Browser Version

Description
Get Browser Version of STB
Property
software.browserVersion

2.4.3 Get Firmware Version

Description
Get Firmware Version of STB
Property
software.firmwareVersion

2.5         Networking

2.5.1 Get/Set Network Mode

Description
Get/Set Network Mode of STB (STATIC/DHCP)
Property
network.netmode
Value
0
Static IP
1
DHCP
2
PPPoE

2.5.2 Get IP Address

Description
Get IP Address of STB
Property
network.netip

2.5.3 Get Subnet Mask

Description
Get Subnet Mask of STB
Property
network.netmask

2.5.4 Get Gateway

Description
Get Gateway of STB
Property
network.netgateway

2.5.5 Get/Set DNS

Description
Get/Set DNS Server’s IP Address of STB
Property
network.netdns
network.netdns2

2.5.6 Set IP Address

Description
Set IP Address of STB
Function
network.netsetup(var ip, var netmask, var gateway, var dns)
network.netsetup(var ip, var netmask, var gateway, var dns, var dns2)
Parameter
[ip/netmask/gateway/dns/dns2]
Type:String ex: (192.168.1.254)

2.5.7 Get/Set Subscriber’s PPPoE User’s ID

Description
Get/Set Subscriber’s PPPoE User’s ID
Property
network.pppoeUserName

2.5.8 Get/Set Subscriber’s PPPoE Password

Description
Get/Set Subscriber’s PPPoE Password
Property
network.pppoePassword

2.5.9 Get/Set Network IGMP version

Description
Get/Set Network IGMP Version
Property
network.igmp
Value
1
IGMP v1
2
IGMP v2
3
IGMP v3

2.5.10 Get/Set Network multicast Timeout Value

Description
Get/Set multicast timeout value
Property
network.iptvtimeout
Value
Number
0-use default value

2.6         Browser

2.6.1 Get/Set URL of Home Page

Description
Get/Set Home Page URL When Browser is Start-up
Property
webbrowser.homepage

2.6.2 Get/Set URL of Configuration Page

Description
Get/Set Configuration page URL of STB
Property
webbrowser.configpage

2.6.3 Get/Set URL of VOD Server

Description
Get/Set URL of VOD Server
Property
webbrowser.vodServer
Value
A string (ex:http://vod.testmedia.com/vod1/vod.htm)

2.6.4 Get/Set URL of IPTV Server

Description
Get/Set URL of IPTV Server
Property
webbrowser.iptvServer
Value
A string (ex: http://iptv.testmedia.net/iptv2/iptv.htm)

2.6.5 Get/Set URL of DVB Server

Description
Get/Set URL of DVB Server
Property
webbrowser.dvbServer
Value
A string (ex:file:///home/root/abc.htm)

2.6.6 Get/Set URL of PVR Server

Description
Get/Set URL of PVR Server
Property
webbrowser.pvrServer
Value
A string (ex:file:///home/root/abc.htm)

2.6.7 Get/Set URL of STB startup page

Description
Get/Set URL of startup page when STB boot up.
Property
webbrowser.mainpage
Value
A URL string (ex:file:///home/root/abc.htm)

2.6.8 Get/Set Configuration of HTTP Proxy

Description
Get/Set Configuration of HTTP Proxy
Property
webbrowser.enableProxy
Value
0: Disable
1: Enable

2.6.9 Get/Set Configuration of HTTPS Proxy

Description
Get/Set Configuration of HTTPS Proxy
Property
webbrowser.enableSecureProxy
Value
0: Disable
1: Enable

2.6.10 Get/Set URL of HTTP Proxy Server

Description
Get/Set URL of HTTP Proxy Server
Property
webbrowser.httpProxy
Value
URL:port

2.6.11 Get/Set HTTP Proxy Exception Address

Description
Get/Set HTTP Proxy Exception Address
Property
webbrowser.exceptionAddr

2.6.12 Get/Set URL of HTTPS Proxy Server

Description
Get/Set URL of HTTPS Proxy Server
Property
webbrowser.secureProxy
Value
URL:port

2.6.13 Get/Set HTTPS Proxy Exception Address

Description
Get/Set HTTP Proxy Exception Address
Property
webbrowser.httpsDirectAccess

2.6.14 Get/Set XMLHttpRequest Same Origin Policy

Description
Set XMLHttpRequest Same Origin Policy
CAUTION: This is a global setting. According security purpose, don’t change it to disabled (0). But in special case, maybe you will need to disable this policy temporarily.
Property
stb.xmlhttprequest
Value
0
Ignore Same Origin
1
Limit Same Origin

2.6.15 Set Browser Position

Description
Set browser window position and size.
Function
webbrowser. setposition (var x , var y , var width , var height)
Parameter
x: horizontal offset.
y: vertical offset.
width: window width.
height: window height.
Return Value
true
Success
false
Fail

2.7         Audio & Video Playback

2.7.1  Get Audio Volume

Description
Get Audio Volume Value
Property
stb.vol
Value
0~20

2.7.2 Set Audio Volume Up

Description
Set Audio Volume Up
Function
stb.volup()
Parameter
Nothing
Return Value
true: Success
false: Fail

2.7.3 Set Audio Volume Down

Description
Set Audio Volume Down
Function
stb.voldown()
Parameter
Nothing
Return Value
true: Success
false: Fail

2.7.4  Mute Audio

Description
Mute Audio
Function
stb.mute()
Parameter
Nothing
Return Value
true: Success
false: Fail

2.8         DVB

2.8.1 Get DVB Module Type

Description
Get DVB Tuner Type
Property
dvb.dvb_type
Value
0
DVB-T
1
DVB-C
2
DVB-S

2.8.2 Play DVB Channel by Channel ID

Description
Play DVB Channel By DVB Channel ID.
CAUTION: Channel Id is an internal unique identification number and this is not equal to “Channel Number”.
Function
dvb.play_channel(var ch_id)
Parameter
[ch_id]:DVB Channel ID.
Return Value
true: Success
false: Fail

2.8.3 DVB Channel Up

Description
DVB Channel Up (Switch DVB Channel to Next DVB Channel)
Function
dvb.channel_up()
Parameter
Nothing
Return Value
true: Success
false: Fail
PS: This function can only work when DVB Channel is playing, so you must play one channel already and call this function to switch DVB channel

2.8.4 DVB Channel Down

Description
DVB Channel Down (Switch DVB Channel to Previous DVB Channel)
Function
dvb.channel_down()
Parameter
Nothing
Return Value
true: Success
false: Fail
PS: This function can only work when DVB Channel is playing, so you must play one channel already and call this function to switch DVB channel

2.8.5 Get DVB Channel Object Collection

Description
Get DVB Channels Collection
Property
dvb.channels

2.8.6 Get DVB Channel Object of Channel Object Collection

Description
Get DVB Channel Object
Property
dvb.channels[var array_idx]
[array_idx]:Decimal No. (0 or positive)
Return Value
A DVB Channel Object

2.8.7 Get DVB Program Object Collection of Channel

Description
Get DVB Programs Collection of Channel
Property
dvb.channels[var array_idx].progs
[array_idx]:Decimal No. (0 or positive)

2.8.8 Get DVB Program Object of Channel’s Program Object Collection

Description
Get DVB Program Object
Property
dvb.channels[var array_idx].progs[var array_idx]
[array_idx]:Decimal No. (0 or positive)
Return Value
A DVB Program Object

2.8.9 A DVB Channel Object

Description
A DVB Channel Object
Property
[ch_no]:Positive Decimal No.
[ch_id]:An unique internal identification number.
[ch_name]:A Channel Name String(UTF8-Encoding)
[progs]:A DVB Program Cbject Collection
[isradio]:A audio-only channel or not.
[isplaying]:
This Channel is now playing or not. (true or false)

2.8.10 A DVB Program Object

Description
A DVB Program Object
Property
[ch_no]:
Channel ‘s Channel Number of this Program
[ch_name]:
The Program Name String (UTF8-Encoding)
[desc]:
The Program Information String (UTF8-Encoding)
[isnowprogram]:
This Program is now program or not (true or false)
[isvalid]:This Program is valid or not(true or false)
(EX: false-Expired/Other special purpose)
[starttime]:
Program Start Time (Time Unit: Seconds)
[proglength]:
Program Length (Time Unit: Minutes)
CAUTION:
In JavaScript, base time unit is 1/1000 Secs (Not 1 sec)
So if you want to calculate time or show time information you must notice this difference and convert between them!!

2.8.11 Get DVB Scheduled-Record Channel Id within 2 minutes

Description
Get a Channel Id that will start to record within 2 minutes.
Property
dvb.schprepare_ch_id
Value
0
No Channel Id
>0
Valid Channel Id

2.9 Middleware Relative Management Functions

2.9.1 Player Control Functions

2.9.1.1         Play

Description
Plays the content, specified by the src string
Function
stb_media.play(var src)
Parameter
src: Protocol– RTSP://  UDP://
Return
Returns 0 if the operation is successful, -1 if the operation is failed

2.9.1.2         Pause

Description
Stops the playback. The last frame is displayed on the screen.
Function
stb_media.pause()
Return
No return value

2.9.1.3         Stop

Description
Stops the playback and clears the screen.
Function
stb_media.stop()
Return
No return value

2.9.1.4         Continue

Description
Resume the video stream playback from the stop position.
Function
stb_media.continuePlay()
Return
No return value

2.9.1.5         Set Position

Description
Set position based on the stream start position (in seconds).
Function
stb_media.setPosition(var position)
Parameter
position: integer (position in seconds)
Return
Returns 0 if the operation is successful, -1 if the operation is failed
Note
l       This function only avoid when playing

2.9.1.6         Get Position

Description
Get the current position based on the stream start position.
Function
stb_media.getPosition()
Return
Returns the current position based on the stream start position (in seconds).
Note
l       This function only avoid when playing

2.9.1.7         Set Speed

Description
Specifies the stream playback speed.
Function
stb_media.setSpeed(var speed)
Parameter
speed: integer (1/4/12)
Return
Returns 0 if the operation is successful, -1 if the operation is failed
Note
l         This function only avoid when playing

2.9.1.8         Get Speed

Description
Get the current stream playback speed.
Function
stb_media.getSpeed()
Return
Returns the current stream playback speed.
Note
l       This function only avoid when playing

2.9.1.9         Set Audio PID

Description
Sets the audio PID (for multi-language broadcast).
Function
stb_media.setAudioPID(var audioPID)
Parameter
audioPID: integer
Return
Returns 0 if the operation is successful, -1 if the operation is failed
Note
l         This function only valid when playing

2.9.1.10    Get Audio PID

Description
Get the current audio PID.
Function
stb_media.getAudioPID()
Return
Returns the current used audio PID.
Note
l       This function only valid when playing

2.9.1.11    Get Audio PIDs List

Description
Get the audio PIDs list of stream.
Function
stb_media.getAudioPIDS()
Return
Returns the string of audio PID list. ( separate by ‘,’)
Example:
10,80,69,122
Note
l       This function only valid when playing

2.9.1.12    Set Volume

Description
Sets the volume.
Function
stb_media.setVolume(var volume)
Parameter
volume: integer (range: 0~100)
Return
No return value

2.9.1.13    Get Volume

Description
Get the current volume level.
Function
stb_media.getVolume()
Return
Returns the current volume level.

2.9.2 SCREEN FUNCTIONS

2.9.2.1         Set PIG

Description
Set video display mode and location.
Function
stb_media.setPIG(var state)
stb_media.setPIG(var state, var width, var height, var x, var y)
Parameter
state: true for window mode; false for full-screen mode
width, height, x, and y are available for window mode only.
width: window width, maximum value is 1920.
height: window height, maximum value is 1080.
x: horizontal offset, maximum value is 1920.
y: vertical offset, maximum value is 1080.
Return
No return value.

2.9.2.2         Get PIG

Description
Get video display mode.
Function
stb_media.getPIG()
Return
Returns true if the video is displayed in window mode, or returns false if the video is displayed in full-screen mode.

2.9.2.3         Set Transparency Level

Description
Set the transparency level.
Function
stb_media.setAlphaLevel(var level)
Parameter
level: integer. Range 0~255
Return
No return value.

2.9.2.4         Get Transparency Level

Description
Get the current transparency level.
Function
stb_media.setAlphaLevel()
Return
Return the current transparency level.

2.9.2.5         Set Transparency Color

Description
Set the color that is considered as transparent.
Function
stb_media. setTransparentColor(var color)
Parameter
color:
Format :0xAARRGGBB
EX: Red-0xFFFF0000
Green-0xFF00FF00
Blue-0xFF0000FF
Return
No return value.
Note
If change transparent color when page loaded and images not change, you need force redraw to apply the setting. Omit forceRedraw parameter for other cases.

2.9.2.6         Get Transparency Color

Description
Get the color that is currently considered as transparent.
Function
stb_media.getTransparentColor()
Return
Return the color in the form of 0x00rrggbb that is currently considered as transparent. Return 0xFF000000 if no color consider as transparent.

2.9.3 MEDIA EVENTS MANAGEMENT

2.9.3.1         Get Media Event Code

Description
Get the variable contain the code of the last media event occured.
Property
stb_media.eventCode
Value
0
 Stopped
1
Error
2
EOF
 Except DIB-150
3
Buffering
 (when play command sent but not playing yet)
4
Playing
 Except DIB-150
5
Paused
6
Stopping
 (when stop command sent but not stopped yet)
102
VOD End Of Stream
 Only for DIB-150
202
IPTV End Of Stream
 Only for DIB-150
302
DVB End Of Stream
 Only for DIB-150
104
VOD Playing
 Only for DIB-150
204
IPTV Playing
 Only for DIB-150
304
DVB Playing
 Only for DIB-150
Бирки: , , , ,

Комментариев нет:

Отправить комментарий

Подписаться на: Комментарии к сообщению (Atom)

LinkWithin

halt Related Posts with Thumbnails