StreamReceive

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

Syntax

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

Properties

Property Name	Parent Path	Version	Description	Type	Methods	Validation Rules
StreamReceive	/Device/	2.0.0	The top‑level StreamReceive object.	Object	GET, POST	N/A
Streams	/Device/StreamReceive/	2.0.0	A collection of streams on the device.	Object Collection	GET, POST	N/A
Bitrate	/Device/StreamReceive/Streams/x/	2.0.0	The bitrate of the stream in Mbps.	Numeric (Unsigned 16-bit)	GET	N/A
CodecReady	/Device/StreamReceive/Streams/x/	2.0.0	Indicates whether the codec is ready to receive the stream (true) or not (false).	Boolean	GET	N/A
Status	/Device/StreamReceive/Streams/x/	2.0.0	Indicates the current stream state.	String	GET	N/A
ElapsedSeconds	/Device/StreamReceive/Streams/x/	2.0.0	Indicates the time that has elapsed since the stream started. When <ElapsedSeconds_F> exceeds 65535d, it resets to 0d.	Numeric (Unsigned 16-bit)	GET	N/A
InitiatorAddress	/Device/StreamReceive/Streams/x/	2.0.0	The address of the device connected to the receiver.	String	GET, POST	N/A
MulticastAddress	/Device/StreamReceive/Streams/x/	2.0.0	The multicast address of the device connected to the receiving device.	String	GET, POST	N/A
Password	/Device/StreamReceive/Streams/x/	2.0.0	The password required to connect to the stream transmitter.	String	GET, POST	N/A
IsPasswordProtectionEnabled	/Device/StreamReceive/Streams/x/	2.0.0	Indicates whether authentication should be used when connecting to the stream transmitter (true) or not (false).	Boolean	GET, POST	N/A
Pause	/Device/StreamReceive/Streams/x/	2.0.0	Indicates whether the stream is paused (true) or not (false).	Boolean	GET, POST	N/A
Processing	/Device/StreamReceive/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/StreamReceive/Streams/x/	2.0.0	An enumeration to set or get the session initiation mode.	String	GET, POST	N/A
Start	/Device/StreamReceive/Streams/x/	2.0.0	Indicates whether the stream is started (true) or not (false).	Boolean	GET, POST	N/A
Stop	/Device/StreamReceive/Streams/x/	2.0.0	Indicates whether the stream is stopped (true) or not (false).	Boolean	GET, POST	N/A
StreamLocation	/Device/StreamReceive/Streams/x/	2.0.0	The full path of the server URL.	String	GET, POST	N/A
StreamProfile	/Device/StreamReceive/Streams/x/	2.0.0	the H.264 profile of the stream.	String	GET	N/A
Buffer	/Device/StreamReceive/Streams/x/	2.0.0	Specifies the length of video that will be cached, in milliseconds.	Numeric (Unsigned 16-bit)	GET, POST	N/A
TransportMode	/Device/StreamReceive/Streams/x/	2.0.0	Reports the streaming transport mode.	String	GET	N/A
Username	/Device/StreamReceive/Streams/x/	2.0.0	The username used to connect to the stream transmitter.	String	GET, POST	N/A
RtspPort	/Device/StreamReceive/Streams/x/	2.0.0	The TCP port number for the RTSP connection.	Numeric (Unsigned 16-bit)	GET, POST	N/A
TsPort	/Device/StreamReceive/Streams/x/	2.0.0	The TS port number for the stream.	Numeric (Unsigned 16-bit)	GET, POST	N/A
RtpVideoPort	/Device/StreamReceive/Streams/x/	2.0.0	The RTP video port number for the stream.	Numeric (Unsigned 16-bit)	GET, POST	N/A
RtpAudioPort	/Device/StreamReceive/Streams/x/	2.0.0	The RTP audio port number for the stream.	Numeric (Unsigned 16-bit)	GET, POST	N/A
IsStatisticsEnabled	/Device/StreamReceive/Streams/x/	2.0.0	Indicates whether statistics are enabled (true) or not (false) for the stream.	Boolean	GET, POST	N/A
ResetStatistics	/Device/StreamReceive/Streams/x/	2.0.0	Indicates whether current stream statistics should be reset (true) or not (false).	Boolean	POST	N/A
NumVideoPacketsRcvd	/Device/StreamReceive/Streams/x/	2.0.0	The number of received video packets.	Numeric (Unsigned 16-bit)	GET	N/A
NumVideoPacketsDropped	/Device/StreamReceive/Streams/x/	2.0.0	The number of dropped video packets.	Numeric (Unsigned 16-bit)	GET	N/A
NumAudioPacketsRcvd	/Device/StreamReceive/Streams/x/	2.0.0	The number of received audio packets.	Numeric (Unsigned 16-bit)	GET	N/A
NumAudioPacketsDropped	/Device/StreamReceive/Streams/x/	2.0.0	The number of dropped audio packets.	Numeric (Unsigned 16-bit)	GET	N/A
HorizontalResolution	/Device/StreamReceive/Streams/x/	2.0.0	The horizontal resolution of the received stream.	Numeric (Unsigned 16-bit)	GET	N/A
VerticalResolution	/Device/StreamReceive/Streams/x/	2.0.0	The vertical resolution of the received stream.	Numeric (Unsigned 16-bit)	GET	N/A
FramesPerSecond	/Device/StreamReceive/Streams/x/	2.0.0	The framerate of the received stream.	Numeric (Unsigned 16-bit)	GET	N/A
AspectRatio	/Device/StreamReceive/Streams/x/	2.0.0	The aspect ratio of the received stream.	String	GET	N/A
AudioChannels	/Device/StreamReceive/Streams/x/	2.0.0	The number of audio channels received in the stream.	Numeric (Unsigned 16-bit)	GET	N/A
AudioFormat	/Device/StreamReceive/Streams/x/	2.0.0	The audio format of the received stream.	String	GET	N/A
IsAutomaticInitiationEnabled	/Device/StreamReceive/Streams/x/	2.0.1	Indicates whether automatic initiation is enabled (true) or not (false).	Boolean	GET, POST	N/A
AudioMode	/Device/StreamReceive/Streams/x/	2.0.1	The audio mode for the stream.	String	GET	N/A
Version	/Device/StreamReceive/	2.0.1	"2.0.0": Initial public release, "2.0.1": Added IsAutomaticInitiationEnabled, AudioMode, Changed Start/Stop/Pause to Read, Write	String	GET	N/A

