SCREEN

This section defines the elements to print and their coordinates. The elements are printed in the order defined. X and Y define the coordinate on screen and ID is either a predefined tag ($TAG) or an element.
- Predefined tag is a reserved word with a special meaning (e.g. $ARTIST, see below).
- Element prints the VALUE of element which name (ID) is <FOOELEMENT>

This part is mandatory. This can be named as anything: <ANYTHING>.

<ANYTHING>
X="00",Y="01",ID="$ARTIST"
</ANYTHING>
On the second line (0,1) the name of the artist currently playing is printed (e.g. The Prodigy).

DEFAULT

This section defines the default settings to use. Each element has a set of settings which can be used. If nothing is specified, the settings in DEFAULT are used. If DEFAULT is not defined, predefined (<------- Link to predef values------) values will be used.

This must be named as <DEFAULT>.

<DEFAULT>
WIDTH="20",ATTR="NORMAL",FONT="8",ALIGN="LEFT"
</DEFAULT>
Everything will be printed on a 20 (chars) wide screen, aligned to the left in small font with attribute normal (e.g. no blinking).

ELEMENT

This section defines the element and it's properties. The properties defined here will override settings in <DEFAULT> for this element.

This can be named as anything: <ANYTHING>.

<ELEMENT ID="ARTIST">
VALUE="$ARTIST",FONT="16",ALIGN="CENTER"
</ELEMENT>
This will create an element with name ARTIST. It will print the artist name centered in a 16x16 font. Note that rest of the properties (e.g. ATTR) is taken from <DEFAULT>.

ONCE
(not supported yet)

ONCE section is a section that is drawn once in the beginning. The parts mentioned won't be updated anymore and should not contain any data that changes. The idea is to optimize screenupdating. This is good for drawing windows frames, background pictures and other static things.

This works just like SCREEN.

This must be named as <ONCE>.

<ONCE>
X="00",Y="00",ID="------------------------"
X="00",Y="14",ID="------------------------”
X="00",Y="15",ID="(c) 2004”
</ONCE>

<DEFAULT>
WIDTH="20",ATTR="NORMAL",FONT="8",ALIGN="LEFT"
</DEFAULT>
<ELEMENT ID="LINE">
VALUE=”$TEXT”,CAPTION="--------------------"
</ELEMENT>
<ELEMENT ID="SLASH">
VALUE=”$TEXT”,CAPTION="/"
</ELEMENT>
<ELEMENT ID="LISTPOS">
VALUE=”$LISTPOS”
</ELEMENT>
<ELEMENT ID="LISTLEN">
VALUE=”$LISTLEN”
</ELEMENT>
<ELEMENT ID="ARTIST">
VALUE="$ARTIST",FONT="16",ALIGN="CENTER"
</ELEMENT>
<ELEMENT ID="LIST">
VALUE="$LIST",LISTHEIGHT="9",LISTHIGHLIGHT="BIG",LISTMODE="AB"
</ELEMENT>
<ELEMENT ID="CLOCK">
VALUE="$CLOCK",FONT="16",WIDTH="9"
</ELEMENT>

<MP3_SELECT>
X="00",Y="00",ID="ARTIST"
X="00",Y="02",ID="LINE"
X="00",Y="03",ID="LIST"
X="00",Y="13",ID="LINE"
X="00",Y="13",ID="LISTPOS"
X="03",Y="13",ID="SLASH"
X="04",Y="13",ID="LISTLEN"
X="11",Y="14",ID="CLOCK"
</MP3_SELECT>

$BACKGROUND

$BUTTON

(---) A button on screen

$IMAGE

(gfx) Draws an image to the screen.

$LIST

x

x

x

x

x

The list with the $ARTIST/$SONG/$ALBUM information. Use listmode to select what to print.

See also $LISTLEN

$CHILDIMAGE

x

(---)

$TEXT

x

(string)

$TIMEBAR

x

x

x

x

(gfx) $TIMEPERCENT shown as a progressbar

$LOGO

(gfx) Prints a logo built from characters on screen.

