StreamTransmit

The StreamTransmit object is used to get and set transmitted stream settings for the DM NVX device.

Syntax

HTTP Methods: GET, POST
Base URI: /Device/StreamTransmit/

Properties

Property Name	Parent Path	Version	Description	Type	Methods	Validation Rules
StreamTransmit	/Device/	2.0.0	The top‑level StreamTransmit object.	Object	N/A	N/A
Streams	/Device/StreamTransmit/	2.0.0	A collection of all transmitted streams on the device.	Object Collection	GET, POST	N/A
Uuid	/Device/StreamTransmit/Streams/x/	2.0.0	The unique ID for the stream.	String	GET	N/A
MultiCastTtl	/Device/StreamTransmit/Streams/x/	2.0.0	The multicast TTL for the stream.	Numeric (Unsigned 16-bit)	GET, POST	N/A
SnapshotUri	/Device/StreamTransmit/Streams/x/	2.0.0	The URI for the camera snapshot of the stream.	String	GET, POST	N/A
SnapshotFileName	/Device/StreamTransmit/Streams/x/	2.0.0	The filename for the camera snapshot of the stream.	String	GET, POST	N/A
RtspSessionName	/Device/StreamTransmit/Streams/x/	2.0.0	The RTSP session name.	String	GET, POST	N/A
RtspStreamFileName	/Device/StreamTransmit/Streams/x/	2.0.0	The RTSP filename.	String	GET, POST	N/A
Bitrate	/Device/StreamTransmit/Streams/x/	2.0.0	The bitrate of the stream, in Mbps.	Numeric (Unsigned 16-bit)	GET	N/A
ActiveBitrate	/Device/StreamTransmit/Streams/x/	2.1.1	The bitrate of the active stream, in Mbps.	Numeric (Unsigned 16-bit)	GET	N/A
CodecReady	/Device/StreamTransmit/Streams/x/	2.0.0	Indicates whether the codec is ready to transmit the stream (true) or not (false).	Boolean	GET	N/A
Status	/Device/StreamTransmit/Streams/x/	2.0.0	Indicates the current stream state.	String	GET	N/A
ElapsedSeconds	/Device/StreamTransmit/Streams/x/	2.0.0	Indicates the time elapsed (in seconds) since streaming has started. Valid values range from 0d to 65535d. When <ElapsedSeconds_F> exceeds 65535d, it resets to 0d.	Numeric (Unsigned 16-bit)	GET	N/A
FramesPerSecond	/Device/StreamTransmit/Streams/x/	2.0.0	The frame rate of the transmitted stream.	Numeric (Unsigned 16-bit)	GET	N/A
MulticastAddress	/Device/StreamTransmit/Streams/x/	2.0.0	The multicast address of the transmitted stream.	String	GET, POST	N/A
Password	/Device/StreamTransmit/Streams/x/	2.0.0	The password to be used to authenticate the stream.	String	POST	N/A
IsPasswordProtectionEnabled	/Device/StreamTransmit/Streams/x/	2.0.0	Indicates whether authentication is enabled on the stream (true) or not (false).	Boolean	GET, POST	N/A
Pause	/Device/StreamTransmit/Streams/x/	2.0.0	Indicates whether the stream is paused (true) or not (false).	Boolean	GET, POST	N/A
Processing	/Device/StreamTransmit/Streams/x/	2.0.0	Indicates that the device is changing state (starting the stream, stopping the stream, etc.) and is busy. Wait until the state is false before sending commands to the device.	Boolean	GET	N/A
SessionInitiation	/Device/StreamTransmit/Streams/x/	2.0.0	An enumeration to set or get the session initiation mode.	String	GET, POST	N/A
Start	/Device/StreamTransmit/Streams/x/	2.0.0	Indicates whether the stream is started (true) or not (false).	Boolean	GET, POST	N/A
Stop	/Device/StreamTransmit/Streams/x/	2.0.0	Indicates whether the stream is stopped (true) or not (false).	Boolean	GET, POST	N/A
StreamLocation	/Device/StreamTransmit/Streams/x/	2.0.0	The full path of the server URL.	String	GET	N/A
StreamProfile	/Device/StreamTransmit/Streams/x/	2.0.0	The H.264 profile of the stream.	String	GET, POST	N/A
TransportMode	/Device/StreamTransmit/Streams/x/	2.0.0	The streaming transport mode.	String	GET, POST	N/A
Username	/Device/StreamTransmit/Streams/x/	2.0.0	A username to authenticate the stream.	String	GET, POST	N/A
RtspPort	/Device/StreamTransmit/Streams/x/	2.0.0	The TCP port number for the RTSP connection.	Numeric (Unsigned 16-bit)	GET, POST	N/A
TsPort	/Device/StreamTransmit/Streams/x/	2.0.0	The TS port number for the stream.	Numeric (Unsigned 16-bit)	GET, POST	N/A
RtpVideoPort	/Device/StreamTransmit/Streams/x/	2.0.0	The RTP video port number for the stream.	Numeric (Unsigned 16-bit)	GET, POST	N/A
RtpAudioPort	/Device/StreamTransmit/Streams/x/	2.0.0	The RTP audio port number for the stream.	Numeric (Unsigned 16-bit)	GET, POST	N/A
IsStatisticsEnabled	/Device/StreamTransmit/Streams/x/	2.0.0	Indicates whether statistics are enabled for the stream (true) or not (false).	Boolean	GET, POST	N/A
ResetStatistics	/Device/StreamTransmit/Streams/x/	2.0.0	Indicates whether the current stream statistics should be reset (true) or not (false).	Boolean	POST	N/A
NumVideoPacketsTransmitted	/Device/StreamTransmit/Streams/x/	2.1.2	The number of video packets transmitted.	Numeric (Unsigned 16-bit)	GET	N/A
NumAudioPacketsTransmitted	/Device/StreamTransmit/Streams/x/	2.1.2	The number of audio packets transmitted.	Numeric (Unsigned 16-bit)	GET	N/A
HorizontalResolution	/Device/StreamTransmit/Streams/x/	2.0.0	The horizontal resolution of the stream.	Numeric (Unsigned 16-bit)	GET	N/A
VerticalResolution	/Device/StreamTransmit/Streams/x/	2.0.0	The vertical resolution of the stream.	Numeric (Unsigned 16-bit)	GET	N/A
IsAutomaticInitiationEnabled	/Device/StreamTransmit/Streams/x/	2.0.1	Indicates whether automatic initiation is enabled (true) or not (false).	Boolean	GET, POST	N/A
AudioMode	/Device/StreamTransmit/Streams/x/	2.0.1	The audio mode of the stream.	String	GET	N/A
IsAdaptiveBitrateMode	/Device/StreamTransmit/Streams/x/	2.1.0	Indicates whether adaptive bitrate mode is enabled (true) or not (false).	Boolean	GET, POST	N/A
StreamEncodingType	/Device/StreamTransmit/Streams/x/	2.1.6	The type of encoding used for the stream.	String	GET, POST	"Pixel Perfect Processing", "DM-NVX-D10/D20 Series"
BitrateMode	/Device/StreamTransmit/Streams/x/	2.1.5	The bitrate control mode.	String	GET, POST	"Fixed", "Adaptive", "Variable"
NetworkAdapter	/Device/StreamTransmit/Streams/x/	2.1.7	The network adapter for the transmitted stream.	String	GET, POST	N/A
StreamSource	/Device/StreamTransmit/Streams/x/	2.1.7	The source of the transmitted stream.	String	GET, POST	N/A
Version	/Device/StreamTransmit/	2.1.7	"2.0.0": Initial public release, "2.0.1": Added IsAutomaticInitiationEnabled, AudioMode, "2.1.0": Added IsAdaptiveBitrateMode, "2.1.1": Added ActiveBitrate, Changed Start/Stop/Pause to Read, Write, "2.1.2": Property names changed, "2.1.3": Added StreamType, "2.1.4": Changed property name StreamType to StreamEncodingType as StreamType is already used in the StreamTransmit class, "2.1.5": Added property BitrateMode, "2.1.6": Updated admissible values for the StreamEncodingType property, "2.1.7": Added NetworkAddress and StreamSource properties	String	GET	N/A

