Click or drag to resize

Dmps3SystemControlWithStreaming Class

The system control class for the DMPS3 control system with internal streaming functions.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpPro.DMDmps3SystemControl
    Crestron.SimplSharpPro.DMDmps3SystemControlWithStreaming

Namespace: Crestron.SimplSharpPro.DM
Assembly: SimplSharpPro (in SimplSharpPro.dll) Version: 2.21.121
Syntax
C#
public class Dmps3SystemControlWithStreaming : Dmps3SystemControl

The Dmps3SystemControlWithStreaming type exposes the following members.

Properties
 NameDescription
Public propertyApplySystemId This signal is not implemented for the DMPS3.
(Inherited from Dmps3SystemControl)
Public propertyAudioEnter This signal is not implemented for the DMPS3.
(Inherited from Dmps3SystemControl)
Public propertyContentLan1LinkStatusFeedback Indicates if an Ethernet link is detected at the content LAN1 port. 'true' = Ethernet link detected; 'false' = Ethernet link not detected.

The DMSystemChange event will trigger with the ContentLAN1LinkStatusEventId.

Public propertyContentLan1Mode Sets the Content LAN1 Mode. (Sets which interface to use for streaming)
Public propertyContentLan1ModeFeedback Reports the Content LAN1 Mode.

The DMSystemChange event will trigger with the ContentLAN1ModeEventId.

Public propertyContentLan2LinkStatusFeedback Indicates if an Ethernet link is detected at the content LAN2 port. 'true' = Ethernet link detected; 'false' = Ethernet link not detected.

The DMSystemChange event will trigger with the ContentLAN2LinkStatusEventId.

Public propertyContentLan2Mode Sets the Content LAN2 Mode. (Sets which interface to use for streaming)
Public propertyContentLan2ModeFeedback Reports the Content LAN2 Mode.

The DMSystemChange event will trigger with the ContentLAN2ModeEventId.

Public propertyDeviceModeFeedback Property to return the current streaming device mode.

The DMSystemChange event will trigger with the DeviceModeFeedbackEventId.

Public propertyEnableAudioBreakaway This signal is not implemented for the DMPS3.
(Inherited from Dmps3SystemControl)
Public propertyEnableAudioBreakawayFeedback This signal is not implemented for the DMPS3.
(Inherited from Dmps3SystemControl)
Public propertyEnableUSBBreakaway This signal is not implemented for the DMPS3.
(Inherited from Dmps3SystemControl)
Public propertyEnableUSBBreakawayFeedback This signal is not implemented for the DMPS3.
(Inherited from Dmps3SystemControl)
Public propertyEncodingFramerate Property to set the streaming encoding framerate.
Public propertyEncodingFramerateFeedback Property to return the streaming current encoding framerate.

The DMSystemChange event will trigger with the EncodingFramerateFeedbackEventId.

Public propertyEncodingResolution Property to set the streaming encoding resolution.
Public propertyEncodingResolutionFeedback Property to return the current streaming encoding resolution.

The DMSystemChange event will trigger with the EncodingResolutionFeedbackEventId.

Public propertyFrontPanelBrightnessHighObsolete.
Sets the front panel brightness to high.
(Inherited from Dmps3SystemControl)
Public propertyCode exampleFrontPanelBrightnessHighFeedBack Indicates if the front panel brightness level is currently set to high.

The DMSystemChange event will trigger with the FrontPanelBrightnessHighEventId.


(Inherited from Dmps3SystemControl)
Public propertyFrontPanelBrightnessLowObsolete.
Sets the front panel brightness to low.
(Inherited from Dmps3SystemControl)
Public propertyCode exampleFrontPanelBrightnessLowFeedBack Indicates if the front panel brightness level is currently set to low.

The DMSystemChange event will trigger with the FrontPanelBrightnessLowEventId.


(Inherited from Dmps3SystemControl)
Public propertyFrontPanelBrightnessMediumObsolete.
Sets the front panel brightness to Medium.
(Inherited from Dmps3SystemControl)
Public propertyCode exampleFrontPanelBrightnessMediumFeedBack Indicates if the front panel brightness level is currently set to medium.

The DMSystemChange event will trigger with the FrontPanelBrightnessMediumEventId.


(Inherited from Dmps3SystemControl)
Public propertyFrontPanelLockOffFeedback Indicates if the front panel is unlocked and hence available for AV control.

The DMSystemChange event will trigger with the FrontPanelLockOnEventId.


(Inherited from Dmps3SystemControl)
Public propertyFrontPanelLockOnFeedback Indicates if the front panel is locked and hence unavailable for AV control.

The DMSystemChange event will trigger with the FrontPanelLockOnEventId.


(Inherited from Dmps3SystemControl)
Public propertyFrontPanelLockTextEnable Enabling this will allow for custom text when Front Panel control is attempted when the Front Panel is Locked.
(Inherited from Dmps3SystemControl)
Public propertyFrontPanelLockTextLine1 Line 1 of Custom Front Panel Locked message text.
(Inherited from Dmps3SystemControl)
Public propertyFrontPanelLockTextLine2 Line 2 of Custom Front Panel Locked message text.
(Inherited from Dmps3SystemControl)
Public propertyFrontPanelPassword Sets the front panel password, which allows the user to enter the Installer Tools menu from the front panel. Valid values range from 0d (no password required) to 9999d.
(Inherited from Dmps3SystemControl)
Public propertyFrontPanelPasswordFeedBack Indicates the current front panel password.