VALUE

x

x

(string) The $TAG for the element

VALUE="$TEXT"
VALUE="$BUTTON"

CAPTION

x

x

(string) Text to be printed. Can also include one (or more) $TEXT/$LIST tag with or without additional text.

CAPTION=”Foo text”
CAPTION=”$ARTIST”
CAPTION=”Now playing: $SONG”
CAPTION=”Now playing: $SONG from $ARTIST”

FONTSIZE

x

x

(integer) Size of the font.

LCD
For LCD only two sizes are supported: 8=8x8 font and 16=16x16 font

FONTNAME

-

x

(string) Name of the font.

FONTNAME=”ARIAL”

FONTBOLD

-

x

(boolean) Defines is text or caption is to be printed in bold style

FONTBOLD="Y"
FONTBOLD="N"

FONTCOLOR

-

x

(integer) The color of the font. Color is defined in RGB and can be either decimal or hex.

FONTCOLOR=”123456”
FONTCOLOR=”$89abcd”

WIDTH

x

x

(integer) Width of the area where to print.

LCD
TEXT: Width of the area (in characters) where to print. 0: No cutting or scrolling will be done. Text will be printed as is (e.g. continues from next row).
LOGO: Imagesize of the logo in chars. If not defined, the size of the image is used.
IMAGE: Imagesize of the bitmap. If not defined, the size of the image is used.

WIDTH=”12”

HEIGHT

x

x

(integer) Height of current TAG

LCD
TEXT: Nothing
LIST: Height of list. As the hightlight is in the middle of the list, I suggest to use ODD values here (3, 5, ...). Note that this height is not on screen height but the amount of lines to show. Due to this, using listhighlight="BIG", will result in a list which is listheight+1 on screen
LOGO: Imagesize of the logo in chars. If not defined, the size of the image is used.
IMAGE: Imagesize of the bitmap. If not defined, the size of the image is used.

HEIGHT=”4”

ATTR

x

-

(string - attrtype) The attribute to use when printing characters to screen.

LCD
NORMAL: Normal characters. The attribute area under the text is cleared.
REVERSE: Reversed characters.
BLINK: Blinking characters.
BLINKREVERSE: Reversed characters blinking.
NOCHANGE: This prints only text without messing the attribute area.
ONLYATTR: This prints only the attribute without messing the text area. Note: How to pass the wanted attribute???
FASTPRINT: Prints the text as fast as possible. Useful when coding a screensaver or such.

ATTR=”BLINK”

ALIGN

x

x

(string - aligntype) Horizontal alignment of $TAG or text.

LCD:
LEFT: Text is aligned to the left.
CENTER: Centers the text if it fits to width. If text is longer, text will be aligned to left.
RIGHT: Text is aligned to the right.
SCROLL: Scrolls the text unless it fits to width. If text fits, the text will be centered. Text scrolls in a width wide window. If width=0, no scrolling will happen.

ALIGNVERTICAL

-

x

(string - aligntype) Vertical alignment of $TAG. Allowed values are TOP, BOTTOM, CENTER.

TV:
Elem ........ T B C
$TEXT ....... X X X
$BUTTON ..... X X X
$ARTIST ..... X X X
$ALBUM ...... X X X
$SONG ....... X X X
$LIST ....... X n n
$IMAGE ...... X n n
$CHILDIMAGE . X n n
$BACKGROUND . X n n

X = supported.
n = will not be implemented
T = TOP
B = BOTTOM
C = CENTER

ALIGNVERTICAL=”CENTER”

LISTMODE

x

x

(string) Defines what is to be printed on the list. The value can be plaing text with or without $TAG string types.

LISTMODE="$ARTIST"
This prints a list of 'artists'
LISTMODE="$ALBUM - $SONG”
This prints list of 'album - song'

LISTHIGHLIGHT

x

x

(string - attrtype) Defines how the line in the middle of the list is represented.

TV:
The color to use for the line that is active. The value can be either in hex ($) or decimal.

FONTCOLOR=”123456”
FONTCOLOR=”$89abcd”

