Click or drag to resize

DmcStr Class

DMC-STR Streaming Input Card

This class will trigger BaseEvent, DMInputChange, AttributeChange, CecChange and DeviceInformationChange events.

Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.DM.Cards
Assembly: Crestron.SimplSharpPro.DM (in Crestron.SimplSharpPro.DM.dll) Version: 2.21.121
Syntax
C#
public class DmcStr : CardDevice, IDmCardCommonAudioAndVideoSigs, 
	IDmCardCommonEthernetSigs

The DmcStr type exposes the following members.

Constructors
 NameDescription
Public methodDmcStr(UInt32, CrestronControlSystem) Card Constructor for an external DMCI version of this DmcStr that uses Ethernet as interface.

DMInputEvents that would have triggered the Switcher'sDMInputChange event will trigger the BaseEvent for this class.

Public methodDmcStr(UInt32, Switch) Card Constructor for DmcStr to drop on Switch.
Top
Properties
 NameDescription
Public propertyAudioMuteFeedback Indicates that the output audio is muted.

The BaseEvent event will trigger with AudioMuteEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with AudioMuteEventId when this DmcStr is connected to a Switch.

Public propertyAudioUnmuteFeedback Indicates that the output audio is not muted.

The BaseEvent event will trigger with AudioUnmuteEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with AudioUnmuteEventId when this DmcStr is connected to a Switch.

Public propertyBass Sets the bass level for the audio output. Valid values range from -150 (-15dB) to +150 (+15dB), where 1 = 0.1dB.
Public propertyBassFeedback Reports the bass level for the audio output.

The BaseEvent event will trigger with BassEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with BassEventId when this DmcStr is connected to a Switch.

Public propertyConnectedIpList A property containing the list of the ConnectedIpInformation objects which contain information about the devices that are connected to this IP ID. This property is only valid for an ethernet device. If this is not an ethernet device, then this property will return null. If this is an ethernet device, the list will be non-null. It will be empty if no devices are connected. The order of items in this list is not guaranteed.
(Inherited from GenericDevice)
Public propertyContentLanFeedback Reports the current content LAN mode.

The BaseEvent event will trigger with DisableDhcpEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with DisableDhcpEventId when this DmcStr is connected to a Switch.

Public propertyContentLanLinkStatusFeedback Indicates if an Ethernet link is detected at the content LAN input of the DmcStr. 'true = Ethernet link detected; 'false = Ethernet link not detected.

The BaseEvent event will trigger with ContentLanLinkStatusEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with ContentLanLinkStatusEventId when this DmcStr is connected to a Switch.

Public propertyContentLanMode Sets the Content LAN Mode. (Sets which interface to use for streaming)
Public propertyControl The object of common stream control class DmcStriControl.

The BaseEvent event will trigger with DMInputEventIds for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with DMInputEventIds when the DmcStr is connected to a Switch.

Public propertyCurrentDefaultRouterFeedback Reports the default router address of the encoder. The default router address is given in dot decimal notation.

The BaseEvent event will trigger with CurrentDefaultRouterEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with CurrentDefaultRouterEventId when this DmcStr is connected to a Switch.

Public propertyCurrentDomainnameFeedback Reports the current domain name of the encoder.

The BaseEvent event will trigger with CurrentDomainNameEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with CurrentDomainNameEventId when this DmcStr is connected to a Switch.

Public propertyCurrentDomainNameServer Property to set the current DNS Server that is to be used by the encoder. Maximum length is 200.
Public propertyCurrentDomainNameServerFeedback Reports the current DNS server that is used by the encoder.

The BaseEvent event will trigger with DomainNameServerEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with DomainNameServerEventId when this DmcStr is connected to a Switch.

Public propertyCurrentIpAddressFeedback Reports the current IP address of the encoder. The IP address is given in dot decimal notation.

The BaseEvent event will trigger with CurrentIpAddressEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with CurrentIpAddressEventId when this DmcStr is connected to a Switch.

Public propertyCurrentIpv6AddressFeedback Property to return the current IPv6 Address.

The BaseEvent event will trigger with CurrentIpv6AddressEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with CurrentIpv6AddressEventId when this DmcStr is connected to a Switch.

Public propertyCurrentSubnetMaskFeedback Reports the current subnet mask of the encoder. The subnet mask is given in dot decimal notation.

The BaseEvent event will trigger with CurrentSubnetMaskEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with CurrentSubnetMaskEventId when this DmcStr is connected to a Switch.

Public propertyDacOutVolume Property to set the DAC Out Volume.
Public propertyDacOutVolumeFeedback Property to report the current DAC Out Volume.

