Class Signage#getFailoverMode

Signage

Class Summary
Constructor Attributes Constructor Name and Description
 
Signage#getFailoverMode(successCallback, errorCallback)

Gets Failover mode.

Class Detail

Signage#getFailoverMode(successCallback, errorCallback)

Gets Failover mode. When Failover Mode is set, monitor will automatically switch to the input source when the input signal fails, according to the predefined priorities set in the menu.

IMPORTANT NOTE!!!!


When failover is triggered due to lost signal, the signage application will not yield to the next priority input source set in the failover mode. When the signage application is destroyed, failover mode will be triggered.
function getFailoverMode() {

   var successCb = function (cbObject){
     var mode = cbObject.mode;
     var priority = cbObject.priority
     
     console.log('Failover Mode : ' + mode);
     console.log('Priority : ' + priority);
   }; 
        
   var failureCb = function(cbObject){ 
     var errorCode = cbObject.errorCode; 
     var errorText = cbObject.errorText;
      
     console.log( " Error Code [" + errorCode + "]: " + errorText); 
   }; 

   var signage = new Signage();
   signage.getFailoverMode(successCb, failureCb);
}
Parameters:
{Function} successCallback
success callback function.
{Function} errorCallback
failure callback function.
Since:
1.0
Returns:

After the method is successfully executed, successCallback is called with the following parameters

PropertyTypeDescription
modeSignage.FailoverMode | Signage.UNDEFINEDFailover mode. Signage.UNDEFINED is returned when this item is not set.
priorityArrayInput priority, as an ordered array of input source URI. Only valid when mode is set to MANUAL.
Input source can be :
NameDescription
ext://hdmi:[index]HDMI Input
ext://dvi:[index]DVI Input
ext://internal_memoryInternal Storage
ext://dp:[index]Display Port

If an error occurs, errorCallback is called with errorCode and errorText.