Click or drag to resize

CrestronConnectedAvr Class

AVR provides a native connectivity to a supported third party AVR and its embedded rich media sources. It will interact with the AVR and provide the user the ability to control built-in sources and provide audio distribution to multiple zones from a Crestron user interface.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProGenericBase
    Crestron.SimplSharpProGenericDevice
      Crestron.SimplSharpPro.CrestronConnectedCrestronConnectedAvr

Namespace: Crestron.SimplSharpPro.CrestronConnected
Assembly: Crestron.SimplSharpPro.CrestronConnected (in Crestron.SimplSharpPro.CrestronConnected.dll) Version: 2.21.121
Syntax
C#
public sealed class CrestronConnectedAvr : GenericDevice

The CrestronConnectedAvr type exposes the following members.

Constructors
 NameDescription
Public methodCrestronConnectedAvr Constructor to generate a new CrestronConnectedAVR.
Top
Properties
 NameDescription
Public propertyAvrMediaPlayer Collection of Crestron Connected AVR MediaPlayers.
Public propertyAvrTuner Collection of Crestron Connected AVR Tuners.
Public propertyAvrZone Collection of Crestron Connected AVR ZOnes.
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 propertyDeviceNameFeedback Reports identification information about the device.
Public propertyDeviceTypeFeedback Reports the type of the device.
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyGetPowerConsumption Pulse refreshes the real time power consumption status.Holding the input high will update RealTimePowerConsumption periodically.
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 propertyNumberOfAudioZonesFeedback Reports the number of supported audio zones, including theater zones.
Public propertyNumberOfMediaPlayersFeedback Reports the number of supported media players.
Public propertyNumberOfTunersFeedback Reports the number of supported tuners.
Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
Public propertyRealTimePowerConsumptionFeedback Reports accurate power usage in Watts.
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 propertySupportsMediaPlayersFeedback Indicates if the device supports media players.
Public propertySupportsRealTimePowerConsumptionFeedback Indicates that the Crestron Connected AVR System Supports Real Time Power Consumption.
Public propertySupportsTunersFeedback Indicates if the device supports tuners.
Public propertySupportsZonesFeedback Indicates if the device supports zones, including theater zone.
Public propertySystemIsOffFeedback Indicates that none of the zones (including theater) are turned off.
Public propertySystemIsOnFeedback Indicates that at least one of the zones (including theater) are turned on.
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 eventAvrComponentEventChange When a AvrComponent item feedback has changed on one of this device's, this event will fire indicating what changed and on which one. EventIds for this event are located in the class.
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 memberAudioStreamFormatFeedbackEventId Event ID for the AVR Zone event for triggering that the AudioStreamFormat feedback has changed.
Public fieldStatic memberAvailableAudioDecodingFeedbackEventId Event ID for the AVR Zone event for triggering that the AvailableAudioDecoding feedback has changed.
Public fieldStatic memberAvailableAudioStreamFeedbackEventId Event ID for the AVR Zone event for triggering that the AvailableAudioStream feedback has changed.
Public fieldStatic memberAvailableBandsFeedbackEventId Event ID for the AVR Tuner event for triggering that the AvailableBands feedback has changed.
Public fieldStatic memberAvailableVideoTypeFeedbackEventId Event ID for the AVR Zone event for triggering that the AvailableVideoType feedback has changed.
Public fieldStatic memberBusyFeedbackEventId Event ID for the AVR common triggering that the Busy feedback has changed.
Public fieldStatic memberCoverArtUrlFeedbackEventId Event ID for the AVR MediaPlayer event for triggering that the CoverArtUrl feedback has changed.
Public fieldStatic memberCurrentAudioDecodingDetailNameFeedbackEventId Event ID for the AVR Zone event for triggering that the CurrentAudioDecodingDetailName feedback has changed.
Public fieldStatic memberCurrentAudioDecodingMethodFeedbackEventId Event ID for the AVR Zone event for triggering that the CurrentAudioDecodingMethod feedback has changed.
Public fieldStatic memberCurrentBandFeedbackEventId Event ID for the AVR Tuner event for triggering that the CurrentBand feedback has changed
Public fieldStatic memberCurrentDeviceNameFeedbackEventId Event ID for triggering that the CurrentDeviceName feedback has changed.
Public fieldStatic memberCurrentInputNameFeedbackEventId Event ID for the AVR Zone event for triggering that the CurrentInputName feedback has changed.
Public fieldStatic memberCurrentInputSourceNumberFeedbackEventId Event ID for triggering that the CurrentInputSourceNumber feedback has changed.
Public fieldStatic memberCurrentMenuSizeFeedbackEventId Event ID for the AVR common triggering that the CurrentMenuSize feedback has changed.
Public fieldStatic memberCurrentRepeatStateFeedbackEventId Event ID for the AVR MediaPlayer event for triggering that the CurrentRepeatState feedback has changed.
Public fieldStatic memberCurrentShuffleStateFeedbackEventId Event ID for the AVR MediaPlayer event for triggering that the CurrentShuffleState feedback has changed.
Public fieldStatic memberDeviceNameFeedbackEventId Event ID for the base event for triggering that the DeviceType feedback has changed.
Public fieldStatic memberDeviceTypeFeedbackEventId Event ID for the base event for triggering that the DeviceType feedback has changed.
Public fieldStatic memberFastForwardingFeedbackEventId Event ID for the AVR MediaPlayer event for triggering that the FastForwarding feedback has changed.
Public fieldStatic memberFastReversingFeedbackEventId Event ID for the AVR MediaPlayer event for triggering that the FastReversing feedback has changed.
Public fieldStatic memberInputAndNamesFeedbackEventId Event ID for the AVR Zone event for triggering that the InputAndNames feedback has changed.
Public fieldStatic memberInputSelectedFeedbackEventId Event ID for the AVR Zone event for triggering that the InputSelected feedback has changed.
Public fieldStatic memberListSearchMethodsFeedbackEventId Event ID for the AVR MediaPlayer event for triggering that the ListSearchMethods feedback has changed.
Public fieldStatic memberMenuBackButtonIsAvailableFeedbackEventId Event ID for the AVR common triggering that the MenuBackButtonIsAvailable feedback has changed.
Public fieldStatic memberMenuHomeButtonIsAvailableFeedbackEventId Event ID for the AVR common triggering that the MenuHomeButtonIsAvailable feedback has changed.
Public fieldStatic memberMenuImageUrlItemFeedbackEventId Event ID for the AVR common triggering that a Menu Image URL Item Feedback has changed.
Public fieldStatic memberMenuItemTextFeedbackEventId Event ID for the AVR common triggering that a Menu item Text Feedback has changed.
Public fieldStatic memberMenuTitleFeedbackEventId Event ID for the AVR common triggering that the MenuTitle feedback has changed.
Public fieldStatic memberMetaDataLineFeedbackEventId Event ID for triggering that the collection of MetaDataLines feedback has changed.
Public fieldStatic memberMutedFeedbackEventId Event ID for the AVR Zone event for triggering that the Muted feedback has changed.
Public fieldStatic memberNumberOfAudioZonesFeedbackEventId Event ID for the base event for triggering that the NumberOfAudioZones feedback has changed.
Public fieldStatic memberNumberOfMediaPlayersFeedbackEventId Event ID for the base event for triggering that the NumberOfMediaPlayers feedback has changed.
Public fieldStatic memberNumberOfTunersFeedbackEventId Event ID for the base event for triggering that the NumberOfTuners feedback has changed.
Public fieldStatic memberOutputVideoTypeFeedbackEventId Event ID for the AVR Zone event for triggering that the OutputVideoType feedback has changed.
Public fieldStatic memberPausedFeedbackEventId Event ID for the AVR MediaPlayer event for triggering that the Paused feedback has changed.
Public fieldStatic memberPlayingFeedbackEventId Event ID for the AVR MediaPlayer event for triggering that the Playing feedback has changed.
Public fieldStatic memberPowerIsOffFeedbackEventId Event ID for the AVR Zone event for triggering that the PowerIsOff feedback has changed.
Public fieldStatic memberPowerIsOnFeedbackEventId Event ID for the AVR Zone event for triggering that the PowerIsOn feedback has changed.
Public fieldStatic memberRealTimePowerConsumptionFeedbackEventId Event ID for the base event for triggering that the RealTimePowerConsumption feedback has changed.
Public fieldStatic memberRepeatStatesAvailableFeedbackEventId Event ID for the AVR MediaPlayer event for triggering that the RepeatStatesAvailable feedback has changed.
Public fieldStatic memberRequestUserInputFeedbackEventId Event ID for the AVR MediaPlayer event for triggering that the RequestUserInput feedback has changed.
Public fieldStatic memberShowMenuFeedbackEventId Event ID for the AVR Zone event for triggering that the ShowMenu feedback has changed.
Public fieldStatic memberShuffleStatesAvailableFeedbackEventId Event ID for the AVR MediaPlayer event for triggering that the ShuffleStatesAvailable feedback has changed.
Public fieldStatic memberStatusTextFeedbackEventId Event ID for the AVR MediaPlayer event for triggering that the statusText feedback has changed
Public fieldStatic memberSupportsCategoryScanTuningFeedbackEventId Event ID for the AVR Tuner event for triggering that the SupportsCategoryScanTuning feedback has changed.
Public fieldStatic memberSupportsCoverArtFeedbackEventId Event ID for the AVR MediaPlayer event for triggering that the SupportsCoverArt feedback has changed
Public fieldStatic memberSupportsDirectionalPresetTuningFeedbackEventId Event ID for the AVR Tuner event for triggering that the SupportsDirectionalPresetTuning feedback has changed.
Public fieldStatic memberSupportsDirectionalTuningFeedbackEventId Event ID for the AVR Tuner event for triggering that the SupportsDirectionalTuning feedback has changed.
Public fieldStatic memberSupportsDirectTuningFeedbackEventId Event ID for the AVR Tuner event for triggering that the SupportsDirectTuning feedback has changed.
Public fieldStatic memberSupportsFastForwardFeedbackEventId Event ID for the AVR MediaPlayer event for triggering that the SupportsFastForward feedback has changed
Public fieldStatic memberSupportsFastReverseFeedbackEventId Event ID for the AVR MediaPlayer event for triggering that the SupportsFastReverse feedback has changed.
Public fieldStatic memberSupportsListSearchFeedbackEventId Event ID for the AVR MediaPlayer event for triggering that the SupportsListSearch feedback has changed.
Public fieldStatic memberSupportsMediaPlayersFeedbackEventId Event ID for the base event for triggering that the SupportMediaPlayers feedback has changed.
Public fieldStatic memberSupportsMetadataFeedbackEventId Event ID for the AVR MediaPlayer event for triggering that the SupportsMetadata feedback has changed.
Public fieldStatic memberSupportsPauseFeedbackEventId Event ID for the AVR MediaPlayer event for triggering that the SupportsPause feedback has changed.
Public fieldStatic memberSupportsPlayFeedbackEventId Event ID for the AVR MediaPlayer event for triggering that the SupportsPlay feedback has changed.
Public fieldStatic memberSupportsRealTimePowerConsumptionFeedbackEventId Event ID for the base event for triggering that the SupportsRealTimePowerConsumption feedback has changed.
Public fieldStatic memberSupportsRepeatFeedbackEventId Event ID for the AVR MediaPlayer event for triggering that the SupportsRepeat feedback has changed.
Public fieldStatic memberSupportsShuffleFeedbackEventId Event ID for the AVR MediaPlayer event for triggering that the SupportsShuffle feedback has changed.
Public fieldStatic memberSupportsSkipForwardFeedbackEventId Event ID for the AVR MediaPlayer event for triggering that the SupportsSkipForward feedback has changed.
Public fieldStatic memberSupportsSkipReverseFeedbackEventId Event ID for the AVR MediaPlayer event for triggering that the SupportsSkipReverse feedback has changed.
Public fieldStatic memberSupportsThumbsRatingFeedbackEventId Event ID for the AVR Tuner event for triggering that the SupportsThumbsRating feedback has changed.
Public fieldStatic memberSupportsTunersFeedbackEventId Event ID for the base event for triggering that the SupportTuners feedback has changed.
Public fieldStatic memberSupportsZonesFeedbackEventId Event ID for the base event for triggering that the SupportZones feedback has changed.
Public fieldStatic memberSystemIsOffFeedbackEventId Event ID for the base event for triggering that the SystemIsOff feedback has changed.
Public fieldStatic memberSystemIsOnFeedbackEventId Event ID for the base event for triggering that the SystemIsOn feedback has changed.
Public fieldStatic memberThumbedDownFeedbackEventId Event ID for the AVR MediaPlayer event for triggering that the ThumbedDown feedback has changed.
Public fieldStatic memberThumbedUpFeedbackEventId Event ID for the AVR MediaPlayer event for triggering that the ThumbedUp feedback has changed
Public fieldStatic memberUserInputParametersFeedbackEventId Event ID for the AVR MediaPlayer event for triggering that the UserInputParameters feedback has changed.
Public fieldStatic memberVolumeLevelFeedbackEventId Event ID for the AVR Zone event for triggering that the VolumeLevel feedback has changed.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also