# createNDIDevice

Version: 4.1.0+


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

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


    "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 - creation of a mixed stream for the entire conference layout

    • #contentSharing:slideShowOrDs:1 - creation of a stream for content broadcasted in a separate window by VideoSDK/Room (using the startSlideShow command) or from another participant

    • PeerId - not supported

    • CallId - supported. The command is executed for the specified identifier.

    • InstanceId - supported. Inside the application, it is automatically converted to CallId and the command is executed with it.

  • requestId - a unique request identifier. You can learn more about it here.

To specify the video window of the VideoSDK/Room itself, set the value of the deviceId parameter to InstanceId. You can find out all the InstanceId for conference participants, including the one related to VideoSDK/Room, by using the getConferenceParticipants command.

See also: