Click or drag to resize

DmRmc100Str Class

Standalone DM Streaming Device with Text and Image Overlay functionality.

This class will trigger BaseEvent, AttributeChange, ControlChange, DeviceInformationChange, CecChange, StreamChange and OverlayPropertiesChange events.

Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProGenericBase
    Crestron.SimplSharpProGenericDevice
      Crestron.SimplSharpPro.DM.StreamingDm100xStrBase
        Crestron.SimplSharpPro.DM.StreamingDmRmc100Str

Namespace: Crestron.SimplSharpPro.DM.Streaming
Assembly: Crestron.SimplSharpPro.DM (in Crestron.SimplSharpPro.DM.dll) Version: 2.21.121
Syntax
C#
public sealed class DmRmc100Str : Dm100xStrBase

The DmRmc100Str type exposes the following members.

Constructors
 NameDescription
Public methodDmRmc100Str(UInt32, CrestronControlSystem) Card Constructor for DmRmc100Str that uses Ethernet as interface.
Public methodDmRmc100Str(UInt32, DmXioDirectorBaseDmXioDomain, Boolean) Constructor for DmRmc100Str to add it as a transmitter or receiver endpoint to the DmXioDirector80/DmXioDirector160 or DmXioDirectorEnterprise Domain.
Top
Properties
 NameDescription
Public propertyAutomaticPowerSettings Automatic Power Setting present on this device

This property will trigger AutomaticPowerSettingChange with DMInputEventIds This property is not supported by "DmNvxE30", "DmNvxE30C", "DmNvxE31", "DmNvxE31C", "DmNvxD10" "DmNvx352" and "DmNvxD20" devices.


(Inherited from Dm100xStrBase)
Public propertyComPorts Collection of serial COM ports on the device.
(Inherited from Dm100xStrBase)
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 propertyControl The Common Stream control.

This property will trigger BaseEvent event with DMInputEventIds.


(Inherited from Dm100xStrBase)
Public propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from Dm100xStrBase)
Public propertyEndpointName This is a string property that is used to access the name of the endpoint.
(Inherited from Dm100xStrBase)
Public propertyHdmiOut HDMI output present on this device

This property will trigger StreamChange with DMOutputEventIds, AttributeChange with VideoAttributeEventIds, DeviceInformationChange with ConnectedDeviceEventIds and CecChange with CecEventIds.

This property is not supported by "DmNvxE30", "DmNvxE30C", "DmNvxE31" and "DmNvxE31C".
(Inherited from Dm100xStrBase)
Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyImageProperties Image Overlay properties of this device. This property is not supported by "DmNvxBaseClass".

This property will trigger OverlayPropertiesChange with event IDs defined in DmRmc100Str.

This property is not supported by "DmNvxD30", "DmNvxD30C", "DmNvxE30", "DmNvxE30C", "DmNvxE31" and "DmNvxE31C" devices.
(Inherited from Dm100xStrBase)
Public propertyIROutputPorts Collection of IR output ports on the device.
(Inherited from Dm100xStrBase)
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 propertyNumberOfComPorts Number of serial COM ports this device supports.
(Inherited from Dm100xStrBase)
Public propertyNumberOfIROutputPorts Number of IR output ports this device supports.
(Inherited from Dm100xStrBase)
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)
Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertySourceReceive Source Receive present on this device

This property will trigger StreamChange with DMInputEventIds and AttributeChange with VideoAttributeEventIds.

This property is not supported by "DmNvxE30", "DmNvxE30C", "DmNvxE31" and "DmNvxE31C" devices.
(Inherited from Dm100xStrBase)
Public propertyTextProperties Text Overlay properties of this device

This property will trigger OverlayPropertiesChange with event IDs defined in DmRmc100Str.


(Inherited from Dm100xStrBase)
Public propertyType Property to determine to type of device this is.
(Inherited from GenericDevice)
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)
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 methodDispose Clean up of resources.
(Inherited from GenericBase)
Protected methodDispose(Boolean) Method to perform the actual disposing of the device.
(Inherited from Dm100xStrBase)
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 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 methodRegister Register this device with the system.
(Inherited from GenericDevice)
Public methodToString Return the name of the device.
(Inherited from GenericDevice)
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 eventEndpointNameChange Event triggered when endpoint name changed for this endpoint on a DmXioDirectorBaseDmXioDomain.
(Inherited from Dm100xStrBase)
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
Example
C#
static DmRmc100Str _dmRmc100Str;

public ControlSystemDmRmc100Str()
{
    //Register console commands
    CrestronConsole.AddNewConsoleCommand(StartCmd, "Start", "This is a DM-RMC-100-STR Start command", ConsoleAccessLevelEnum.AccessOperator);
    CrestronConsole.AddNewConsoleCommand(PauseCmd, "Pause", "This is a DM-RMC-100-STR Pause command", ConsoleAccessLevelEnum.AccessOperator);

    CrestronConsole.AddNewConsoleCommand(CreateDeviceCmd, "CreateDevice", "This is a DM-RMC-100-STR CreateDevice command", ConsoleAccessLevelEnum.AccessOperator);
}