The DMSystemChange event will trigger with the FrontPanelPasswordEventId.


(Inherited from Dmps3SystemControl)
Public propertyPnmModeFeedBack Indicates if Private Network Mode (PNM) is enabled.

The DMSystemChange event will trigger with the PnmModeEventId.


(Inherited from Dmps3SystemControl)
Public propertySaveSettings This signal is not implemented for the DMPS3.
(Inherited from Dmps3SystemControl)
Public propertySavingSettingsFeedback This signal is not implemented for the DMPS3.
(Inherited from Dmps3SystemControl)
Public propertySessionInitiation Specifies the streaming session initiation status
Public propertySessionInitiationFeedback Reports the current streaming session initiation status

The DMSystemChange event will trigger with the SessionInitiationEventId.

Public propertyStreamBitrate Property to set the stream bitrate.
Public propertyStreamBitrateFeedback Property to return the stream bitrate.
Public propertyStreamingAudioBass Adjusts the bass settings for the streaming audio output in tenths of a dB. Valid values range from -150 (-15dB) to 150 (+15dB).
Public propertyStreamingAudioBassFeedback Reports the bass settings for the streaming audio output in tenths of a dB. Valid values range from -150 (-15dB) to 150 (+15dB).

The DMSystemChange event will trigger with the StreamingBassEventId.

Public propertyStreamingAudioMuteFeedback Indicates that streaming output audio is muted.

The DMSystemChange event will trigger with StreamingAudioMuteEventId.

Public propertyStreamingAudioUnmuteFeedback Indicates that the output audio is not muted.

The DMSystemChange event will trigger with StreamingAudioUnmuteEventId.

Public propertyStreamingAudioVolume Property to set the current streaming audio volume in tenths of a dB. Valid values range from -800 (-80dB) to 0 (0dB).
Public propertyStreamingAudioVolumeFeedback Reports the current streaming audio volume in tenths of a dB. Valid values range from -800 (-80dB) to 0 (0dB).

The DMSystemChange event will trigger with the StreamingVolumeEventId.

Public propertyStreamingBuffer Property to set the length of video that will be cached in milliseconds.

Valid values range from 50 to 5000, where 1 = 1 ms.

Public propertyStreamingBufferFeedback Property to return the length of video that will be cached in milliseconds.

Valid values range from 50 to 5000, where 1 = 1 ms.

The DMSystemChange event will trigger with the StreamingBufferEventId.

Public propertyStreamingDeviceMode Property to set the streaming device mode.
Public propertyStreamingDeviceProcessingBusy Indicates that the streaming device is changing state (starting the stream, stopping the stream, etc) and is busy.

Please wait until the signal is 'false' before sending commands to the device.

'true' = busy; 'false' = not busy

The DMSystemChange event will trigger with StreamingDeviceProcessingBusyFeedbackEventId.

Public propertyStreamingDeviceReadyFeedback Indicates that the device is ready to start streaming or preview video.

The device may not be ready if the IP address has changed or another system event has caused a re-configuration.

The appropriate feedback for those parameters should be checked to ensure that the stream starts correctly.

Start signals will be ignored until the device is ready to start streaming.

'true' = Device is ready; 'false' = Device is not ready.

The DMSystemChange event will trigger with StreamingDeviceReadyFeedbackEventId.

Public propertyStreamingElapsedSecondsFeedback Indicates the time elapsed (in seconds) since streaming was started.

The DMSystemChange event will trigger with the ElapsedSecondsFeedbackEventId.

Public propertyStreamingInitiatorAddressFeedback Property to return the streaming Initiator Address.

The DMSystemChange event will trigger with the StreamingInitiatorAddressFeedbackEventId.

Public propertyStreamingMulticastAddress Specifies the multicast address to which the streaming device will try to transmit

whenSessionInitiation is in MulticastViaUDP.

Public propertyStreamingMulticastAddressFeedback Indicates the multicast address from which the streaming device is receiving

whenSessionInitiation is in MulticastViaRTSPor in MulticastViaUDP.

The DMSystemChange event will trigger with the MulticastAddressEventId.

Public propertyStreamingPauseFeedback Indicates that the stream is paused. The output remains 'true' for as long as the stream is paused.

The DMSystemChange event will trigger with StreamingPauseFeedbackEventId.

Public propertyStreamingServerUrl Property to set the Server URL.
Public propertyStreamingServerUrlFeedback Property to return the current Server URL.

The DMSystemChange event will trigger with the ServerUrlEventId.

Public propertyStreamingStartFeedback Indicates if streaming has started. 'true' = Streaming started; 'false' = Streaming has not started.

The DMSystemChange event will trigger with StreamingStartFeedbackEventId.

Public propertyStreamingStatusFeedback Property to report the streaming status.

