Controller (revelplayer API)

```
public interface Controller
```
The Controller is the primary interface into the player engine. It is accessible from script via the Controller global variable.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addConnectivityListener(ConnectivityListener listener)` Adds a connectivity listener interface for receiving internet connectivity events.
`void`	`addOnBeaconListener(OnBeaconListener listener)` Adds a beacon listener interface to receive beacon enter/exit events.
`void`	`addOnCommandListener(OnCommandListener listener)` Adds a command listener interface to receive service and user command.
`void`	`addOnImpressionListener(OnImpressionListener listener)` Adds the on impression listener.
`void`	`addOnMotionListener(OnMotionListener listener)` Adds a beacon listener interface to receive motion events.
`void`	`addOnPlayedListener(OnPlayedListener listener)` Adds a played listener interface to receive media played events.
`void`	`addTemplateListener(TemplateListener listener)` Adds a template listener interface to receive template related events.
`java.lang.String`	`converse()` Trigger recording of audio and send result to DialogFlow.
`Device`	`getDevice()` Returns information related to the device currently running the script.
`java.lang.String`	`getDeviceKey()` Returns the unique identifier (GUID) for this device.
`java.util.Date`	`getDeviceTime()` Current time based on the device time zone.
`java.util.Date`	`getDeviceTime(java.util.Date date)` Adjusts the supplied date to the device time zone.
`Command`	`getLastCommand()` Gets the last command issues to the player.
`OkHttpClient`	`getOkHttpClient()` Returns an OkHttp client for making HTTP method calls in scripting
`Schedule`	`getSchedule()` Returns the active schedule or null if nothing is scheduled for the current time.
`Template`	`getTemplate()` Currently scheduled template.
`int`	`getVersionCode()` Returns the version of the player app.
`boolean`	`isConnected()` Determine if the player has Internet connectivity.
`java.lang.String`	`newEventSession()` Starts a new event session using a generated id.
`void`	`newEventSession(java.lang.String id)` Starts a new event session using the provided id.
`void`	`print(byte[] data)` Sends a raw print command to the USB connected printer.
`void`	`print(java.lang.String text, boolean cut)`
`void`	`removeConnectivityListener(ConnectivityListener listener)` Removes a previously added listener for connectivity events.
`void`	`removeOnBeaconListener(OnBeaconListener listener)` Removes a previously added listener for beacon events.
`void`	`removeOnCommandListener(OnCommandListener listener)` Removes a previously added listener for command events.
`void`	`removeOnImpressionListener(OnImpressionListener listener)` Removes the on impression listener.
`void`	`removeOnMotionListener(OnMotionListener listener)` Removes a previously added listener for motion events.
`void`	`removeOnPlayedListener(OnPlayedListener listener)` Removes a previously added listener for media played events.
`void`	`removeTemplateListener(TemplateListener listener)` Removes a previously added template listener interface.
`void`	`sendCommand(java.lang.String name, java.lang.String arg)` Sends a command to the Controller.
`void`	`sendRemoteCommand(java.lang.String[] registrationKeys, java.lang.String name, java.lang.String arg)` Sends a command to remote devices identified by their registration keys.
`void`	`setBrightness(int level)` Sets the screen brightness.
`void`	`setVolume(int level)` Sets the master volume for app.
`void`	`timeEvent(java.lang.String eventName)` Time an event by including the time between this call and a later 'track' call.
`void`	`track(java.lang.String eventName, java.util.Map<java.lang.String,java.lang.Object> properties)` Sends an event to the server with an optional map for additional event properties.

- Method Detail
  - getDeviceKey
```
java.lang.String getDeviceKey()
```
    Returns the unique identifier (GUID) for this device.
    
    Returns:
    
    unique device identifier
  - getDeviceTime
```
java.util.Date getDeviceTime()
```
    Current time based on the device time zone.
    
    Returns:
    
    current device time
  - getOkHttpClient
```
OkHttpClient getOkHttpClient()
```
    Returns an OkHttp client for making HTTP method calls in scripting
    
    Returns:
    
    OkHttp client
  - getDeviceTime
```
java.util.Date getDeviceTime(java.util.Date date)
```
    Adjusts the supplied date to the device time zone.
    
    Parameters:
    
    date -
    
    Returns:
    
    the adjusted date
  - getVersionCode
```
int getVersionCode()
```
    Returns the version of the player app.
    
    Returns:
    
    player app version code
  - getDevice
```
Device getDevice()
```
    Returns information related to the device currently running the script.
    
    Returns:
    
    the device
  - getTemplate
```
Template getTemplate()
```
    Currently scheduled template. If no template is scheduled this method will return null.
    
    Returns:
    
    currently scheduled template or null
  - getSchedule
```
Schedule getSchedule()
```
    Returns the active schedule or null if nothing is scheduled for the current time.
    
    Returns:
    
    current schedule or null
  - print
```
void print(byte[] data)
```
    Sends a raw print command to the USB connected printer. Currenly compatible with the MASUNG MS-FPT301
    
    Parameters:
    
    data - command data
  - print
```
void print(java.lang.String text,
           boolean cut)
```
    Parameters:
    
    text - formatted text to pring
    
    cut - cut paper after print
  - newEventSession
```
void newEventSession(java.lang.String id)
```
    Starts a new event session using the provided id.
    
    Parameters:
    
    id - session id
  - newEventSession
```
java.lang.String newEventSession()
```
    Starts a new event session using a generated id.
    
    Returns:
    
    a new genrerated session identifier
  - timeEvent
```
void timeEvent(java.lang.String eventName)
```
    Time an event by including the time between this call and a later 'track' call. The event dwell time is then included in the properties sent with the event.
    
    Parameters:
    
    eventName - name of the event
  - track
```
void track(java.lang.String eventName,
           java.util.Map<java.lang.String,java.lang.Object> properties)
