API: Display HTML & Documents on External Screen

kp_ExternalScreen_getBrowserBgColor(callback);
		

callback(backgroundColor);
		

• backgroundColor - [string] the background color or image to be shown on the external display prior to a file being opened or if a file does not fill the screen. Can be returned as:
• R,G,B - the background color set in R,G,B format
• image file - the file path to the desired background image. If local, this path will be relative to the Kiosk Pro documents folder (rather than relative to the file calling the function). If remote, this will be the full URL

kp_ExternalScreen_setBrowserBgColor(backgroundColor, callback);
		

• backgroundColor - [string] the background color or image to be shown on the external display prior to a file being opened or if a file does not fill the screen. Can be set as:
• R,G,B - [string] the background color set in R,G,B format
• image file - [string] the file path to the desired background image. If local, this path should be relative to the Kiosk Pro documents folder (rather than relative to the file calling the function). If remote, this should be the full URL
• callback - [string] the name of the callback to be triggered after the function has been executed

callback(success);
		

• success - [integer] indicating whether the background was successfully updated. Possible values are:
• 0 - the background was unable to update
• 1 - the background successfully updated

kp_ExternalScreen_openDocument(filePath, сallback);
		

• filePath - [string] the file path to the desired file. If local, this path should be relative to the Kiosk Pro documents folder (rather than relative to the file calling the function). If remote, this should be the full URL
• callback - [string] the name of the callback to be triggered after the function has been executed

callback(jobWasAccepted);
		

• jobWasAccepted - [integer] indicating whether the external display is linked and returned no errors. Possible values are:
• 0 = indicates an external display is not linked
• 1 = indicates external display is linked and returned no errors. Note that, even if this returns 1, it is not guaranteed that the external display showed content properly (if, for instance, path to the content was set incorrectly or content does not exist)

kp_ExternalScreen_showImage(filepath, contentMode, callback);
		

• filepath - [string] file path of the image to be shown. If local, this path should be relative to the Kiosk Pro documents folder (rather than relative to the file calling the function). If remote, this should be the full URL
• contentMode - [integer] indicating how the image should be displayed. Possible values are:
• 0 = Scale to fill - image will fill the screen. If the image does not match the screen resolution, it will be scaled to fill the screen, and the image may be distorted
• 1 = Aspect fit - image will fit the screen while maintaining the aspect ratio. If the image does not match the screen's aspect ratio, some areas of the screen will be empty
• 2 = Aspect fill - image will fill the screen. If the image does not match the screen resolution, it will be scaled until the screen is filled while maintaining the aspect ratio
• 3 = image is centered horizontally & vertically without scaling
• 4 = image is placed at the top center of the screen without scaling
• 5 = image is placed at the bottom center of the screen without scaling
• 6 = image is placed at the center left of the screen without scaling
• 7 = image is placed at the center right of the screen without scaling
• 8 = image is placed at the top left of the screen without scaling
• 9 = image is placed at the top right of the screen without scaling
• 10 = image is placed at the bottom left of the screen without scaling
• 11 = image is placed at the bottom right of the screen without scaling
• callback - [string] the name of the callback to be triggered after the function has been executed

callback(success);
		

• success - [integer] indicating whether the image was successfully displayed. Possible values are:
• 0 - specified image failed to be displayed
• 1 - specified image displayed successfully

kp_ExternalScreen_doJScript(script);
		

kp_ExternalScreen_requestNumberOfPdfPages(callback);
		

callback(numberOfPages);
		

kp_ExternalScreen_requestNumberOfCurrentPdfPage(callback);
		

callback(pageNumber);
		

kp_ExternalScreen_showPdfPage(pageNumber, callback);
		

• pageNumber - [integer] indicating the number of the page which should be shown. Should belong to the set [1..N] where N = max page number (which can be queried using kp_ExternalScreen_requestNumberOfPdfPages
• callback - [string] the name of the callback to be triggered with the result

callback(success);
		

• success - [integer] indicating whether the navigation was successfully. Possible values are:
• 0 - specified page was not shown
• 1 - navigated to the specified page successfully

kp_ExternalScreen_didOpenFileSuccessfully(sourceDocumentPath, usedDocumentPath);
		

• sourceDocumentPath - [string] the filepath passed to Kiosk Pro to open
• usedDocumentPath - [string] the filepath Kiosk Pro used to access the file. For example, if a user sets a path to a local PDF that doesn't exist Kiosk Pro will transform it to a remote URL by adding 'http://'

kp_ExternalScreen_didOpenFileWithError(sourceDocumentPath, usedDocumentPath, error);
		

• sourceDocumentPath - [string] the filepath passed to Kiosk Pro to open
• usedDocumentPath - [string] the filepath Kiosk Pro used to access the file. For example, if a user sets a path to a local PDF that doesn't exist Kiosk Pro will transform it to a remote URL by adding 'http://'
• error - returned as an associative array: {‘domain’:value, ‘code’:value, ‘description’:value, 'failureReason':value, 'recoverySuggestion':value, 'debugDescription':value}
• domain - [string] representing where the error occurred
• code - [string] the identifier for the error
• description - [string] a brief description of the error
• failureReason - [string, optional, may return as empty] the reason for the error
• recoverySuggestion - [string, optional, may return as empty] the suggested solution
• debugDescription - [string, optional, may return as empty] a detailed description of the error