Click or drag to resize

AdmsG2BrowseContext Class

Browse context device used for controlling Crestron ADMS products.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpPro.MediaBaseBrowseContext
    Crestron.SimplSharpPro.MediaAdmsG2BrowseContext

Namespace: Crestron.SimplSharpPro.Media
Assembly: Crestron.SimplSharpPro.Media (in Crestron.SimplSharpPro.Media.dll) Version: 2.21.121
Syntax
C#
public sealed class AdmsG2BrowseContext : BaseBrowseContext

The AdmsG2BrowseContext type exposes the following members.

Constructors
 NameDescription
Public methodAdmsG2BrowseContext Constructor to generate a new browse context designed for Crestron ADMS.
Top
Properties
 NameDescription
Protected property_MediaDevice Reference back to the media device this browse context is a part of.
(Inherited from BaseBrowseContext)
Public propertyBusyFeedback Indicates that the browse context is busy and cannot accept commands.
Public propertyCharConv Selects the character set for conversion of strings received from the audio source.
Public propertyCharConvFeedback Reports the character set selected for string conversion.
Public propertyCreateNewStationFeedback Pulses when CreateNewStation() is called, signifying the Pandora "create new station" menu is open.
Public propertyCurrentMenu Jumps to the corresponding menu based on the structure of the device in use.
(Inherited from BaseBrowseContext)
Public propertyCurrentMenuFeedback Get the current menu as reported by the media device.
(Inherited from BaseBrowseContext)
Public propertyDisableFeedbackFeedback Indicates that all outputs have been disabled.
Public propertyID Get the ID of this BaseBrowseContext.
(Inherited from BaseBrowseContext)
Public propertyIsSearchableFeedback Indicates that the current menu is searchable.
Public propertyKeyboardActiveFeedback Pulses to indicates that the keyboard should be displayed—for example, when search input is required by the user.
Public propertyKeyboardText The string that the user creates with the keyboard when the keyboard is active.
Public propertyKeyboardTextFeedback Tracks the characters in the current KeyboardText.
Public propertyLineTextFeedbacks Get the text associated with lines one through ten of the current menu.

The BrowseContextLineChange event will trigger with TextFeedbackEventId.