The BaseEvent event will trigger with DacVolumeEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with DacVolumeEventId when this DmcStr is connected to a Switch.

Public propertyDelay Sets the delay value. Valid values range from 0 (0ms) to 400 (40ms), where 1 = 0.1ms.
Public propertyDelayFeedback Returns the delay value.

The BaseEvent event will trigger with DelayEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with DelayEventId when this DmcStr is connected to a Switch.

Public propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDisableDhcpFeedback Indicates that DHCP (dynamic IP addressing) is disabled. 'true = DHCP Disabled; 'false' = DHCP Enabled

The BaseEvent event will trigger with DisableDhcpEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with DisableDhcpEventId when this DmcStr is connected to a Switch.

Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyEnableDhcpFeedback Indicates that DHCP (dynamic IP addressing) on the encoder is enabled. 'true = DHCP Enabled; 'false' = DHCP Disabled

The BaseEvent event will trigger with EnableDhcpEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with EnableDhcpEventId when this DmcStr is connected to a Switch.

Public propertyHdmiOutInputCardHdmiOutPort for this DmcStr.
Public propertyHostName Sets the hostname of the encoder. The hostname can consist of up to 63 characters with no spaces. Valid characters are 0 – 9, A – Z and hyphen. The hostname cannot begin with a hyphen or number.
Public propertyHostNameFeedback Reports the hostname of the encoder.

The BaseEvent event will trigger with HostNameEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with HostNameEventId when this DmcStr is connected to a Switch.

Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyNtpServer Property to set the NTP Server. The maximum length is 200.
Public propertyNtpServerFeedback Property to return the NTP Server.

The BaseEvent event will trigger with NtpServerEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with NtpServerEventId when this DmcStr is connected to a Switch.

Public propertyOsdDisableFeedback Property to indicate that the OSD is disabled.

The BaseEvent event will trigger with OsdDisableEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with OsdDisableEventId when this DmcStr is connected to a Switch.

Public propertyOsdEnableFeedback Property to indicate that the OSD is enabled.

The BaseEvent event will trigger with OsdEnableEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with OsdEnableEventId when this DmcStr is connected to a Switch.

Public propertyOsdLocation Property to set the OSD location.
Public propertyOsdLocationFeedback Property to report the current OSD location.

The BaseEvent event will trigger with OsdLocationEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with OsdLocationEventId when this DmcStr is connected to a Switch.

Public propertyOsdText Property to set the OSD Text. Maximum length is 200.
Public propertyOsdTextFeedback Property to return the current OSD Text.

The BaseEvent event will trigger with OsdTextEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with OsdTextEventId when this DmcStr is connected to a Switch.

Public propertyOsdXPosition Property to set the OSD X Position. Valid range is 0-1920 in pixels.
Public propertyOsdXPositionFeedback Property to report the current OSD X Position.

The BaseEvent event will trigger with OsdXPositionEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with OsdXPositionEventId when this DmcStr is connected to a Switch.

Public propertyOsdYPosition Property to set the OSD Y Position. Valid range is 0-1200.
Public propertyOsdYPositionFeedback Property to report the current OSD Y Position.

The BaseEvent event will trigger with OsdYPositionEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with OsdYPositionEventId when this DmcStr is connected to a Switch.

Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
Public propertyRegisterable Property to indicate that this device can be registered.
(Inherited from GenericDevice)
Public propertyRegistered Property to get the current registration state of the device.
(Inherited from GenericDevice)
Public propertyRegistrationFailureReason Property to get the Registration Failure Reason, this will match the return value from the call to register.
(Inherited from GenericDevice)
Public propertyResolution Property to set the resolution of the screen.
Public propertyResolutionFeedback Property to report the current screen resolution.

The BaseEvent event will trigger with ResolutionEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with ResolutionEventId when this DmcStr is connected to a Switch.

Public propertyRtpAudioPort Property to set the RTSP Audio Port.
Public propertyRtpAudioPortFeedback Property to report the current RTSP Audio Port.

The BaseEvent event will trigger with RtpAudioPortEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with RtpAudioPortEventId when this DmcStr is connected to a Switch.

Public propertyRtpVideoPort Property to set the RTSP Video Port.
Public propertyRtpVideoPortFeedback Property to report the current RTSP Video Port.

The BaseEvent event will trigger with RtpVideoPortEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with RtpVideoPortEventId when this DmcStr is connected to a Switch.

Public propertyRtspPort Property to set the RTSP Port.
Public propertyRtspPortFeedback Property to report the current RTSP Port.

