Spotlight Messages

Action Messages

• SPOTLIGHT_UI_CENTER_POSITION - Sets the X and Y value of the center of the spotlight presentation pointer. This message is broadcastable.

  Parameters:

  • xpos (float) - The x position of the spotlight in pixels.

  • ypos (float) - The y position of the spotlight in pixels.

• SPOTLIGHT_UI_DECREASE_SCALE_FACTOR - Decreases the size of the spotlight presentation pointer by the default increment amount.

• SPOTLIGHT_UI_INCREASE_SCALE_FACTOR - Increases the size of the spotlight presentation pointer by the default increment amount.

• SPOTLIGHT_UI_LOCK - Sets whether the spotlight presentation pointer should be allowed to move around or stay in position. This message is broadcastable.

  Parameters:

  • lock (bool) - True or False.

• SPOTLIGHT_UI_REQUEST_PARAMETERS - Requests spotlight presentation pointer information from the host when the client connects to a host machine, triggering messages from the host that any listening clients then use to synchronize themselves with the host's spotlight state.

• SPOTLIGHT_UI_SCALE_FACTOR - Sets the scaling factor for the percentage of the screen space the spotlight presentation pointer takes up. This message is broadcastable.

  Parameters:

  • scale (float) - Scale value: [0.01, 1.0].

• SPOTLIGHT_UI_SET_MODE - Shows or hides the spotlight Presentation Pointer user interface. This message is broadcastable.

  Parameters:

  • visible (bool) - True to show the spotlight pointer user interface, False to hide it.

Information Messages

• SPOTLIGHT_UI_MOUSE_POSITION - Indicates the X and Y value of the mouse position.

  Parameters:

  • xpos (float) - x position in pixels.

  • ypos (float) - y position in pixels.