Example JSON

The following example JSON uses the current object version (2.1.7).

Copy

{
  "Device": {
    "StreamTransmit": {
      "Version": "2.1.7",
      "Streams": [
        {
          "UUID": "feba1d06-867b-42dd-b59c-7a80f92d1234",
          "MultiCastTtl": 0,
          "HdcpTransmitterMode": "FollowInput",
          "SnapshotUri": "",
          "SnapshotFileName": "",
          "RtspSessionName": "Crestron Streaming",
          "RtspStreamFileName": "",
          "Bitrate": 0,
          "ActiveBitrate": 0,
          "CodecReady": false,
          "Status": "Stream Stopped",
          "ElapsedSeconds": 0,
          "FramesPerSecond": 0,
          "EncodingResolution": "Auto",
          "MulticastAddress": "",
          "Password": "",
          "IsPasswordProtectionEnabled": true,
          "Pause": true,
          "Processing": false,
          "SessionInitiation": "ByReceiver",
          "Start": false,
          "Stop": false,
          "StreamLocation": "",
          "StreamProfile": "High",
          "TransportMode": "RTP",
          "Username": "",
          "RtspPort": 554,
          "TsPort": 4570,
          "RtpVideoPort": 40000,
          "RtpAudioPort": 40002,
          "IsStatisticsEnabled": true,
          "ResetStatistics": false,
          "NumVideoPacketsTransmitted": 0,
          "NumAudioPacketsTransmitted": 0,
          "AudioChannels": 2,
          "AudioFormat": "NoAudio|LPCM|LBR|HBR",
          "HorizontalResolution": 640,
          "VerticalResolution": 480,
          "IsAutomaticInitiationEnabled": true,
          "AudioMode": "Manual|Disabled",
          "IsAdaptiveBitrateMode": true,
          "StreamEncodingType": "Pixel Perfect Processing",
          "BitrateMode": "Adaptive",
          "NetworkAdapter": "Adapter0",
          "StreamSource": "Display0"
        }
      ]
    }
  }
}

Have feedback on this document? Contact docfeedback@crestron.com.

All brand names, product names and trademarks are the property of their respective owners. Certain trademarks, registered trademarks, and trade names may be used to refer to either the entities claiming the marks and names or their products. Crestron disclaims any proprietary interest in the marks and names of others. Crestron is not responsible for errors in typography or photography. Specifications are subject to change without notice.