(Inherited from BaseBrowseContext)
Public propertyListAlphabeticSortedFeedback Indicates that the browse list is sorted alphabetically.
Public propertyListJumpbar Jumps to the corresponding position in the browse list.
(Inherited from BaseBrowseContext)
Public propertyListJumpbarAlpha Jumps to the corresponding letter in the browse list, when the list is sorted alphabetically. Valid values range from 0d (# character), and 1d (A) to 27 (Z).
Public propertyListJumpbarAlphaAsString Jumps to the corresponding letter in the browse list, when the list is sorted alphabetically.
Public propertyListJumpbarAlphaAsStringFeedback The currently selected letter in the (alphabetically sorted) browse list.
Public propertyListJumpbarAlphaFeedback Reports the current position in the browse list.
Public propertyListJumpbarFeedback Get the current position in the browse list.

The BaseEvent event will trigger with ListJumpbarFeedbackEventId.


(Inherited from BaseBrowseContext)
Public propertyMaxNumberOfLines The maximum number of lines this browse context supports.
(Inherited from BaseBrowseContext)
Public propertyMenuAvailableFeedback Indicates that a menu is available above the current menu in the hierarchy.

The BaseEvent event will trigger with MenuAvailableFeedbackEventId.


(Inherited from BaseBrowseContext)
Public propertyMenuBackAvailableFeedback Indicates that a menu is available above the current menu in the hierarchy.
Public propertyMenuHasTracksFeedback Indicates that the current menu is a list of tracks.

The BaseEvent event will trigger with MenuHasTracksFeedbackEventId.


(Inherited from BaseBrowseContext)
Public propertyNumberOfLines Sets the number of lines that will make up a pages. Defaults to 10 if not set on the FIRST browse context only. All additional browse context must define the number of lines.
(Inherited from BaseBrowseContext)
Public propertyNumberOfLinesFeedback Reports the number of lines that make up a page.

The BaseEvent event will trigger with NumberOfLinesFeedbackEventId for CenNsp1 device and NumberOfLinesFeedbackEventId for CenIdocIserverBase device.


(Inherited from BaseBrowseContext)
Public propertyOutput1Feedback Indicates the zone currently being controlled by the browse context.
Public propertyOutput2Feedback Indicates the zone currently being controlled by the browse context.
Public propertyOutputSelectFeedback Reports the zone currently being controlled.
Public propertyPageHeaderArtFeedback The URL of the cover art.
Public propertyPageHeaderFeedbacks Get the text strings associated with the current menu. This contains top, level 1, and level 2.

The BaseEvent event will trigger with PageHeaderFeedbackEventId.


(Inherited from BaseBrowseContext)
Public propertyParent The parent that a given object was added to.
(Inherited from BaseBrowseContext)
Public propertyPktDelta If an APAD is being used to access the music collection, this input should be driven by the PktDelta output of the APAD Knob symbol, to allow the APAD to scroll through the lists.
(Inherited from BaseBrowseContext)
Public propertyPktTime If an APAD is being used to access the music collection, this input should be driven by the PktTime output of the APAD Knob symbol, to allow the APAD to scroll through the lists.
(Inherited from BaseBrowseContext)
Public propertyPreferredGraphicHeight Sets the maximum preferred graphic height in pixels of the artwork specified by the line art feedbacks. (The Now Playing cover art is always displayed in full resolution.)
Public propertyPreferredGraphicWidth Sets the maximum preferred graphic width in pixels of the artwork specified by the line art feedbacks. (The Now Playing cover art is always displayed in full resolution.)
Public propertyQuickMixFeedback Indicates that the Pandora QuickMix playback is in progress.
Public propertySearchText Initiates a search of the corresponding search term.
Public propertySelectedLineFeedback Property to return the currently selected line of the device.

The BrowseContextLineChange event will trigger with SelectedFeedbackEventId.


(Inherited from BaseBrowseContext)
Public propertySendingLineDataFeedback Indicates that line data is currently being refreshed.
Public propertyShowStatusPageFeedback Indicates that an item in the play queue has been selected for playback.

The BaseEvent event will trigger with ShowStatusPageFeedbackEventId.


(Inherited from BaseBrowseContext)
Public propertySubmenuFeedback Indicates that a submenu is active (either through the program input or user action).
Public propertyTheaterZoneFeedback Indicates the zone currently being controlled by the browse context.
Public propertyTopMenu Designates the specified menu as the top-most menu. This disallows the user from navigating to the next higher menu in the hierarchy.
Public propertyTopMenuFeedback Reports which menu is currently designated as the top menu.
Public propertyUserSpecifiedObject Can be assigned anything that user wants.
(Inherited from BaseBrowseContext)
Top
Methods
 NameDescription
Public methodCreateNewStation Opens the Pandora "create a new station" menu, which allows the user to create a new station based on artist name, composer or song title.
Public methodDispose Dispose of this Browse Context instance
(Inherited from BaseBrowseContext)
Protected methodDispose(Boolean) Disposes of all internal resources before disposing of itself.
(Overrides BaseBrowseContextDispose(Boolean))
Protected methodDisposeSubscription Remove the event subscription of the Expander
(Inherited from BaseBrowseContext)
Public methodEnd Jumps to the list page of the current list and highlights the last item.
(Inherited from BaseBrowseContext)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodHome Jumps to the first page of the current list and highlights the first item.
(Inherited from BaseBrowseContext)
Protected methodInitializeBrowseBaseSigs Method to initialize all of the base Sigs for this device.
(Overrides BaseBrowseContextInitializeBrowseBaseSigs)
Protected methodInitializeSpecificSigs Method to initialize the sigs specific to this browse context.
(Overrides BaseBrowseContextInitializeSpecificSigs)
Public methodLineDown Highlights the next line. If the current line is the last item on the page, this will scroll down (if possible).
(Inherited from BaseBrowseContext)
Public methodLineUp Highlights the previous line. If the current line is the first item on the page, this will scroll up (if possible).
(Inherited from BaseBrowseContext)
Public methodOutput1 Selects Output1 as the zone that this browse context will control
Public methodOutput2 Selects Output2 as the zone that this browse context will control
Public methodOutputSelect Selects the zone that the browse context will control.
Public methodPageDown Shifts to the next page.
(Inherited from BaseBrowseContext)
Public methodPageUp Shifts to the previous page.
(Inherited from BaseBrowseContext)
Public methodScrollDown Scrolls the current list down (forward) by one line.
(Inherited from BaseBrowseContext)
Public methodScrollUp Scrolls the current list up (backward) by one line.
(Inherited from BaseBrowseContext)
Public methodSelect Selects the currently highlighted items on.
(Inherited from BaseBrowseContext)
Public methodSelectLine Selects the line corresponding to the parameter specified. If the item is playable, selecting the line will cause the ShowStatusPageFeedback to pulse briefly.
(Inherited from BaseBrowseContext)
Public methodTheaterZone Selects Theater as the zone that this browse context will control
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventLineArtChange When a line art feedback has changed this event will fire indicating what line art feedback changed.
Public eventLineAvailableChange When a line available feedback has changed this event will fire indicating what line available feedback changed.
Top
Fields
 NameDescription
Protected field_CurrentMenu Media device's Current Menu sig.
(Inherited from BaseBrowseContext)
Protected field_CurrentMenuFeedback Media device's Current Menu Feedback sig.
(Inherited from BaseBrowseContext)
Protected field_End Media device's End sig.
(Inherited from BaseBrowseContext)
Protected field_Home Media device's Home sig.
(Inherited from BaseBrowseContext)
Protected field_LineDown Media device's Line Down sig.
(Inherited from BaseBrowseContext)
Protected field_LineUp Media device's Line Up sig.
(Inherited from BaseBrowseContext)
Protected field_ListJumpbar Media device's List Jumpbar sig.
(Inherited from BaseBrowseContext)
Protected field_ListJumpbarFeedback Media device's List Jumpbar Feedback sig.
(Inherited from BaseBrowseContext)
Protected field_MenuAvailableFeedback Media device's Menu Available Feedback sig.
(Inherited from BaseBrowseContext)
Protected field_MenuHasTracksFeedback Media device's Menu has Tracks Feedback sig.
(Inherited from BaseBrowseContext)
Protected field_NumberOfLines Media device's Number of Lines sig.
(Inherited from BaseBrowseContext)
Protected field_NumberOfLinesFeedback Media device's Number of Lines Feedback sig.
(Inherited from BaseBrowseContext)
Protected field_PageDown Media device's Page Down sig.
(Inherited from BaseBrowseContext)
Protected field_PageUp Media device's Page Up sig.
(Inherited from BaseBrowseContext)
Protected field_PktDelta Media device's Pkt Delta sig.
(Inherited from BaseBrowseContext)
Protected field_PktTime Media device's Pkt Time sig.
(Inherited from BaseBrowseContext)
Protected field_ScrollDown Media device's Scroll Down sig.
(Inherited from BaseBrowseContext)
Protected field_ScrollUp Media device's Scroll Up sig.
(Inherited from BaseBrowseContext)
Protected field_Select Media device's select sig.
(Inherited from BaseBrowseContext)
Protected field_SelectedLineFeedback Media device's Selected Line Feedback sig.
(Inherited from BaseBrowseContext)
Protected field_SelectLine Array of the media device's Select Line sigs.
(Inherited from BaseBrowseContext)
Protected field_ShowStatusPageFeedback Media device's Show status Feedback sig.
(Inherited from BaseBrowseContext)
Public fieldLineArtFeedbacks The URL of the corresponding line art.
Public fieldLineAvailableFeedbacks Indicates whether the specified line is available for selection, as follows: 0d = Line is not available for selection 1d = Line is available for selection
Public fieldLineExtraTextFeedbacks Get the secondary text associated with lines one through ten of the current song.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also