Click or drag to resize

DmfXx4kSfp Class

Fiber extender DM Device class.

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

Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProGenericBase
    Crestron.SimplSharpProGenericDevice
      Crestron.SimplSharpPro.DM.StreamingDmfXx4kSfp

Namespace: Crestron.SimplSharpPro.DM.Streaming
Assembly: Crestron.SimplSharpPro.DM (in Crestron.SimplSharpPro.DM.dll) Version: 2.21.121
Syntax
C#
public sealed class DmfXx4kSfp : GenericDevice, 
	IIROutputPorts, IComPorts

The DmfXx4kSfp type exposes the following members.

Constructors
 NameDescription
Public methodDmfXx4kSfp(UInt32, CrestronControlSystem) Constructor for DmfXx4kSfp that uses Ethernet as interface.
Public methodDmfXx4kSfp(UInt32, ICec, CrestronControlSystem) Constructor for DmfXx4kSfp that uses Ethernet as interface.
Top
Properties
 NameDescription
Public propertyComPorts Collection of serial COM ports on the device.
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.

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 GenericDevice)
Public propertyDmOut DM Out present on this device

This property will trigger OutputStreamChange with EndpointOutputStreamEventIds and AttributeChange with VideoAttributeEventIds.

Public propertyHdmiIn HDMI In present on this device

This property will trigger StreamChange with DMInputEventIds, AttributeChange with VideoAttributeEventIds and CecChange with CecEventIds.

Public propertyHdmiOut HDMI Out present on this device

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

Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyIROutputPorts Collection of IR output ports on the device.
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.
Public propertyNumberOfIROutputPorts Number of IR output ports this device supports.
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 propertyRemoteEnd RemoteEnd present on this device.

This property will trigger RemoteEndSigChange with events IDs defined in DmfXx4kSfp.

Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertyTextProperties Text Overlay present on this device.

This property will trigger OverlayPropertiesChange with OverlayEventIds.

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 GenericDevice)
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 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
Fields
 NameDescription
Public fieldStatic memberAnalogOutputVolumeFeedbackEventId The value of AnalogAudioOutputVolumeFeedback has changed.

The RemoteEndSigChange event will trigger for this event id.

Public fieldStatic memberAudioMutedEventId The state of AudioMutedFeedback has changed.

The RemoteEndSigChange event will trigger for this event id.

Public fieldStatic memberAudioUnmutedEventId The state of AudioUnmutedFeedback has changed.

The RemoteEndSigChange event will trigger for this event id.

Public fieldStatic memberAutomaticInputRoutingDisabledEventId The state of DisableAutomaticInputRoutingFeedback has changed.

The RemoteEndSigChange event will trigger for this event id.

Public fieldStatic memberAutomaticInputRoutingEnabledEventId The state of EnableAutomaticInputRoutingFeedback has changed.

The RemoteEndSigChange event will trigger for this event id.

Public fieldStatic memberLedsDisabledEventId The state of DisableLedsFeedback has changed.

The RemoteEndSigChange event will trigger for this event id.

Public fieldStatic memberLedsEnabledEventId The state of EnableLedsFeedback has changed.

The RemoteEndSigChange event will trigger for this event id.

Public fieldStatic memberNameFeedbackEventId The value of NameFeedback has changed.

The RemoteEndSigChange event will trigger for this event id.

Public fieldStatic memberStatusFeedbackEventId The value of StatusFeedback has changed.

The RemoteEndSigChange event will trigger for this event id.

Public fieldStatic memberVideoSourceFeedbackEventId The value of VideoSourceFeedback has changed.

The RemoteEndSigChange event will trigger for this event id.

Top
Example
C#
static DmfXx4kSfp _dmXx4kSfp;

public ControlSystemDmfXx4kSfp()
{
    //Register console commands
    CrestronConsole.AddNewConsoleCommand(CreateDeviceCmd, "CreateDevice", "This is a DMF-XX-4K-SFP CreateDevice command", ConsoleAccessLevelEnum.AccessOperator);
}

//Method to create the DMF-XX-4K-SFP device
public void CreateDeviceCmd(String args)
{
    //Initialize the DMF-XX-4K-SFP device for Ethernet Communication.
    _dmXx4kSfp = new DmfXx4kSfp(0x18, this);

    _dmXx4kSfp.BaseEvent += DmfXx4kSfpEventHandler;

    _dmXx4kSfp.HdmiIn[1].StreamChange += DmfXx4kSfpStreamChangeEventHandler;
    _dmXx4kSfp.HdmiIn[2].StreamChange += DmfXx4kSfpStreamChangeEventHandler;
    _dmXx4kSfp.HdmiOut.StreamChange += DmfXx4kSfpStreamChangeEventHandler;
    _dmXx4kSfp.TextProperties.OverlayPropertiesChange += DmfXx4kSfpTextOverlayEventHandler;
    _dmXx4kSfp.RemoteEnd.HdmiIn.StreamChange += DmfXx4kSfpStreamChangeEventHandler;
    _dmXx4kSfp.RemoteEnd.HdmiOut.StreamChange += DmfXx4kSfpStreamChangeEventHandler;
    _dmXx4kSfp.RemoteEnd.TextProperties.OverlayPropertiesChange += DmfXx4kSfpTextOverlayEventHandler;

    _dmXx4kSfp.Register();
}

// Method to handle text overlay sig change events for DMF-XX-4K-SFP Device.
static void DmfXx4kSfpTextOverlayEventHandler(object device, OverlayPropertiesEventArgs args)
{
    if (args.EventId == OverlayEventIds.EnabledEventId)
    {
        CrestronConsole.PrintLine("Enabled Event Received for {0}\r\n", args.OverlayProperties.Type);
    }
}

// Method to handle top level sig change events for DMF-XX-4K-SFP Device.
static void DmfXx4kSfpEventHandler(GenericBase device, BaseEventArgs args)
{
    if (args.EventId == DMInputEventIds.AudioMuteEventId)
    {
        CrestronConsole.PrintLine("Audio muted event occurred on DMF-XX-4K-SFP");
    }
}

// Method to handle HDMI input/output stream sig change events for DMF-XX-4K-SFP Device.
static void DmfXx4kSfpStreamChangeEventHandler(Stream stream, StreamEventArgs args)
{
    //HDMI In
    if (args.EventId == DMInputEventIds.SourceSyncEventId)
    {
        CrestronConsole.PrintLine("{0} device Sync Detected Feedback Event Occurred\r\n", stream.ToString());
    }

    //HDMI Out
    if (args.EventId == DMOutputEventIds.HotplugDetectedEventId)
    {
        CrestronConsole.PrintLine("{0} device Hot Plug Detected Feedback Event Occurred\r\n", stream.ToString());
    }
}

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also