Metamorphis Scripts: Difference between revisions
No edit summary |
m (Reverted edits by LaoloBasri (Talk); changed back to last version by Gateley) |
||
(10 intermediate revisions by 2 users not shown) | |||
Line 5: | Line 5: | ||
==Metamorphis Object Commands== |
==Metamorphis Object Commands== |
||
===Functions=== |
===Functions=== |
||
void SetBitmap(string Bitmap, string TransparentColor)<br> |
'''void SetBitmap(string Bitmap, string TransparentColor)'''<br> |
||
Description: Sets image for the window. Relative paths can be used. SetBitmap function can be used to change image and region for a window.<br> |
'''Description''': Sets image for the window. Relative paths can be used. SetBitmap function can be used to change image and region for a window.<br> |
||
Parameters:<br> |
'''Parameters''':<br> |
||
:Bitmap - new bitmap file for the window.<br> |
:''Bitmap'' - new bitmap file for the window.<br> |
||
: |
:''TransparentColor''- transparent color of new image.<br> |
||
Example:<br> |
'''Example''':<br> |
||
Player.SetBitmap( "coolpic.gif", "ff00ff"); |
Player.SetBitmap( "coolpic.gif", "ff00ff"); |
||
---- |
|||
bool LoadSkinState()<br> |
|||
'''bool LoadSkinState()'''<br> |
|||
Description: Loads previously saved state of the skin, usually called in handler for OnInitialize event.<br> |
|||
'''Description''': Loads previously saved state of the skin, usually called in handler for OnInitialize event.<br> |
|||
Return Values: true if skin state was previously saved using SaveSkinState function, otherwise false.<br> |
|||
'''Return Values''': true if skin state was previously saved using SaveSkinState function, otherwise false.<br> |
|||
Example:<br> |
|||
'''Example''':<br> |
|||
if(Metamorphis.LoadSkinState() == false)<br> |
|||
if(Metamorphis.LoadSkinState() == false) |
|||
{<br> |
|||
{ |
|||
EQ.ShowWindow(true);<br> |
|||
EQ.ShowWindow(true); |
|||
}<br> |
|||
} |
|||
void SaveSkinState()<br> |
|||
---- |
|||
Description: Saves skin state, usually called in handler for OnExit event.<br> |
|||
'''void SaveSkinState()'''<br> |
|||
Example:<br> |
|||
'''Description''': Saves skin state, usually called in handler for OnExit event.<br> |
|||
Metamorphis.SaveSkinState();<br> |
|||
'''Example''':<br> |
|||
void SetStateValue(string Name, variant Value)<br> |
|||
Metamorphis.SaveSkinState(); |
|||
Description: Sets state variable. This variable will be saved in state.xml and can be retrieved when skin is loaded or at any other time. Supported types: number, string, boolean, double<br> |
|||
---- |
|||
Parameters:<br> |
|||
'''void SetStateValue(string Name, variant Value)'''<br> |
|||
Name - Name of the value to be set.<br> |
|||
'''Description''': Sets state variable. This variable will be saved in state.xml and can be retrieved when skin is loaded or at any other time. Supported types: number, string, boolean, double<br> |
|||
Value - Specifies the data to be stored.<br> |
|||
'''Parameters''':<br> |
|||
:''Name'' - Name of the value to be set.<br> |
|||
Metamorphis.SetStateValue("SomeName", "SomeValue"); |
|||
:''Value'' - Specifies the data to be stored.<br> |
|||
Metamorphis.SetStateValue("SomeName2", 1); |
|||
'''Example''':<br> |
|||
variant GetStateValue(string Name)<br> |
|||
Metamorphis.SetStateValue("SomeName", "SomeValue"); |
|||
Description: Retrieves previously set state value. Supported types: number, string, boolean, double<br> |
|||
Metamorphis.SetStateValue("SomeName2", 1); |
|||
Parameters:<br> |
|||
---- |
|||
Name - Name of the value to be retrieved.<br> |
|||
'''variant GetStateValue(string Name)'''<br> |
|||
Return Values: the value's data<br> |
|||
'''Description''': Retrieves previously set state value. Supported types: number, string, boolean, double<br> |
|||
Example:<br> |
|||
'''Parameters''':<br> |
|||
var SoveValue = Metamorphis.GetStateValue("SomeName"); |
|||
:''Name'' - Name of the value to be retrieved.<br> |
|||
// check if value was previously set |
|||
'''Return Values''': the value's data<br> |
|||
if( SomeValue == null) // value was not set |
|||
'''Example''':<br> |
|||
{ |
|||
var SoveValue = Metamorphis.GetStateValue("SomeName"); |
|||
... do something |
|||
// check if value was previously set |
|||
} |
|||
if( SomeValue == null) // value was not set |
|||
long StartTimer(long Timeout, string FunctionName)<br> |
|||
{ |
|||
Description: This function creates a timer with the specified time-out value.<br> |
|||
... do something |
|||
} |
|||
Timeout - specifies the time-out value, in milliseconds<br> |
|||
---- |
|||
FunctionName - name the function to be notified when the time-out value elapses.<br> |
|||
'''long StartTimer(long Timeout, string FunctionName)'''<br> |
|||
Return Values: Identifier of the new timer.<br> |
|||
'''Description''': This function creates a timer with the specified time-out value.<br> |
|||
Example:<br> |
|||
'''Parameters''':<br> |
|||
var TimerID = Metamorphis.StartTimer(1000, DoExtraCoolStuff ); |
|||
:''Timeout'' - specifies the time-out value, in milliseconds<br> |
|||
void StopTimer(long TimerID)<br> |
|||
:''FunctionName'' - name the function to be notified when the time-out value elapses.<br> |
|||
Description: The function destroys the specified timer.<br> |
|||
'''Return Values''': Identifier of the new timer.<br> |
|||
Parameters:<br> |
|||
'''Example''':<br> |
|||
TimerID- Identifier of the timer.<br> |
|||
var TimerID = Metamorphis.StartTimer(1000, DoExtraCoolStuff ); |
|||
Example:<br> |
|||
---- |
|||
Metamorphis.StopTimer(TimerID ); |
|||
'''void StopTimer(long TimerID)'''<br> |
|||
bool IsAlwaysOnTop ()<br> |
|||
'''Description''': The function destroys the specified timer.<br> |
|||
'''Parameters''':<br> |
|||
Return Values: 0 - off, 1- on<br> |
|||
:''TimerID''- Identifier of the timer.<br> |
|||
Example:<br> |
|||
'''Example''':<br> |
|||
var State = Metamorphis.IsAlwaysOnTop(); |
|||
Metamorphis.StopTimer(TimerID ); |
|||
void Minimize()<br> |
|||
---- |
|||
Description: Minimizes the skin.<br> |
|||
'''bool IsAlwaysOnTop ()'''<br> |
|||
void Maximize()<br> |
|||
'''Description''': Retrieves Always on State state<br> |
|||
'''Return Values''': 0 - off, 1- on<br> |
|||
'''Example''':<br> |
|||
Description: Closes Media Jukebox.<br> |
|||
var State = Metamorphis.IsAlwaysOnTop(); |
|||
void Restore()<br> |
|||
'''void Minimize()'''<br> |
|||
Description: If a skin was minimized it will be restored.<br> |
|||
'''Description''': Minimizes the skin.<br> |
|||
bool IsMinimized()<br> |
|||
'''void Maximize()'''<br> |
|||
Description: Returns true if a skin is minimized.<br> |
|||
'''Description''': Returns Media Jukebox to MEGA-ME state.<br> |
|||
void EnableTooltips(bool bEnable)<br> |
|||
'''void Close()'''<br> |
|||
Description: Turns tooltips on and off.<br> |
|||
'''Description''': Closes Media Jukebox.<br> |
|||
Parameters:<br> |
|||
'''void Restore()'''<br> |
|||
bEnable - true(default) - to turn tooltips on, false - to turn tooltips off<br> |
|||
'''Description''': If a skin was minimized it will be restored.<br> |
|||
long GetScreenWidth()<br> |
|||
'''bool IsMinimized()'''<br> |
|||
Description: retrieves screen width.<br> |
|||
'''Description''': Returns true if a skin is minimized.<br> |
|||
long GetScreenHeight()<br> |
|||
'''void EnableTooltips(bool bEnable)'''<br> |
|||
Description: retrieves screen height.<br> |
|||
'''Description''': Turns tooltips on and off.<br> |
|||
long GetScreenLeft()<br> |
|||
'''Parameters''':<br> |
|||
Description: retrieves screen left.<br> |
|||
:''bEnable'' - true(default) - to turn tooltips on, false - to turn tooltips off<br> |
|||
long GetScreenTop()<br> |
|||
'''long GetScreenWidth()'''<br> |
|||
Description: retrieves screen top.<br> |
|||
'''Description''': retrieves screen width.<br> |
|||
'''long GetScreenHeight()'''<br> |
|||
'''Description''': retrieves screen height.<br> |
|||
'''long GetScreenLeft()'''<br> |
|||
'''Description''': retrieves screen left.<br> |
|||
'''long GetScreenTop()'''<br> |
|||
'''Descriptio'''n: retrieves screen top.<br> |
|||
==Window Commands== |
==Window Commands== |
||
===Functions=== |
===Functions=== |
||
'''void SetWindowPos( long x, long y)'''<br> |
|||
'''Description''': Sets position of the window to x, y point.<br> |
|||
'''Parameters''':<br> |
|||
:''x'' , ''y'' - coordinates are Desktop coordinates.<br> |
|||
'''Example''':<br> |
|||
Playlist.SetWindowPos(101, 107); |
|||
'''void ShowWindow(bool ShowCommand)'''<br> |
|||
'''Description''': Changes visual state of the window.<br> |
|||
'''Parameters''':<br> |
|||
:''ShowCommand'' - true - Show, false - Hide<br> |
|||
'''Example''':<br> |
|||
Playlist.ShowWindow(true); |
|||
'''void MoveWindowAnimated(long OffsetX, long OffsetY, long Speed)'''<br> |
|||
'''Description''': Moves the window from current point to x+OffsetX and y+OffsetY<br> |
|||
'''Parameters''':<br> |
|||
:''Speed'' - value from 1 to 100, determines how fast the movement will be performed.<br> |
|||
'''Example''':<br> |
|||
Equalizer.ShowWindowAnimated(101, 0, -100, 107, 4); |
|||
'''void SetWindowBehind(Object Window)'''<br> |
|||
'''Description''': Changes ZOrder of the window, by inserting the window behind specified window.<br> |
|||
'''Parameters''':<br> |
|||
:''Window'' - one of Window objects of the skin, for example 'Player'<br> |
|||
'''Example''':<br> |
|||
Equalizer.SetWindowBehind(Player); |
|||
'''void GetSkinItem(long MainType, string Name)'''<br> |
|||
'''Description''':<br> |
|||
'''Parameters''':<br> |
|||
:''MainType'' - 0 - Button, 1 - Placeholder, 2 - Slider, 3 - InfoDisplay<br> |
|||
'''Example''':<br> |
|||
Player.GetSkinItem(0, "ShowEqualizer").SetItemState("Show"); |
|||
'''bool IsWindowVisible()'''<br> |
|||
'''Description''': The function retrieves the visibility state of the specified window.<br> |
|||
Example:<br> |
|||
===Properties=== |
===Properties=== |
||
'''long Left'''<br> |
|||
'''Description''':<br> |
|||
'''Example''':<br> |
|||
var x = Player.PositionX; |
|||
'''long Top'''<br> |
|||
'''Description''':<br> |
|||
'''Example''':<br> |
|||
var y = Player.PositionY; |
|||
'''long Width''' |
|||
'''Example''':<br> |
|||
var Width = Player.Width; |
|||
Example:<br> |
|||
'''long Height'''<br> |
|||
var Width = Player.Width; |
|||
'''Example''':<br> |
|||
var Height = Player.Height; |
|||
Description:<br> |
|||
Example:<br> |
|||
var Height = Player.Height; |
|||
==SkinItem Commands== |
==SkinItem Commands== |
||
To get skin item use GetSkinItem function |
To get skin item use GetSkinItem function |
||
===Functions=== |
===Functions=== |
||
'''void SetPosition(long x, long y)'''<br> |
|||
'''Description''': Sets new position of the skin item.<br> |
|||
'''Parameters''':<br> |
|||
:''x'', ''y'' - new coordinates, coordinates of the item..<br> |
|||
'''Example''':<br> |
|||
Player.GetSkinItem(0, "HidePlaylist").SetPosition(10, 100); |
|||
'''void SetBitmap(string Bitmap, string TransparentColor)'''<br> |
|||
'''Description''': Sets image for the item. That property can be used with Buttons and Placeholders. Relative paths can be used. If used with Placeholder, this function will change painting region of the item.<br> |
|||
'''Parameters''':<br> |
|||
:''Bitmap'' - new bitmap file for the item.<br> |
|||
:''TransparentColor''- transparent color of new image.<br> |
|||
'''Example''':<br> |
|||
Player.GetSkinItem(0, "Play").SetBitmap( "coolpic.gif", "ffffff"); |
|||
'''void SetPicture(string Picture)'''<br> |
|||
'''Description''': Sets picture for the Pictureholder(Picture) item. Relative paths can be used.<br> |
|||
'''Parameters''':<br> |
|||
:''Picture''- new picture file for the item. Animated gif files can be used in this case.<br> |
|||
'''Example''':<br> |
|||
Player.GetSkinItem(1, "Picture1").SetBitmap( "Animation.gif"); |
|||
'''bool IsVisible()'''<br> |
|||
'''Description''': The function retrieves the visibility state of the specified skin item.<br> |
|||
'''bool IsDisabled()'''<br> |
|||
Example: |
|||
'''Description''': The function determines whether the specified skin item is disabled for mouse and keyboard input.<br> |
|||
bool IsDisabled()<br> |
|||
Description: The function determines whether the specified skin item is disabled for mouse and keyboard input.<br> |
|||
Example: |
|||
===Properties=== |
===Properties=== |
||
'''long State'''<br> |
|||
'''Description''': Changes state of skin item.<br> |
|||
'''Parameters''': 1 - Normal, 2 - Pressed, 3 - Disabled, 4 - Hidden. NOTE: Pressed state can only be set for button items.<br> |
|||
'''Example''':<br> |
|||
Player.GetSkinItem(0, "ShowEqualizer").State = 2; |
|||
'''long Left'''<br> |
|||
'''Description''': Gets and sets left position of item<br> |
|||
'''Example''':<br> |
|||
Player.GetSkinItem(0, "ShowEqualizer").Left = 10; |
|||
'''long Top'''<br> |
|||
'''Description''': Gets and sets top position of item<br> |
|||
'''Example''':<br> |
|||
Player.GetSkinItem(0, "ShowEqualizer").Top = 10; |
|||
'''long Width'''<br> |
|||
'''Description''': Gets and sets width of item<br> |
|||
'''Example''':<br> |
|||
Player.GetSkinItem(0, "ShowEqualizer").Width = 100; |
|||
'''long Height'''<br> |
|||
'''Description''': Gets and sets Height of item<br> |
|||
'''Example''':<br> |
|||
Player.GetSkinItem(0, "ShowEqualizer").Height = 100; |
|||
'''string Tooltip'''<br> |
|||
'''Description''': Gets and sets tooltip of item<br> |
|||
'''Example''':<br> |
|||
Player.GetSkinItem(0, "ShowEqualizer").Tooltip = "Cool"; |
|||
'''string Text'''<br> |
|||
'''Description''': Gets and sets text of an item. NOTE: This property can be used only with InfoDisplay items. Also, trackinfo keywords can be passed to this property.<br> |
|||
'''Example''':<br> |
|||
Player.GetSkinItem(3, "ShowEqualizer").Tooltip = "Cool"; |
|||
'''long SliderPosition'''<br> |
|||
'''Description''': Gets and sets slider position. Range for the property is 0 to 100. NOTE: This property can be used only with Slider items<br> |
|||
'''Example''':<br> |
|||
Player.GetSkinItem(3, "Volume").SliderPosition = 10; |
Latest revision as of 16:06, 14 January 2008
Metamorphis Scripts requires MJ 8.0.253 and above, or any version of Media Center.
Metamorphis uses JScript to do scripting. There are multiple objects which JScript can access: Metamorphis, Window ( exact name depends on window name, for example if you have window called Player in you Main.xml file that name of the object will be Player), MJAutomation (you can access many object through MJAutomation object see Interface Plug-ins SDK)
Metamorphis Object Commands
Functions
void SetBitmap(string Bitmap, string TransparentColor)
Description: Sets image for the window. Relative paths can be used. SetBitmap function can be used to change image and region for a window.
Parameters:
- Bitmap - new bitmap file for the window.
- TransparentColor- transparent color of new image.
Example:
Player.SetBitmap( "coolpic.gif", "ff00ff");
bool LoadSkinState()
Description: Loads previously saved state of the skin, usually called in handler for OnInitialize event.
Return Values: true if skin state was previously saved using SaveSkinState function, otherwise false.
Example:
if(Metamorphis.LoadSkinState() == false) { EQ.ShowWindow(true); }
void SaveSkinState()
Description: Saves skin state, usually called in handler for OnExit event.
Example:
Metamorphis.SaveSkinState();
void SetStateValue(string Name, variant Value)
Description: Sets state variable. This variable will be saved in state.xml and can be retrieved when skin is loaded or at any other time. Supported types: number, string, boolean, double
Parameters:
- Name - Name of the value to be set.
- Value - Specifies the data to be stored.
Example:
Metamorphis.SetStateValue("SomeName", "SomeValue"); Metamorphis.SetStateValue("SomeName2", 1);
variant GetStateValue(string Name)
Description: Retrieves previously set state value. Supported types: number, string, boolean, double
Parameters:
- Name - Name of the value to be retrieved.
Return Values: the value's data
Example:
var SoveValue = Metamorphis.GetStateValue("SomeName"); // check if value was previously set if( SomeValue == null) // value was not set { ... do something }
long StartTimer(long Timeout, string FunctionName)
Description: This function creates a timer with the specified time-out value.
Parameters:
- Timeout - specifies the time-out value, in milliseconds
- FunctionName - name the function to be notified when the time-out value elapses.
Return Values: Identifier of the new timer.
Example:
var TimerID = Metamorphis.StartTimer(1000, DoExtraCoolStuff );
void StopTimer(long TimerID)
Description: The function destroys the specified timer.
Parameters:
- TimerID- Identifier of the timer.
Example:
Metamorphis.StopTimer(TimerID );
bool IsAlwaysOnTop ()
Description: Retrieves Always on State state
Return Values: 0 - off, 1- on
Example:
var State = Metamorphis.IsAlwaysOnTop();
void Minimize()
Description: Minimizes the skin.
void Maximize()
Description: Returns Media Jukebox to MEGA-ME state.
void Close()
Description: Closes Media Jukebox.
void Restore()
Description: If a skin was minimized it will be restored.
bool IsMinimized()
Description: Returns true if a skin is minimized.
void EnableTooltips(bool bEnable)
Description: Turns tooltips on and off.
Parameters:
- bEnable - true(default) - to turn tooltips on, false - to turn tooltips off
long GetScreenWidth()
Description: retrieves screen width.
long GetScreenHeight()
Description: retrieves screen height.
long GetScreenLeft()
Description: retrieves screen left.
long GetScreenTop()
Description: retrieves screen top.
Window Commands
Functions
void SetWindowPos( long x, long y)
Description: Sets position of the window to x, y point.
Parameters:
- x , y - coordinates are Desktop coordinates.
Example:
Playlist.SetWindowPos(101, 107);
void ShowWindow(bool ShowCommand)
Description: Changes visual state of the window.
Parameters:
- ShowCommand - true - Show, false - Hide
Example:
Playlist.ShowWindow(true);
void MoveWindowAnimated(long OffsetX, long OffsetY, long Speed)
Description: Moves the window from current point to x+OffsetX and y+OffsetY
Parameters:
- Speed - value from 1 to 100, determines how fast the movement will be performed.
Example:
Equalizer.ShowWindowAnimated(101, 0, -100, 107, 4);
void SetWindowBehind(Object Window)
Description: Changes ZOrder of the window, by inserting the window behind specified window.
Parameters:
- Window - one of Window objects of the skin, for example 'Player'
Example:
Equalizer.SetWindowBehind(Player);
void GetSkinItem(long MainType, string Name)
Description:
Parameters:
- MainType - 0 - Button, 1 - Placeholder, 2 - Slider, 3 - InfoDisplay
Example:
Player.GetSkinItem(0, "ShowEqualizer").SetItemState("Show");
bool IsWindowVisible()
Description: The function retrieves the visibility state of the specified window.
Properties
long Left
Description:
Example:
var x = Player.PositionX;
long Top
Description:
Example:
var y = Player.PositionY;
long Width
Example:
var Width = Player.Width;
long Height
Example:
var Height = Player.Height;
SkinItem Commands
To get skin item use GetSkinItem function
Functions
void SetPosition(long x, long y)
Description: Sets new position of the skin item.
Parameters:
- x, y - new coordinates, coordinates of the item..
Example:
Player.GetSkinItem(0, "HidePlaylist").SetPosition(10, 100);
void SetBitmap(string Bitmap, string TransparentColor)
Description: Sets image for the item. That property can be used with Buttons and Placeholders. Relative paths can be used. If used with Placeholder, this function will change painting region of the item.
Parameters:
- Bitmap - new bitmap file for the item.
- TransparentColor- transparent color of new image.
Example:
Player.GetSkinItem(0, "Play").SetBitmap( "coolpic.gif", "ffffff");
void SetPicture(string Picture)
Description: Sets picture for the Pictureholder(Picture) item. Relative paths can be used.
Parameters:
- Picture- new picture file for the item. Animated gif files can be used in this case.
Example:
Player.GetSkinItem(1, "Picture1").SetBitmap( "Animation.gif");
bool IsVisible()
Description: The function retrieves the visibility state of the specified skin item.
bool IsDisabled()
Description: The function determines whether the specified skin item is disabled for mouse and keyboard input.
Properties
long State
Description: Changes state of skin item.
Parameters: 1 - Normal, 2 - Pressed, 3 - Disabled, 4 - Hidden. NOTE: Pressed state can only be set for button items.
Example:
Player.GetSkinItem(0, "ShowEqualizer").State = 2;
long Left
Description: Gets and sets left position of item
Example:
Player.GetSkinItem(0, "ShowEqualizer").Left = 10;
long Top
Description: Gets and sets top position of item
Example:
Player.GetSkinItem(0, "ShowEqualizer").Top = 10;
long Width
Description: Gets and sets width of item
Example:
Player.GetSkinItem(0, "ShowEqualizer").Width = 100;
long Height
Description: Gets and sets Height of item
Example:
Player.GetSkinItem(0, "ShowEqualizer").Height = 100;
string Tooltip
Description: Gets and sets tooltip of item
Example:
Player.GetSkinItem(0, "ShowEqualizer").Tooltip = "Cool";
string Text
Description: Gets and sets text of an item. NOTE: This property can be used only with InfoDisplay items. Also, trackinfo keywords can be passed to this property.
Example:
Player.GetSkinItem(3, "ShowEqualizer").Tooltip = "Cool";
long SliderPosition
Description: Gets and sets slider position. Range for the property is 0 to 100. NOTE: This property can be used only with Slider items
Example:
Player.GetSkinItem(3, "Volume").SliderPosition = 10;