Palette:webRTCPanelRcv

Summary

The WebRTC Remote Panel Receiver COMP is a component that can be used to receive a TouchDesigner COMP's panel over a WebRTC connection from a matching WebRTC Remote Panel.

It requires a Palette:signalingClient COMP connected to a supported Palette:signalingServer COMP.

Before getting started with WebRTC, it is highly recommended to give a read to the introduction available on MDN web docs.

To get a better understanding of what is WebRTC in TouchDesigner, it is recommended to have a look at the WebRTC page and the webRTC COMP page.

The receiving end of the connection should be a WebRTC Remote Panel Receiver COMP or a web page designed to receive a WebRTC stream and a signaling client supporting TouchDesigner' Signaling API and signalingServer COMP.

Follow the setup guidelines from the page WebRTC Remote Panel COMP for a quick start.

This component can be replaced by a web page designer to receive a WebRTC stream and a signaling client supporting TouchDesigner' Signaling API and signalingServer COMP. A web based demo is available in the following repository as well as an online demo following this link.

Palette:webRTCPanelRcv Ext

Parameters - WebRTC Panel Receiver Page

Active Active - Start or stop the webRTCPanelRcv.

Client Client - The client exposed by the signalingClient that you wish to connect with. Note: If a client is on the signaling session but not a webRTCPanel, connecting could potentially fail.

Connect Connect - Connect to the remote webRTCPanel.

Signaling Client Signalingclient - The signaling client with which this WebRTC COMP will subscribe to send or receive signaling messages.

STUN Server URL Stun - URL of the STUN server.

TURN Server URL Turn0 - URL of the TURN server. See WebRTC#ICE for more details regarding TURN.

TURN Username Username - Username for access to the specified TURN servers.

TURN Password Password - Password for access to the specified TURN servers.

Reset Reset - Reset the WebRTC COMP states and kill all ongoing peer connections.

Signaling API Version Signalingapiversion - The Signaling API version. When a signaling client is being used, the API versions of both the server and client should match.

Parameters - Logger Page

Enable Logging Enablelogging - Enable advanced logging features. Useful to debug and track the Signaling Server activity.

Log to File Logtofile - When enabled, logging messages will be written to a time rotated log file.

Log Folder Logfolder - Path to the folder in which the log files should be written.

File Rotation Filerotation - Number of backup files to be kept when rotating log.

Log to Textport Logtotextport - When enabled, logging messages will be displayed in the textport.

Log to Status Bar Logtostatusbar - When enabled, logging messages will be displayed in the status bar.

Log Level Loglevel - ⊞ - Filter level of logging messages. The selected level is included as well as all levels above. I.e. if Warning is selected, Warning and Error messages will be included while Info messages will be excluded.

• INFO INFO -

• DEBUG DEBUG -

• WARNING WARNING -

• ERROR ERROR -

• CRITICAL CRITICAL -

Parameters - About Page

Help Help - Open Help page in external browser.

Version Version - The component version number.

.tox Save Build Toxsavebuild - The TouchDesinger build in which the component was last exported from.

Operator Outputs

• Output 0 -

An Operator Family that contains its own Network. There are sixteen 3D Object Component and ten 2D Panel Component types. See also Network Path.

A Folder in TouchDesigner always refers to a Windows or macOS operating system directory/folder system that contain files and other folders. It does not refer to operators within TouchDesigner. See Network Path.

The location of an operator within the TouchDesigner environment, for example, /geo1/circle1, a node called circle1 in a component called geo1. The path / is called Root. This path is displayed at the top of every Pane, showing which Component's network you are currently in. To refer instead to a filesystem folder, directory, disk file or http: address, see Folder.

The dialog box in which commands and scripts can typed in manually. Output to the textport includes script errors and messages from print() and debug() calls in python code. You can also edit DATs in the textport.

The line of text at the top of the TouchDesigner window which displays messages from TouchDesigner when certain events succeed or fail.

TouchDesigner Component file, the file type used to save a Component of your TouchDesigner project.

A built-in panel in TouchDesigner that contains a library of components and media that can be dragged-dropped into a TouchDesigner network.