ADTF JavaScript Filter
- Introduction
This is a Filter wrapping the functionality of QJSEngine from the Qt framework. Providing a simple way to use JavaScript code as filter in a Filter Graph, receiving and sending samples.
- Note
- The difference to the ADTF QtQuick Filter is that this filter is designed to work headless and synchronously in the trigger pipe. ADTF QtQuick Filter triggers are handled by the GUI Thread, meaning that they are asynchron.
- Plugin Information
| Plugin Filename | adtf_javascript_filter.adtfplugin |
| Plugin Description | adtf_javascript_filter.plugindescription |
| Plugin Name | JavaScript Filter Plugin |
| Plugin Version | 3.11.0 |
| Plugin File Version | 1.0 |
| License | ADTF |
| Support Mail | support@digitalwerk.net |
| Homepage URL | https://support.digitalwerk.net/ |
- Component Information
| Name | JavaScript Filter |
| CID | javascript.filter.adtf.cid |
| Description | Use this filter to program a basic logic using Javascript code. Note: This is only recommended for quick filter algorithms. If you need performance, C++ is still the best solution. |
- Properties
| Name | Value | Type | Description | Subproperties |
| script_file_name | | cFilename | Path to used script file. | |
| synchronous_trigger_processing | true | tBool | If enabled triggers will be delayed until they have been processed within the script. | |
- Dynamic Pins
| Dynamic Input Pins | true |
| Dynamic Output Pins | true |
| Dynamic Input Binding Pins | true |
| Dynamic Output Binding Pins | true |
- Required Interfaces
| IID |
| reference_clock.giant.streaming.adtf.iid |
ADTF QtQuick Filter
- Introduction
This is a Filter wrapping the functionality of QQmlApplicationEngine from the Qt framework. The QQmlApplicationEngine class provides an environment for writing JavaScript code and instantiating QtQuick components from c++. (For more information how to write QML code see the Qt Documentation)
- Note
- The difference to the ADTF JavaScript Filter is that this filter is designed for QtQuick GUIs. All events/triggers are handled by the Qt event system, which is running asyncronously in the trigger pipe.
- Plugin Information
-
- Component Information
| Name | QtQuick Filter |
| CID | qtquick.filter.adtf.cid |
| Description | Use this filter to program a UI logic using Javascript code with QML Support. Note: This is only recommended for quick visualization. If you need performance, C++ is still the best solution. |
- Properties
| Name | Value | Type | Description | Subproperties |
| modules | | cFilepathList | Addtional QML modules to add to the QML Engine. | |
| plugins | | cFilepathList | Addtional QML plugins to add to the QML Engine. | |
| script_file_name | | cFilename | Path to used script file. | |
| title | | cString | Window title which will be used at runtime within ADTF Qt XSystem. | |
| xsystem_window | true | tBool | Creates an ADTF Qt XSystem display to show content. | |
- Input Binding Objects
| Name | IID | Proxy OID | Description |
| qtshared_server | qtshared.giant.ui.adtf.iid | | Interface server to provide a common display for shared print access |
- Dynamic Pins
| Dynamic Input Pins | true |
| Dynamic Output Pins | true |
| Dynamic Input Binding Pins | true |
| Dynamic Output Binding Pins | true |
- Required Interfaces
| IID |
| reference_clock.giant.streaming.adtf.iid |
| qt_xsystem.ant.services.adtf.iid |
Help
For more help please have a look at Javascript Filter and QtQuick Filter at our ADTF3 Guides. There is also a combined tutorial which shows a JS/QML pendant of a former in C++ implemented use case.
Wrapper Classes
The following global javascript Objects are available in your scripts:
For all other available wrapper classes and objects please see adtf::javascript::scripting.