The BaseEvent event will trigger with RtspPortEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with RtspPortEventId when this DmcStr is connected to a Switch.

Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertySource Source present on this DmcStr.
Public propertyStaticDefaultRouter Sets the static default router address of the encoder. Note that these settings will only be used when DHCP is disabled!
Public propertyStaticDefaultRouterFeedback Report the static default router address of the encoder. The default router address is given in dot decimal notation.

The BaseEvent event will trigger with StaticDefaultRouterEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with StaticDefaultRouterEventId when this DmcStr is connected to a Switch.

Public propertyStaticDomainName Sets the static domain name of the encoder. The domain name should be set according to the requirements of the network administrator. Note that the StaticDomainName will only be used when DHCP is disabled!
Public propertyStaticDomainNameFeedback Reports the static domain name of the encoder.

The BaseEvent event will trigger with StaticDomainNameEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with StaticDomainNameEventId when this DmcStr is connected to a Switch.

Public propertyStaticDomainNameServer Sets the static DNS (Domain Name Server) that the encoder will use. The string format is in dot decimal notation. Note that the StaticDomainNameServer will only be used when DHCP is disabled!
Public propertyStaticDomainNameServerFeedback Reports the static DNS server that is used by the encoder.

The BaseEvent event will trigger with StaticDomainNameServerEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with StaticDomainNameServerEventId when this DmcStr is connected to a Switch.

Public propertyStaticIpAddress Sets the static IP address of the encoder. Note that these settings will only be used when DHCP is disabled!
Public propertyStaticIpAddressFeedback Report the static IP address of the encoder. The IP address is given in dot decimal notation.

The BaseEvent event will trigger with StaticIpAddressEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with StaticIpAddressEventId when this DmcStr is connected to a Switch.

Public propertyStaticIpv6Address Property to set the Static IPv6 Address. The maximum length is 200.
Public propertyStaticIpv6AddressFeedback Property to report the current Static IPv6 Address.

The BaseEvent event will trigger with StaticIpv6AddressEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with StaticIpv6AddressEventId when this DmcStr is connected to a Switch.

Public propertyStaticSubnetMask Sets the static subnet mask of the encoder. Note that these settings will only be used when DHCP is disabled!
Public propertyStaticSubnetMaskFeedback Report the static subnet mask of the encoder. The subnet mask is given in dot decimal notation.

The BaseEvent event will trigger with StaticSubnetMaskEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with StaticSubnetMaskEventId when this DmcStr is connected to a Switch.

Public propertyStatisticsDisableFeedback Property to indicate that the Statistics is disabled.

The BaseEvent event will trigger with StatisticsDisableEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with StatisticsDisableEventId when this DmcStr is connected to a Switch.

Public propertyStatisticsEnableFeedback Property to indicate that the Statistics is enabled.

The BaseEvent event will trigger with StatisticsEnableEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with StatisticsEnableEventId when this DmcStr is connected to a Switch.

Public propertyStatisticsNumberOfAudioPacketsDroppedFeedback Property to report the Number of Audio Packets Dropped.

The BaseEvent event will trigger with StatisticsNumberOfAudioPacketsDroppedEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with StatisticsNumberOfAudioPacketsDroppedEventId when this DmcStr is connected to a Switch.

Public propertyStatisticsNumberOfAudioPacketsReceivedFeedback Property to report the Number of Audio Packets Received.

The BaseEvent event will trigger with StatisticsNumberOfAudioPacketsReceivedEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with StatisticsNumberOfAudioPacketsReceivedEventId when this DmcStr is connected to a Switch.

Public propertyStatisticsNumberOfVideoPacketsDroppedFeedback Property to report the Number of Video Packets Dropped.

The BaseEvent event will trigger with StatisticsNumberOfVideoPacketsDroppedEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with StatisticsNumberOfVideoPacketsDroppedEventId when this DmcStr is connected to a Switch.

Public propertyStatisticsNumberOfVideoPacketsReceivedFeedback Property to report the Number of Video Packets Received.

The BaseEvent event will trigger with StatisticsNumberOfVideoPacketsReceivedEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with StatisticsNumberOfVideoPacketsReceivedEventId when this DmcStr is connected to a Switch.

Public propertyStreamFramesPerSecondFeedback Property to report the current Stream Frames Per Second value. The values reported are between 0-85 Hz.

The BaseEvent event will trigger with StreamFramesPerSecondEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with StreamFramesPerSecondEventId when this DmcStr is connected to a Switch.

Public propertyStreamHorizontalResolutionFeedback Property to report the current Stream Horizontal Resolution in pixels. The values reported are between 0-1920.