LCD:
BLINK: Text is blinking.
REVERSE: Text is mirrored
BLINKREVERSE: Text is mirrored and is blinking.
TAG: Infront of the list, a tag ('>') is printed.
BIG: Text is written in big letters. Notice that lines on the screen will be listheight+1 due to the bigger font.

Note: How to have BIG text which is REVERSE?

LISTHIGHLIGHT=”BLINK”

LISTROWCOUNT

-

x

(integer) How many rows to show on screen.

LISTROWCOUNT=”10”
This will draw 10 lines of LISTMODE on screen. Linedistance between lines is WIDTH / LISTROWCOUNT. Note that if your font is bigger than linedistance, characters end up on top of each other.

LISTROWSELECT

-

x

(integer) Which line to use as the row for selection.

LISTROWSELECT=”5”
The 5th line is shown with LISTHIGHLIGHT color as active.

NAUGHTYBIT

-

x

(boolean) Y or N. Sets the 'parental advisory' bit of an element. If the user so decides, he/she can set the naughty bits -stuff off somewhere (where?) so the screen does not display anything which has NAUGHTYBIT set. This allows screens/skins have content, that can be generally switched off when so desired.

NAUGHTYBIT="Y"
NAUGHTYBIT="N"

Extra properties for
$BACKGROUND, $IMAGE and $BUTTON

LCD

TV

Description

FILENAME

-

x

(string) The filename where the graphics are to be loaded from. If path is not defined, the default is pics-directory under the theme (themename\pics).

FILENAME=”foo.jpg”

MASK

-

x

(boolean) Whether a mask is used when showing $IMAGE or $BUTTON. The color used as the transparent color is set in MASKCOLOR. Do note that this works best with .bmp files.

MASK=”Y”

MASKCOLOR

-

x

(integer) The color used for masking. Anything in a picture with this color will be transparent. Color is defined in RGB and can be either decimal or hex.

MASKCOLOR=”1234567”
MASKCOLOR=”$89abcd”

$BUTTON (only)

LCD

TV

Description

ACTION

-

x

(string) What this element (button) should do when pressed. Values are separated with | (pipe).

ACTION=”cmdSOMETHING” or
ACTION=”cmdSOMETHING|”
Accepted actions and commands are found in commands.
ACTION="cmdQUIT"
MokCC will shutdown and close also Windows.
ACTION="cmdMP3Select|MP3"
MokCC will start MP3Select with parameters found in [MP3] section of mok.ini.

ACTION=”third|”
ACTION="third|xmlpage.txt|thirdparty.exe"
ACTION="third|xmlpage.txt|thirdparty.exe|parameters"
- xmlpage.txt: The page to show while running thirdparty.exe
- thirdparty.exe: The path\program to run. If parameters are to be sent, they are separated with | (pipe).
- parameters: Extra parameters to pass to the application.

MokCC will activate a thid party application. All application handling is done by MokCC. State will change to gui_thirdparty. Everything in the commandline is to be sent to MokCC so that the parameters are also passed.

ACTION="third|xml_empty.txt|notepad.exe|myfile.txt"
Notepad is activated and myfile.txt is opened.

ACTION="page|”
ACTION="page|xmlpage.txt"
- xmlpage.txt: The page to show. This will activate a page found in the file xmlpage.txt. The given page might have a new action to show a new page. These are pages that do not need a statechange in MokCC.

ACTION="page|xml_weather.txt"

BUTTONACTIVE

-

x

(filename) $BUTTON element highlight graphics

BUTTONUP

-

x

(filename) $BUTTON element normal graphics

BUTTONDOWN

-

x

(filename) $BUTTON element when pressed down graphics

BUTTONDISABLED

-

x

(filename) $BUTTON element disabled graphics

CAPTIONOFFSETX
CAPTIONOFFSETY

-

x

(integer) X/Y-offset where CAPTION is printed from $BUTTON elements X/Y-coordinate

FONTCOLORACTIVE

-

x