//Method to create the DM-RMC-100-STR device.
public void CreateDeviceCmd(String args)
{
    //Initialize the DM-RMC-100-STR device for Ethernet Communication.
    _dmRmc100Str = new DmRmc100Str(0x18, this);

    _dmRmc100Str.BaseEvent += DmRmc100StrEventHandler;

    _dmRmc100Str.HdmiOut.VideoAttributes.AttributeChange += DmRmc100StrVideoAttributeEventHandler;
    _dmRmc100Str.HdmiOut.StreamCec.CecChange += DmRmc100StrCecChangeEventHandler;
    _dmRmc100Str.HdmiOut.StreamChange += DmRmc100Str_StreamChangeEventHandler;
    _dmRmc100Str.HdmiOut.ConnectedDevice.DeviceInformationChange += DmRmc100StrDeviceInfoChangeEventHandler;

    _dmRmc100Str.SourceReceive.VideoAttributes.AttributeChange += DmRmc100StrVideoAttributeEventHandler;
    _dmRmc100Str.SourceReceive.StreamChange += DmRmc100Str_StreamChangeEventHandler;

    _dmRmc100Str.TextProperties.OverlayPropertiesChange += DmRmc100StrOverlayPropertiesEventHandler;
    _dmRmc100Str.ImageProperties.OverlayPropertiesChange += DmRmc100StrOverlayPropertiesEventHandler;

    _dmRmc100Str.Register();
}

//Method to start trigger streaming of the input
public void StartCmd(String args)
{
    _dmRmc100Str.Control.Start();

    CrestronConsole.PrintLine("Streaming started on DM-RMC-100-STR");
}

//Method to pause the streaming of the input
public void PauseCmd(String args)
{
    _dmRmc100Str.Control.Pause();
}

//Method to handle top level sig change events for DM-RMC-100-STR Device.
static void DmRmc100StrEventHandler(GenericBase device, BaseEventArgs args)
{
    if (args.EventId == DMOutputEventIds.SyncDetectedEventId)
    {
        CrestronConsole.PrintLine("Sync detected on DM-RMC-100-STR, SyncDetectedFeedback value is {0}", _dmRmc100Str.HdmiOut.SyncDetectedFeedback.BoolValue);
    }
}

//Method to handle HDMI Out and Stream Receive sig change events for DM-RMC-100-STR Device.
static void DmRmc100Str_StreamChangeEventHandler(Stream stream, StreamEventArgs args)
{
    if (args.EventId == DMInputEventIds.StatisticsEnableEventId)
    {
        CrestronConsole.PrintLine("{0} device Statistics Enable Event Occurred\r\n", stream.ToString());
    }
}

//Method to handle HDMI Out and Stream Receive Video Attributes sig change events for DM-RMC-100-STR Device.
static void DmRmc100StrVideoAttributeEventHandler(object sender, GenericEventArgs args)
{
    if (args.EventId == VideoAttributeEventIds.HorizontalResolutionFeedbackEventId)
    {
        CrestronConsole.PrintLine("{0} device Horizontal Resolution Feedback Event Occurred\r\n", sender.ToString());
    }
}

//Method to handle HDMI Out CEC sig change events for DM-RMC-100-STR Device.
static void DmRmc100StrCecChangeEventHandler(Cec cecDevice, CecEventArgs args)
{
    if (args.EventId == CecEventIds.ErrorFeedbackEventId)
    {
        CrestronConsole.PrintLine(string.Format("Device: {0} - Cec Error Detected Status: {1}", _dmRmc100Str.ToString(), _dmRmc100Str.HdmiOut.StreamCec.ErrorFeedback.BoolValue));
    }
}

//Method to handle HDMI Out ConnectedDeviceInformation sig change events for DM-RMC-100-STR Device.
static void DmRmc100StrDeviceInfoChangeEventHandler(ConnectedDeviceInformation connectedDevice, ConnectedDeviceEventArgs args)
{
    if (args.EventId == ConnectedDeviceEventIds.ManufacturerEventId)
    {
        CrestronConsole.PrintLine("{0} device Manufacturer Name Feedback Event Occurred\r\n", _dmRmc100Str.HdmiOut.ConnectedDevice.ToString());
    }
}

//Method to handle Text/Image Overlay Properties sig change events for DM-RMC-100-STR Device.
static void DmRmc100StrOverlayPropertiesEventHandler(object device, OverlayPropertiesEventArgs args)
{
    if (args.EventId == OverlayEventIds.EnabledEventId)
    {
        CrestronConsole.PrintLine("Enable Event Received for {0}\r\n", args.OverlayProperties.Type);
    }
}

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also