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

94
• GetBestMode(connector As String) As String
• GetMode() As String: Returns the current video mode of the device, which is specified using the SetMode()
method.
• GetModeForNextBoot() As String: Returns the target video mode of the device the next time it reboots. The
return value is specified with the
SetModeForNextBoot() method.
• Screenshot(parameters As roAssociativeArray) As Boolean: Captures a screenshot of the video
and graphics layer as a .jpeg or .bmp file in the
temp:/ directory. The screenshot process is configured by passing
an associative array of parameters to the method:
o filename: The name of the image file that will be saved.
o Width: The width dimension of the image file.
o Height: The height dimension of the image file.
Note: The default dimensions of the image file is 640x480.
o filetype: A string determining whether the image is a "JPEG" or "BMP" file type.
o quality: An integer value (between 0 and 100) that determines the image quality of the screenshot. This
parameter is set to 50 by default.
o Async: An integer value that determines whether the screenshot should be taken synchronously or
asynchronously. If set to 0, the function returns True after the image file has successfully finished writing. If
set to 1, the function will return True prior to saving the file, then return an roScreenShotComplete event
once the file has finished writing.
• GetResX() As Integer: Returns the current width of the graphics plane.
• GetResY() As Integer: Returns the current height of the graphics plane.
• GetVideoResX() As Integer: Returns the current width of the video plane.
• GetVideoResY() As Integer: Returns the current height of the video plane.
• GetOutputResX() As Integer: Returns the width of the display for the current video mode.
• GetOutputResY() As Integer: Returns the height of the display for the current video mode.
• GetSafeX() As Integer: Returns the horizontal coordinate for the upper-left corner of the "safe area". For
modes that are generally displayed with no overscan, this will be zero.