Qt WebChannel

Qt WebChannel enables peer-to-peer communication between a server (QML/C++ application) and a client (HTML/JavaScript or QML application). It is supported out of the box by Qt WebEngine. In addition it can work on all browsers that support WebSockets, enabling Qt WebChannel clients to run in any JavaScript environment (including QML). This requires the implementation of a custom transport based on Qt WebSockets.

The module provides a JavaScript library for seamless integration of C++ and QML applications with HTML/JavaScript and QML clients. The clients must use the JavaScript library to access the serialized QObjects published by the host applications.

Getting Started

To use these classes in your application, use the following include statement:

#include <QtWebChannel/QtWebChannel>

To link against the module, add this line to your qmake .pro file:

QT += webchannel

The QML types are accessed by using:

import QtWebChannel 1.15

Licenses

Qt WebChannel is available under commercial licenses from The Qt Company. In addition, it is available under free software licenses. These free software licenses are GNU Lesser General Public License, version 3, or the GNU General Public License, version 2. See Qt Licensing for further details.

API Reference

• JavaScript API
• C++ API
• QML API

Examples

• Examples