The BaseEvent event will trigger with StreamHorizontalResolutionEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with StreamHorizontalResolutionEventId when this DmcStr is connected to a Switch.

Public propertyStreamVerticalResolutionFeedback Property to report the current Stream Vertical Resolution. The values reported are between 0-1200.

The BaseEvent event will trigger with StreamVerticalResolutionEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with StreamVerticalResolutionEventId when this DmcStr is connected to a Switch.

Public propertySwitcher Switcher this card is attached to.
(Inherited from CardDevice)
Public propertySwitcherInputOutput Reference back to this cards corresponding switcher input or output.
(Inherited from CardDevice)
Public propertyTimesetMethod Property to set the Timeset Method.
Public propertyTimesetMethodFeedback Property to report the current Timeset Method.

The BaseEvent event will trigger with TimesetMethodEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with TimesetMethodEventId when this DmcStr is connected to a Switch.

Public propertyTimeZone Property to set the current Time Zone.
Public propertyTimeZoneFeedback Property to report the current Time Zone.

The BaseEvent event will trigger with TimeZoneEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with TimeZoneEventId when this DmcStr is connected to a Switch.

Public propertyTreble Sets the treble level for the audio output. Valid values range from -150 (-15dB) to +150 (+15dB), where 1 = 0.1dB.
Public propertyTrebleFeedback Reports the treble level for the audio output.

The BaseEvent event will trigger with TrebleEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with TrebleEventId when this DmcStr is connected to a Switch.

Public propertyTsPort Property to set the TS Port.
Public propertyTsPortFeedback Property to report the current TS Port.

The BaseEvent event will trigger with TsPortEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with TsPortEventId when this DmcStr is connected to a Switch.

Public propertyType The type of card created
(Inherited from CardDevice)
Public propertyUnRegistrationFailureReason Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister.
(Inherited from GenericDevice)
Public propertyUserSpecifiedObject Can be assigned anything that user wants.
(Inherited from GenericBase)
Public propertyVolume Sets the volume level as a percentage. Valid values range from 0 to 100%.
Public propertyVolumeFeedback Reports the volume level.

The BaseEvent event will trigger with VolumeEventId for DMCI Version of DmcStr or DmcStrCresnet.

The DMInputChange event will trigger with VolumeEventId when this DmcStr is connected to a Switch.

Protected propertyXioEndpointStubSIMPLDevice The SIMPL "stub" Device that the XiO Director creates for an endpoint to send the 1C/0E to the correct place in hierarchy.
(Inherited from GenericDevice)
Top
Methods
 NameDescription
Public methodAudioMute Mutes the output audio.
Public methodAudioUnmute Unmutes the output audio.
Public methodDisableDhcp Disables DHCP (dynamic IP addressing) of the input.
Public methodDisableStatistics Method to disable the Statistics.
Public methodDispose Clean up of resources.
(Inherited from GenericBase)
Protected methodDispose(Boolean) Override of the dispose method to remove the card from the switcher. This is only valid for Input cards and Output card modules (e.g. DmcoXX)
(Inherited from CardDevice)
Public methodEnableDhcp Enables DHCP (dynamic IP addressing) on the encoder of the input.
Public methodEnableStatistics Method to enable the Statistics.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Destructor of the device.
(Inherited from GenericDevice)
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)
Protected methodOnBaseEvent(Int32) Protected member used to fire the BaseEvent with the default extended information.
(Inherited from GenericBase)
Protected methodOnBaseEvent(Int32, UInt16) Protected member used to fine the BaseEvent with extended event information.
(Inherited from GenericBase)
Public methodOsdDisable Method to disable the OSD.
Public methodOsdEnable Method to enable the OSD.
Public methodRegister Register this device with the system.
(Inherited from GenericDevice)
Public methodResetStatistics Method to reset the Statistics.
Public methodToString String representation of this DM card.
(Inherited from CardDevice)
Public methodUnRegister Unregister this device with the system. This function can not be called from the device's own SigChange event handler.

On successful unregistration, if this device supports the OnlineStatusChange event, it will trigger indicating the device when offline.


(Inherited from GenericDevice)
Top
Events
 NameDescription
Public eventBaseEvent Generic base event, triggered when the there are no other handlers available for a specific EventID.
(Inherited from GenericBase)
Public eventIpInformationChange Event that tells what IP Address is connected/disconnected from an IP ID for a non-UDP device. This is only valid for an Ethernet device. An exception will be thrown if it is not.
(Inherited from GenericDevice)
Public eventOnlineStatusChange Event triggered when the Online status of the device changes.
(Inherited from GenericDevice)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also