BrightSign Object Reference Manual (FW 5.1) - Manual (Page 77)

69
roImagePlayer
This object displays static bitmap images on the video display. The simplest way to use roImagePlayer is to make calls to
DisplayFile() with the filename as a String. Alternatively, you can use PreloadFile() in conjunction with
DisplayPreload() to have more control. For more pleasing aesthetics when generating an image player, use
the
roImageWidget object.
Object Creation: The image player is displayed by first creating roRectangle and roImagePlayer instances, then calling
SetRectangle() using the roRectangle instance as the argument.
rectangle = CreateObject("roRectangle", 0, 0, 1024, 768)
i = CreateObject("roImagePlayer")
i.SetRectangle(rectangle)
Interfaces: ifImageControl
The ifImageControl interface provides the following:
• DisplayFile(image_filename As String) As Boolean: Displays the image with the specified filename.
The
image_filename string must point to a .png, .jpeg, or 8-bit, 24-bit, or 32-bit .bmp file. Note that .jpeg image
files with CMYK color profiles are not supported.
• DisplayFile(parameters As roAssociativeArray) As Boolean: Displays an image using an
associative array of display parameters:
o Filename
o Mode: See the entry for SetDefaultMode() below for more details.
o Transition: See the entry for SetDefaultTransition() below for more details.