Roku Object Reference - imaginArt

• 12 to 13 - Comb effect vertical and horizontal
• 14 - Fade out to background color then back in
• 15 - Fade between current image and new image
• 16 to 19 - Slides from top, bottom, left and right
To display images in a zone, SetRectangle() must be called. EnableZoneSupport() must be
included in a script to use the zones functionality.
Here are some example shell commands you can try to test the different display modes:
Roku> image filename.bmp 0
Roku> image filename.bmp 1
Roku> image filename.bmp 2
Roku> image filename.bmp 3
Roku> image filename.bmp 0 0 0
Roku> image filename.bmp 2 0 0
This example script uses preloaded images to improve the UI speed when the user hits a key on the
keyboard. As soon as the keyboard is hit, then the display switches to the new image which has already
been preloaded. The only delay is if the key is hit whilst the image is pre-loading - as soon as the image is
loaded, it will then display.
i = CreateObject("roImagePlayer")
p = CreateObject("roMessagePort")
k = CreateObject("roKeyboard")
k.SetPort(p)
i.PreloadFile("one.bmp")
loop:
i.DisplayPreload()
i.PreloadFile("two.bmp")
wait(0,p)
i.DisplayPreload()
i.PreloadFile("one.bmp")
wait(0,p)
goto loop
roImageWidget can be used in place of roImagePlayer for the case where the image is displayed within a
rectangle.
When displaying roImagePlayer within a rectangle, the following code is used:
rectangle = CreateObject("roRectangle", 0, 0, 1024, 768)
i = CreateObject("roImagePlayer")
i.SetRectangle(rectangle)
When using an roImageWidget, the following code is used:
rectangle = CreateObject("roRectangle", 0, 0, 1024, 768)
i = CreateObject("roImageWidget", rectangle)
Using an roImageWidget can result in more pleasing esthetics on image player creation. Beyond this, an
roImageWidget behaves identically to an roImagePlayer as it implements the ifImageControl interface.
24