Control interfaces

Control interfaces

This tutorial summarize the available system control interfaces.

What are the control interfaces ?

The control interfaces are JavaScript objects intended to be used to control the video player.
Each control interface expose a set of business logic APIs.

The available control interfaces are:

  • Contact: input and output contact management,
  • Logger: log files management,
  • Player: audio/video playback and volume management,
  • Printer: print management,
  • Serial: serial port communication.

How to retrieve the control interfaces ?

The control interfaces can be retrieved using a few lines of JavaScript in your HTML documents.
The easiest method is to use the IDAL.getControlInterfaces() method which is available in the ID-AL JavaScript SDK.

For more information, you can read the ID-AL JavaScript SDK tutorial.

What about exposed APIs ?

All the API exposed by the control interfaces are using Promise as return values.
It means that they are asynchronous.

It is not possible to retrieve and use the control interfaces for the pages loaded into an <iframe>.
Only the pages loaded as main document are able to control the video player.