```
    Sends an event to the server with an optional map for additional event properties.
    
    Parameters:
    
    eventName - name of the event
    
    properties - a set of properties to include with the event you're sending
  - getLastCommand
```
Command getLastCommand()
```
    Gets the last command issues to the player.
    
    Returns:
    
    Controller object with name and argument values
  - converse
```
java.lang.String converse()
```
    Trigger recording of audio and send result to DialogFlow. Result will present itself as a command named 'dialogflow' with a json argument.
  - sendCommand
```
void sendCommand(java.lang.String name,
                 java.lang.String arg)
```
    Sends a command to the Controller. All registered command listeners will also receive the command.
    
    Parameters:
    
    name - command name
    
    arg - command argument
  - sendRemoteCommand
```
void sendRemoteCommand(java.lang.String[] registrationKeys,
                       java.lang.String name,
                       java.lang.String arg)
```
    Sends a command to remote devices identified by their registration keys. Only devices withing the same account as the calling device will receive the command.
    
    Parameters:
    
    registrationKeys - registration keys of devices to receive the command
    
    name - command name
    
    arg - command argument
  - setVolume
```
void setVolume(int level)
```
    Sets the master volume for app. Individual zones may have different volume levels.
    
    Parameters:
    
    level - 0 = mute, 100 = max
  - setBrightness
```
void setBrightness(int level)
```
    Sets the screen brightness. Not available on all devices and only on Android M and later.
    
    Parameters:
    
    level - 0 = low, 100 = max
  - isConnected
```
boolean isConnected()
```
    Determine if the player has Internet connectivity.
    
    Returns:
    
    true if connected to the internet
  - addTemplateListener
```
void addTemplateListener(TemplateListener listener)
```
    Adds a template listener interface to receive template related events.
    
    Parameters:
    
    listener - the listener interface to add
  - removeTemplateListener
```
void removeTemplateListener(TemplateListener listener)
```
    Removes a previously added template listener interface.
    
    Parameters:
    
    listener - the listener interface to remove
  - addOnPlayedListener
```
void addOnPlayedListener(OnPlayedListener listener)
```
    Adds a played listener interface to receive media played events.
    
    Parameters:
    
    listener - the listener interface to add
  - removeOnPlayedListener
```
void removeOnPlayedListener(OnPlayedListener listener)
```
    Removes a previously added listener for media played events.
    
    Parameters:
    
    listener - the listener interface to remove
  - addOnCommandListener
```
void addOnCommandListener(OnCommandListener listener)
```
    Adds a command listener interface to receive service and user command. events.
    
    Parameters:
    
    listener - the listener interface to add
  - removeOnCommandListener
```
void removeOnCommandListener(OnCommandListener listener)
```
    Removes a previously added listener for command events.
    
    Parameters:
    
    listener - the listener interface to remove
  - addOnImpressionListener
```
void addOnImpressionListener(OnImpressionListener listener)
```
    Adds the on impression listener.
    
    Parameters:
    
    listener - the listener interface to add
  - removeOnImpressionListener
```
void removeOnImpressionListener(OnImpressionListener listener)
```
    Removes the on impression listener.
    
    Parameters:
    
    listener - the listener interface to remove
  - addOnBeaconListener
```
void addOnBeaconListener(OnBeaconListener listener)
```
    Adds a beacon listener interface to receive beacon enter/exit events.
    
    Parameters:
    
    listener - the listener interface to add
  - removeOnBeaconListener
```
void removeOnBeaconListener(OnBeaconListener listener)
```
    Removes a previously added listener for beacon events.
    
    Parameters:
    
    listener - the listener interface to remove
  - addOnMotionListener
```
void addOnMotionListener(OnMotionListener listener)
```
    Adds a beacon listener interface to receive motion events.
    
    Parameters:
    
    listener - the listener interface to add
  - removeOnMotionListener
```
void removeOnMotionListener(OnMotionListener listener)
```
    Removes a previously added listener for motion events.
    
    Parameters:
    
    listener - the listener interface to remove
  - addConnectivityListener
```
void addConnectivityListener(ConnectivityListener listener)
```
    Adds a connectivity listener interface for receiving internet connectivity events.
    
    Parameters:
    
    listener - the listener interface to add
  - removeConnectivityListener
```
void removeConnectivityListener(ConnectivityListener listener)
```
    Removes a previously added listener for connectivity events.
    
    Parameters:
    
    listener - the listener interface to remove

Interface Controller

Method Summary

Method Detail

getDeviceKey

getDeviceTime

getOkHttpClient

getDeviceTime

getVersionCode

getDevice

getTemplate

getSchedule

print

print

newEventSession

newEventSession

timeEvent

track

getLastCommand

converse

sendCommand

sendRemoteCommand

setVolume

setBrightness

isConnected

addTemplateListener

removeTemplateListener

addOnPlayedListener

removeOnPlayedListener

addOnCommandListener

removeOnCommandListener

addOnImpressionListener

removeOnImpressionListener

addOnBeaconListener

removeOnBeaconListener

addOnMotionListener

removeOnMotionListener

addConnectivityListener

removeConnectivityListener