Our support site has moved to https://support.intuiface.com

Remote action syntax

An IntuiFace experience running in Player for Windows (either standalone or in Composer's Play Mode) can receive actions from any other experience. IntuiFace also permits third-party applications to send actions to an experience as soon as its hosting computer can be addressed on the network. IntuiFace uses URL formalism to receive and manage remote actions.

The generic URL for a remote actions is:

http://[ComputerName or ComputerIPAddress]:8000/intuifacepresentationplayer/presentation/currentspace/[asset name]/[ActionName]?[OptionName=OptionValue]

Notes

  • Port 8000 (TCP) is the default and can be changed using the IntuiFace Configuration Tool that is installed alongside Player for Windows and Composer. For more information about the Configuration tool, see this page
  • All names you can use as targets - scene, asset, collection - are case sensitive.

Please visit this page to create and test remote actions that can be used by third party applications. Be sure to open this page on a computer that is on the same network as the experience to which you want to send these remote action requests.

The elements of the URL are:

  • [ComputerName or ComputerIPAddress]: This can be a computer name resolvable by DNS or an IP address
  • [ActionName]: The name of the action to be triggered in the targeted experience.
  • [OptionName=OptionValue]: Each action comes with parameters that can be configured using this syntax. If omitted, parameters are replaced by default values.

Below is a list of the most frequently used actions and their corresponding parameters. For a look at all of the available actions please see this page.

Here are the most frequent actions:

  • go to scene: goes to a targeted scene
    • target: name of the scene to go to
    • transition: name of the transition to be used from current scene to target scene. Allowed transitions are Wipe, Zoom in, Zoom out, Slide, Cross fade, Circular and Black fade.
    • duration: duration of the transition in seconds
    • example:
http://10.0.0.152:8000/intuifacepresentationplayer/presentation/gotospace?target=MySpace&transition=Wipe&duration=00:00:02
  • backward: goes back to the scene you are coming from
    • transition: name of the transition to be used from current scene to target scene. Allowed transitions are Wipe, Zoom in, Zoom out, Slide, Cross fade, Circular and Black fade.
    • duration: duration of the transition in seconds
    • example:
http://10.0.0.152:8000/intuifacepresentationplayer/presentation/backward?transition=Wipe&duration=00:00:02
  • forward: returns to the scene you were on before going backward
    • transition: name of the transition to be used from current scene to target scene. Allowed transitions are Wipe, Zoom in, Zoom out, Slide, Cross fade, Circular and Black fade.
    • duration: duration of the transition in seconds
    • example:
http://10.0.0.152:8000/intuifacepresentationplayer/presentation/forward?transition=Wipe&duration=00:00:02
  • previous: goes to the previous scene listed in the Scenes panel
    • transition: name of the transition to be used from current scene to target scene. Allowed transitions are Wipe, Zoom in, Zoom out, Slide, Cross fade, Circular and Black fade.
    • duration: duration of the transition in seconds
    • example:
http://10.0.0.152:8000/intuifacepresentationplayer/presentation/previous?transition=Wipe&duration=00:00:02
  • next: goes to next the scene listed in the Scenes panel
    • transition: name of the transition to be used from current scene to target scene. Allowed transitions are Wipe, Zoom in, Zoom out, Slide, Cross fade, Circular and Black fade.
    • duration: duration of the transition in seconds
    • example:
http://10.0.0.152:8000/intuifacepresentationplayer/presentation/next?transition=Wipe&duration=00:00:02
  • exit: exits the IntuiFace experience
    • example:
http://10.0.0.152:8000/intuifacepresentationplayer/presentation/exit
  • rotate: flips the screen by 180°
    • duration: duration of the transition in seconds
    • example:
http://10.0.0.152:8000/intuifacepresentationplayer/presentation/rotate?duration=00:00:02
  • run application: run an external third-party application
    • application: application file path
    • parameters: parameters to be passed to the application (string of characters)
    • NB: the application file path and parameters must be URL-encoded. We recommend you use our Remote Actions Builder to generate such URLs.