(integer) CAPTION is printed with this color when $BUTTON is active. Color is defined in RGB and can be either decimal or hex.

FONTCOLORACTIVE=”1234567”
FONTCOLORACTIVE=”$89abcd”

CHILDIMAGE

-

x

(--) On-screen graphics we want to change depending on the active button.

TOOLTIP

-

x

(string) When an element is active, a tooltip can be shown to user.

TABINDEX

-

x

(integer) The number of tab in a button. This value is used in TAB___ properties.

TABLEFT
TABRIGHT
TABUP
TABDOWN

-

x

(integer) Used to determine which element to go to when pressing left/right/up/down.

TABLEFT=”1”
Pressing kLEFT on remote, will activate the element with TABINDEX value 1.

$BACKGROUND

$BUTTON

$CHILDIMAGE

$CLOCK

$IMAGE

$LIST

$TEXT

ACTION

-

x

-

-

-

-

-

ALIGN

-

x

?

?

?

?

x

ALIGNVERTICAL

top

x

top

?

top

top

x

ATTR

-

-

-

only LCD

-

only LCD

only LCD

BUTTONACTIVE

-

x

-

-

-

-

-

BUTTONDISABLED

-

x

-

-

-

-

-

BUTTONDOWN

-

x

-

-

-

-

-

BUTTONUP

-

x

-

-

-

-

-

CAPTION

-

x

-

-

-

-

x

CAPTIONOFFSETX

-

x

-

-

?

-

-

CAPTIONOFFSETY

-

x

-

-

?

-

-

CHILDIMAGE

-

x

-

-

x

-

-

FILENAME

x

x

-

x

-

-

FONTBOLD

-

x

-

x

-

x

x

FONTCOLOR

-

x

-

x

-

x

x

FONTCOLORACTIVE

-

x

-

x

-

?

x

FONTNAME

-

x

-

x

-

x

x

FONTSIZE

-

x

-

x

-

x

x

HEIGHT

x

x

x

?

x

x

x

LISTHIGHLIGHT

-

-

-

-

-

x

-

LISTMODE

-

-

-

-

-

x

-

MASK

-

x

x

-

x

-

-

MASKCOLOR

-

x

x

-

x

-

-

NAUGHTYBIT

?

x

x

-

x

-

-

TABDOWN

-

x

-

-

-

-

-

TABINDEX

-

x

-

-

-

-

-

TABLEFT

-

x

-

-

-

-

-

TABRIGHT

-

x

-

-

-

-

-

TABUP

-

x

-

-

-

-

-

TOOLTIP

x

VALUE

x

x

x

x

x

x

x

WIDTH

x

x

x

x

x

x

x

$ALBUM

x

x

x

x

x

The name of the current album.

Note: This should be renamed to $ITEM. That way it works both for movies and music. See also note for $ARTIST

$ARTIST

x

x

x

x

x

The artist/director information for the current item

$ASPECT

x

x

(x)

Aspect ratio for the movie (4:3, 16:9)

$BITRATE

x

x

(x?)

(x?)

(x?)

Bitrate of the current audio stream.

DVD: This could be found from the DVD information, but is this available (in Eugene).
MOV: This could be found from the DVD information, but is this available (in movie player).
CD: Samplerate is constant (???)

$CHAPTER

x

x

x

x

DVD: The number of the chapter played on DVD.
CD: The number of currently playing track on CD.
MP3: The number of currently played song on an MP3 album. This is NOT the total amount of songs in the list.

Note: Should be renamed to CHAPTERTRACK etc...

$CHAPTERAMOUNT

x

x

(x)

x

The total amount of chapters on DVD.
The total amount of tracks on CD.
The total amount of tracks on MP3 album. This is NOT the total amount of songs in the list.

Note: Should be renamed to CHAPTERTRACKAMOUNT etc...

$CLOCK

x

x

x

x

x

The current time in format 'hh:mm'.

Note: This could be done to support formatting as 'dd.mm' as parameters.

$CODING

x

x

(x?)

The coding used for the movie.

DVD: ????
MOV: This could be the encoding used (mpeg1, divx, ...)

