RecorderCommandService.MulticastInfo Class Reference

Public Attributes

int ClientPort
 The destination port the server will use to transmit multicast data.
 
Guid DeviceId
 Device ID for which this multicast info applies.
 
bool Encrypted
 Is the live stream data encrypted.
 
string IPAddress
 The multicast IP address.
 
TimeDuration KeepAliveInterval
 The maximum interval by which the multicast connection must be kept alive by calling MulticastContinue()
 
Guid MulticastSessionId
 The ID for this multicast session for this device.
 
string PrivacyMask
 The PrivacyMask will either be of type ‘grid’ followed by the dimensions of the mask and ‘1’ for each area not to be shown (private), or ‘none’ if a mask is being removed. Example: none/grid;3x3;110;110;000 Follows the format used on the ImageServer API for the PrivacyMask header.
 
int ServerPort
 The source port the server will use to transmit multicast data.
 
UInt32 SSRC
 Synchronization source (SSRC) identifier, the SSRC value of the RTP protocol used for multicast packets in this session. Used to determine if a multicast packet belongs to this multicast session.
 
bool Success
 Indicate whether the operation succeeded or not for the given device. If value is false the DeviceId is the only parameter guaranteed to be valid.
 

Member Data Documentation

◆ ClientPort

int RecorderCommandService.MulticastInfo.ClientPort

The destination port the server will use to transmit multicast data.

◆ DeviceId

Guid RecorderCommandService.MulticastInfo.DeviceId

Device ID for which this multicast info applies.

◆ Encrypted

bool RecorderCommandService.MulticastInfo.Encrypted

Is the live stream data encrypted.

◆ IPAddress

string RecorderCommandService.MulticastInfo.IPAddress

The multicast IP address.

◆ KeepAliveInterval

TimeDuration RecorderCommandService.MulticastInfo.KeepAliveInterval

The maximum interval by which the multicast connection must be kept alive by calling MulticastContinue()

◆ MulticastSessionId

Guid RecorderCommandService.MulticastInfo.MulticastSessionId

The ID for this multicast session for this device.

◆ PrivacyMask

string RecorderCommandService.MulticastInfo.PrivacyMask

The PrivacyMask will either be of type ‘grid’ followed by the dimensions of the mask and ‘1’ for each area not to be shown (private), or ‘none’ if a mask is being removed. Example: none/grid;3x3;110;110;000 Follows the format used on the ImageServer API for the PrivacyMask header.

◆ ServerPort

int RecorderCommandService.MulticastInfo.ServerPort

The source port the server will use to transmit multicast data.

◆ SSRC

UInt32 RecorderCommandService.MulticastInfo.SSRC

Synchronization source (SSRC) identifier, the SSRC value of the RTP protocol used for multicast packets in this session. Used to determine if a multicast packet belongs to this multicast session.

◆ Success

bool RecorderCommandService.MulticastInfo.Success

Indicate whether the operation succeeded or not for the given device. If value is false the DeviceId is the only parameter guaranteed to be valid.