createNDIDevice

Description: create an NDI stream to broadcast a participant's video window, content stream, or the entire video layout to the local network. v4.1.0+ PRO

For stable operation with NDI streaming functionality, we recommend using only a wired connection TrueConf Room API to the local network. Wi-Fi bandwidth may not be sufficient for transmitting high-quality media streams broadcasted via NDI.

Example:

{
    "method": "createNDIDevice",
    "requestId" : "1",
    "deviceId": "user1@some.server"
}

Answer examples:

{
    "method" : "createNDIDevice",
    "requestId" : "1",
    "result" : true
}

Parameter description:

deviceId - the identifier of the source for which to create an NDI stream. Possible values:
- #mixed:0 - create a mixed stream for the entire conference video layout
- #contentSharing:slideShowOrDs:1 - create a stream for content shared in a separate window from TrueConf Room API (using the startSlideShow command) or from another participant
- PeerId - not supported
- CallId - is supported. The command is executed for the specified identifier.
- InstanceId is supported. Inside the application, it is automatically converted to CallId, and the command is executed using the latter.
requestId - a unique request identifier. You can find more details about it here.

To specify the video window of the TrueConf Room API itself, the deviceId parameter should be set to the InstanceId value. You can find all InstanceId for conference participants, including the one related to TrueConf Room API, using the getConferenceParticipants command.

See also: