Shayton Equilibrium Kitchen Utensil 2003 User Manual

Page of 194
82 
 Chapter 3 
• 
• 
• 
Parameters
Source
 - specifies the image to add by its user-defined Media object name.If you are 
adding an image that you have not yet loaded, use the Name parameter to refer to that 
image by its name and extension (such as “airplane.jpg”). 
Name
 - if you or the administrator has set up virtual file systems, you can use this 
parameter to add frames from that file system. Virtual file systems are defined in the 
MediaRich server’s local.properties file. See the MediaRich Administrator’s Guide for 
more information.
For example, if you define “MyImages:” to represent the path “C:/Images/MyImages/” 
in the local.properties file, you can use files from the MyImages directory with the 
frameAdd()
 function:
image.frameAdd(name @ "MyImages:/split.tga");
NOTE: 
The Name parameter has been deprecated.
Duration
 - specifies the frame duration in seconds. This sets the duration of the frame in 
our internal structure. Specifying this does not currently do anything useful.
Example
var image = new Media();
var image2 = new Media();
image.load(name @ "peppers.tga");
image2.load(name @ "Bears.tga");
image.frameAdd(Source @ image2);
image.reduce();
image.save(type @ "gif");
g e t B i t s P e r S a m p l e ( )
Returns the number of bits per sample.
Syntax
<object name>.getBitsPerSample();
Parameters
This function has no parameters.
Example
if (image.getBitsPerSample() == 8)
{... 
g e t B y t e s P e r P i x e l ( )
Returns the number of bytes per pixel.
Syntax
<object name>.getBytesPerPixel();
Parameters
This function has no parameters.