Example JSON

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

Copy

{
    "Device":{
        "StreamReceive":{
            "Version":"2.0.1",
            "Streams":[
                {
                    "Bitrate":0,
                    "CodecReady":false,
                    "Status":"Stream Stopped",
                    "ElapsedSeconds":0,
                    "InitiatorAddress":"",
                    "MulticastAddress":"",
                    "Password":"",
                    "IsPasswordProtectionEnabled":true,
                    "Pause":true,
                    "Processing":false,
                    "SessionInitiation":"ByReceiver",
                    "Start":false,
                    "Stop":false,
                    "StreamLocation":"",
                    "StreamProfile":"High",
                    "Buffer":0,
                    "TransportMode":"RTP",
                    "Username":"",
                    "RtspPort":554,
                    "TsPort":4570,
                    "RtpVideoPort":40000,
                    "RtpAudioPort":40002,
                    "IsStatisticsEnabled":true,
                    "ResetStatistics":false,
                    "NumVideoPacketsRcvd":0,
                    "NumVideoPacketsDropped":0,
                    "NumAudioPacketsRcvd":0,
                    "NumAudioPacketsDropped":0,
                    "HorizontalResolution":640,
                    "VerticalResolution":480,
                    "FramesPerSecond":60,
                    "AspectRatio":"16:10",
                    "AudioChannels":2,
                    "AudioFormat":"Lpcm",
                    "IsAutomaticInitiationEnabled":true,
                    "AudioMode": "Manual|Disabled",
                    }
                }
            ]
        }
    }
}

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.