$FRAMERATE

x

(x)

x

The framerate of the movie. On DVD this is constant (PAL=25, NTSC=30)

$LISTLEN

x

x

x

x

x

Length of list (1-n)

$LISTPOS

x

x

x

x

x

Current position on the list (1-n)

$REGION

x

x

The region on DVD

$RESOLUTION

x

x

x

XXX x YYY as pixels.

$SAMPLERATE

x

x

(x?)

(x?)

(x?)

Samplerate of the current audio stream

DVD: This could be found from the DVD information, but is this available (in Eugene).
MOV: This could be found from the DVD information, but is this available (in movie player).
CD: Samplerate is constant 44.1KHz

$SONG

x

x

x

The name of the current song.

$STANDARD

x

x

The television standard on DVD (PAL, NTSC)

$TIMEALBUMCURRENT

x

(x?)

x

The time played the current album.

MP3: Currently played time towards ALL MP3 music. How to do this?

$TIMEALBUMTOTAL

x

(x?)

x

The total time of the current album.

MP3: The total length of ALL MP3 music. How to do this?

$TIMECURRENT

x

x

x

x

x

Time of currently played item. Format 'mm:ss' and if time is longer than 59 minutes, the format is 'hh:mm:ss'.

$TIMELEFT

x

x

x

x

x

The time to play the currently played item. Format 'mm:ss' and if time is longer than 59 minutes, the format is 'hh:mm:ss'.

$TIMEPERCENT

x

x

x

x

x

Time played vs time total (0-100).

$TIMETOTAL

x

x

x

x

x

Total time of the currently played item. Format 'mm:ss' and if time is longer than 59 minutes, the format is 'hh:mm:ss'.

cmdNONE

cmdMP3SELECT

A selection screen state is activated. This will do normal scan and create a playlist of found songs* to play.

val: <not used>
modName: sectionname

ACTION="cmdMP3SELECT|MP3"

For developers:
SendCmd(cmdMP3SELECT,0,'MP3');

*) or movies or dvds

cmdMP3

MokCC starts playing the first song* found from the path specified in mok.ini's sectionname.

val: -1 use the selected song* selected in cmdMP3SELECT.
val: >=0 select the song* number in list at position val.
modName: sectionname

ACTION="cmdMP3|MP3"

For developers:
SendCmd(cmdMP3,-1,'MP3');

*) or movie or dvd

cmdMP3JUKEBOX

not implemented yet

cmdDVDSELECT

see: cmdMP3SELECT

cmdDVD

see: cmdMP3

cmdMOVIESELECT

see: cmdMP3SELECT

cmdMOVIE

see: cmdMP3

cmdCD

MokCC starts playing the CD audio disk inserted.

val: <not used>
modName: sectionname

ACTION="cmdCD|CDAUDIO"

For developers:
SendCmd(cmdCD,-1,'CDAUDIO');

cmdSTOP

Current action is stopped and we return to previous state.

val: <not used>
modName: <not used>

ACTION="cmdSTOP"

For developers:
SendCmd(cmdSTOP,0,'');
- cmdSTOP in MP3 selection screen, will return you to mainmenu.
- cmdSTOP in MP3 play screen, will return you to MP3 selection screen if it was used. Otherwise, we return to mainmenu.

cmdSCREENSAVER

MokCC activates screensaver state. Any keypress will return back to the previous state. Use only from mainmenu state. The screensaver name is always module specific so be careful when assigning this. All modules should have a default screensaver (eg. empty screen) which is run during screensaver state.

Note that this has nothing to do with Windows screensavers.

val: <not used>
modName: screensaver name

ACTION="cmdSCREENSAVER"

For developers:
SendCmd(cmdSCREENSAVER,0,'ss001');

cmdCYCLETIME

(not to be used with ACTION)

Set MokCC cycletime. MokCC has a default (1000ms) cycletime when it calls dll's to update lists and other information. When returning to a previous state with either kSTOP or cmdSTOP, cycletime will be reset back to the default value.

