Qt5 Scripting Filter Plugins

Table of Contents

• Qt5 JavaScript Filter
• Qt5 QML Filter
• Help
• Wrapper Classes

Qt5 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 Qt5 QML Filter is that this filter is designed to work headless and synchronously in the trigger pipe. Qt5 QML 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	Qt5 JavaScript Filter Plugin
License	ADTF
Support Mail	support@digitalwerk.net
Homepage URL	https://support.digitalwerk.net/

Plugin Versions

Plugin Version	3.14.3
Plugin File Version	1.0
adtf	3.14.3
adtf::ucom	3.1.0

Component Information

Name	Qt5 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.
Type	Filter

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.osborn.streaming.adtf.iid

Qt5 QML 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 Qt5 components from c++. (For more information how to write QML code see the Qt Documentation)

Note

The difference to the Qt5 JavaScript Filter is that this filter is designed for Qt5 QML GUIs. All events/triggers are handled by the Qt event system, which is running asyncronously in the trigger pipe.

Plugin Information

Plugin Filename	adtf_qtquick_filter.adtfplugin
Plugin Description	adtf_qtquick_filter.plugindescription
Plugin Name	Qt5 QML Filter Plugin
License	ADTF
Support Mail	support@digitalwerk.net
Homepage URL	https://support.digitalwerk.net/

Plugin Versions

Plugin Version	3.14.3
Plugin File Version	1.0
adtf	3.14.3
adtf::ucom	3.1.0

Component Information

Name	Qt5 QML 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.
Type	Filter

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.osborn.streaming.adtf.iid
qt_xsystem.osborn.services.adtf.iid

Help

For more help please have a look at Qt5 JavaScript Filter and Qt5 QML Filter at our ADTF3 Guides.

Wrapper Classes

The following global javascript Objects are available in your scripts:

• filter (adtf::javascript::scripting::cScriptFilter)
• types (adtf::javascript::scripting::cScriptTypes)
• clock (adtf::javascript::scripting::cScriptClock)

For all other available wrapper classes and objects please see adtf::javascript::scripting.