Click or drag to resize

CenIdocIserverBase Class

Base class for Crestron media devices that control iPod type sources.
Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.Media
Assembly: Crestron.SimplSharpPro.Media (in Crestron.SimplSharpPro.Media.dll) Version: 2.21.121
Syntax
C#
public class CenIdocIserverBase : MediaBase

The CenIdocIserverBase type exposes the following members.

Properties
 NameDescription
Public propertyBrowseContexts Collection of browse contexts for this 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 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 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 propertyMaximumNumberOfSupportedBrowseContexts Get the maximum number of supported BaseBrowseContexts for this device.
(Inherited from MediaBase)
Public propertyName Get the name of this device.
(Inherited from GenericBase)
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 propertyTransportControls Transport controls for this Crestron media player device.
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 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)
Protected methodOnBrowseContextLineChange Method to fire the BrowseContextLineChange event.
(Inherited from MediaBase)
Protected methodOnBrowseContextSortChange Method to fire the BrowseContextLineChange event.
Protected methodOnPlayControlChange Method to fire the PlayControlChange event.
(Inherited from MediaBase)
Protected methodOnRepeatChange Method to fire the RepeatChange event.
(Inherited from MediaBase)
Protected methodOnShuffleChange Method to fire the ShuffleChange event.
(Inherited from MediaBase)
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 eventBrowseContextLineChange When a line feedback has changed on one of this device's browse context, this event will fire indicating what changed and on which one.

Valid event IDs are available in LineEventIds


(Inherited from MediaBase)
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)
Public eventPlayControlChange When a play control function is executed this event will fire to indicate what function was executed. EventIds for this event are located in the PlayControlEventIds class.
(Inherited from MediaBase)
Public eventRepeatChange When a repeat option is selected this event will fire to indicate what option was selected. EventIds for this event are located in the RepeatEventIds class.
(Inherited from MediaBase)
Public eventShuffleChange When a shuffle option is selected this event will fire to indicate what option was selected. EventIds for this event are located in the ShuffleEventIds class.
(Inherited from MediaBase)
Public eventSortChange When a Sort feedback has changed on one of the device's browse contexts, this event will fire indicating what changed and on which one. EventIds for this event are located in the SortEventIds class.
Top
Fields
 NameDescription
Public fieldStatic memberCharacterSetConversionFeedbackEventId Event ID for the base event for signaling that the CharacterSetConversion Feedback has changed.
Public fieldStatic memberCurrentMenuFeedbackEventId Event ID for the base event for signaling that the CurrentMenu Feedback has changed.
Public fieldStatic memberHideVideoFeedbackEventId Event ID for the base event for signaling that the HideVideo Feedback has changed.
Public fieldStatic memberNumberOfLinesFeedbackEventId Event ID for the base event for signaling that the NumberOfLines Feedback has changed.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also