val: cycletime to set in ms.
modName: <not used>

ACTION="cmdCYCLETIME|500"

For developers:
SendCmd(cmdCYCLETIME,500,'');
A new cycle time of 500ms is set. Core will call dll's in 500ms cycles.

cmdSHUTDOWN

Forces a powerdown (& shutdown) for Windows. Any unsaved data will be lost.

val: <not used>
modName: <not used>

ACTION="cmdSHUTDOWN"

For developers:
SendCmd(cmdSHUTDOWN,0,'');

cmdCLOSEMOKCC

Closes MokCC nicely and returns to Windows.

val: <not used>
modName: <not used>

ACTION="cmdCLOSEMOKCC"

For developers:
SendCmd(cmdCLOSEMOKCC,0,'');

cmdERRORDONE

Sends an acknowledge that the error was read. In normal usage MokCC will show the error for 10 seconds (10*cycletime) and return to previous state. With this, the user can acknowledge the error and return from the error.

val: <not used>
modName: <not used>

ACTION="cmdERRORDONE"

For developers:
SendCmd(cmdERRORDONE,0,'');

cmdTHIRDPARTY

A third party program is started by MokCC. When the started program is stopped, MokCC will return to previous state. You can send cmdSTOP or press kSTOP to close the program and return to previous state. Note that any unsaved data will cause a popup that you can not close with Mok.

The modName includes the path and name for the program. Any parameters are put after the filename. Filename and parameters are separated with | (pipe).

val: <not used>
modName: path\file.exe
modName: path\file.exe|parameters

ACTION="third|xmlpage.txt|thirdparty.exe|parameters" (see also ACTION)

For developers:
SendCmd(cmdTHIRDPARTY,0,'c:\winnt\notepad.exe);
SendCmd(cmdTHIRDPARTY,0,'c:\winnt\notepad.exe|c:\file.txt');

cmdHTTPGET

(not to be used with ACTION)

File is loaded from internet by MokCC. It is possible to send multiple cmdHTTPGET at once to load a larger amount of files. MokCC will load them 'as fast as possible' and eventually the file is ready. The only way to see if the file is ready, is to poll for the existence of the file.

All parameters are separated with | (pipe).

val: <not used>
modName: filename|fileurl.html
modName: filename|fileurl.html|parent.html
modName: filename|fileurl.html|parent.html|parentpath
- filename: (mandatory) The name where the file is saved.
- fileurl: (mandatory) The url for the file to download. If using parent.html, wildcards '?' and '*' can be used.
- parent.html: The url of the html that contains the image. Before downloading the fileurl, parent.html is parsed to find the correct fileurl-filename. This is useful if you're want to show changing data (eg. weather).
- parentpath: The path to add to the fileurl. The file to download will be parentpath+fileurl.

All examples below results in the same download:
---
SendCmd(image.gif|http://www.google.fi/images/hp0.gif,0,'');
- An image http://www.google.fi/images/hp0.gif is loaded into image.gif
---
SendCmd(image.gif|hp0.gif||http://www.google.fi/images/,0,'');
- An image is loaded from parentpath+fileurl (http://www.google.fi/images/ + hp0.gif) is loaded into image.gif
---
SendCmd(image.gif|images/hp?.gif|http://www.google.fi/index.html|http://www.google.fi/,0,'');
- First the html file from http://www.google.fi/index.html is loaded.
- Then we search for first occurrence of images/hp?.gif. This will return 'images/hp0.gif'
- Parentpath is added to the parsed filename http://www.google.fi/ + images/hp0.gif resulting in http://www.google.fi/images/hp0.gif
- An image http://www.google.fi/images/hp0.gif is loaded into image.gif

cmdKEY

Sends a keypress from module to MokCC. This is handled as a normal keypress, similar to a key sent from a remote controller. This will override key sent via external parties (eg. remote controller software Girder).

val: Tkey, see <xxx> for key definitions.
modName: <not used>

ACTION="cmdKEY|kSTOP"

For developers:
SendCmd(cmdKEY,integer(kStop),'');