The DMSystemChange event will trigger with the StreamingStatusFeedbackEventId.

Valid values are: 0 - Stream stopped, 1 - Stream started, 2 - Stream paused, 3 - Connecting, Other values are reserved.

Public propertyStreamingStatusTextFeedback Property to return the streaming status text.

The DMSystemChange event will trigger with the StreamingStatusTextFeedbackEventId.

Public propertyStreamingStopFeedback Indicates the stream status. 'true' = Stream stopped; 'false' = Stream not stopped.

The DMSystemChange event will trigger with StreamingStopFeedbackEventId.

Public propertyStreamingTransportMode Property to set the Streaming Transport Mode.

Note: StreamingTransportMode must be set prior to triggering StreamingStart.

Public propertyStreamingTransportModeFeedback Property to report the current Streaming Transport Mode.

The DMSystemChange event will trigger with the StreamingTransportModeEventId.

Public propertyStreamingTreble Adjusts the treble settings for the streaming output in tenths of a dB. Valid values range from -150 (-15dB) to 150 (+15dB).
Public propertyStreamingTrebleFeedback Returns the current treble settings for the specified streaming output. Valid values range from -150 (-15dB) to 150 (+15dB).

The DMSystemChange event will trigger with the StreamingTrebleEventId.

Public propertyStreamingUserName Specifies the user name for the stream. The user name can consist of up to 200 characters.
Public propertyStreamingUserNameFeedback Text string that reports the user name used for the stream.

The DMSystemChange event will trigger with the StreamingUserNameEventId.

Public propertyStreamPassword Sets the password for the stream. The password can consist of up to 200 characters.
Public propertyStreamPasswordFeedback Text string that reports the password used for the stream.

The DMSystemChange event will trigger with the StreamingPasswordEventId.

Public propertyStreamPasswordProtectionDisableFeedback Indicates the status of the password protection on the stream. 'true = Password disabled; 'false' = password enabled.

The DMSystemChange event will trigger with PasswordProtectionDisabledEventId.

Public propertyStreamPasswordProtectionEnableFeedback Indicates the status of the password protection on the stream. 'true' = Password enabled; 'false' = password disabled.

The DMSystemChange event will trigger with PasswordProtectionEnabledEventId.

Public propertyStreamProfile Property to set the stream profile.
Public propertyStreamProfileFeedback Property to return the stream profile.

The DMSystemChange event will trigger with the StreamProfileEventId.

Public propertySystemControlType Property to determine what type of switcher we are in.
(Inherited from Dmps3SystemControl)
Public propertySystemId This signal is not implemented for the DMPS3.
(Inherited from Dmps3SystemControl)
Public propertySystemIdBusyFeedback This signal is not implemented for the DMPS3.
(Inherited from Dmps3SystemControl)
Public propertySystemIdFeedback Indicates the current System ID (if Private Network Mode is enabled).

The DMSystemChange event will trigger with the SystemIdEventId.


(Inherited from Dmps3SystemControl)
Public propertySystemPowerButtonPressedFeedBack Indicates if the system power button on the front panel is being pressed.

The DMSystemChange event will trigger with the SystemPowerButtonEventId.


(Inherited from Dmps3SystemControl)
Public propertySystemPowerOffFeedBack Indicates if system power is off.

The DMSystemChange event will trigger with the SystemPowerOffEventId.


(Inherited from Dmps3SystemControl)
Public propertySystemPowerOnFeedBack Indicates if system power is on

The DMSystemChange event will trigger with the SystemPowerOnEventId.


(Inherited from Dmps3SystemControl)
Public propertyUSBEnter This signal is not implemented for the DMPS3.
(Inherited from Dmps3SystemControl)
Public propertyVideoEnter This signal is not implemented for the DMPS3.
(Inherited from Dmps3SystemControl)
Top
Methods
 NameDescription
Public methodDisableStreamPasswordProtection Disables password protection on the stream.
Public methodEnableStreamPasswordProtection Enables password protection of stream.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodCode exampleFrontPanelBrightness Sets the front panel brightness to the specified setting.
(Inherited from Dmps3SystemControl)
Public methodFrontPanelLockOff Unlocks the front panel. This signifies that AV routing can be done from the front panel.
(Inherited from Dmps3SystemControl)
Public methodFrontPanelLockOn Locks out the front panel. This signifies that no AV routing can be done from the front panel.
(Inherited from Dmps3SystemControl)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodStreamingAudioMute Mutes the stream output audio.
Public methodStreamingAudioUnmuted Unmutes the streaming output audio.
Public methodStreamingPause Pause the streaming.

Note: although the incoming video to the encoder is paused (frozen),the stream will continue playing and the elapsed time counter will continue in the paused state.This allows a freeze frame to be displayed if the user does not want live video to be transmitted.

Public methodStreamingStart Start the streaming.
Public methodStreamingStop Stops the streaming
Public methodSystemPowerOff Turn the system power off.
(Inherited from Dmps3SystemControl)
Public methodSystemPowerOn Turn the system power on.
(Inherited from Dmps3SystemControl)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also