Click or drag to resize

BaseBrowseContext Class

Base browse context class for Crestron media devices.

This class will trigger BaseEvent and BrowseContextLineChange events.

Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.Media
Assembly: Crestron.SimplSharpPro.Media (in Crestron.SimplSharpPro.Media.dll) Version: 2.21.121
Syntax
C#
public class BaseBrowseContext : IDisposable, 
	IParentInformation

The BaseBrowseContext type exposes the following members.

Properties
 NameDescription
Protected property_MediaDevice Reference back to the media device this browse context is a part of.
Public propertyCurrentMenu Jumps to the corresponding menu based on the structure of the device in use.
Public propertyCurrentMenuFeedback Get the current menu as reported by the media device.
Public propertyID Get the ID of this BaseBrowseContext.
Public propertyLineTextFeedbacks Get the text associated with lines one through ten of the current menu.

The BrowseContextLineChange event will trigger with TextFeedbackEventId.

Public propertyListJumpbar Jumps to the corresponding position in the browse list.
Public propertyListJumpbarFeedback Get the current position in the browse list.

The BaseEvent event will trigger with ListJumpbarFeedbackEventId.

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

The BaseEvent event will trigger with MenuAvailableFeedbackEventId.

Public propertyMenuHasTracksFeedback Indicates that the current menu is a list of tracks.

The BaseEvent event will trigger with MenuHasTracksFeedbackEventId.

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.
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.

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.

Public propertyParent The parent that a given object was added to.
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.
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.
Public propertySelectedLineFeedback Property to return the currently selected line of the device.

The BrowseContextLineChange event will trigger with SelectedFeedbackEventId.

Public propertyShowStatusPageFeedback Indicates that an item in the play queue has been selected for playback.

The BaseEvent event will trigger with ShowStatusPageFeedbackEventId.

Public propertyUserSpecifiedObject Can be assigned anything that user wants.
Top
Methods
 NameDescription
Public methodDispose Dispose of this Browse Context instance
Protected methodDispose(Boolean) Dispose of all resources.
Protected methodDisposeSubscription Remove the event subscription of the Expander
Public methodEnd Jumps to the list page of the current list and highlights the last item.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(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.
Protected methodInitializeBrowseBaseSigs Method to initialize the sigs that are present in the BaseBrowseContext.
Protected methodInitializeSpecificSigs Method to initialize the sigs needed for the specific browse context.
Public methodLineDown Highlights the next line. If the current line is the last item on the page, this will scroll down (if possible).
Public methodLineUp Highlights the previous line. If the current line is the first item on the page, this will scroll up (if possible).
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodPageDown Shifts to the next page.
Public methodPageUp Shifts to the previous page.
Public methodScrollDown Scrolls the current list down (forward) by one line.
Public methodScrollUp Scrolls the current list up (backward) by one line.
Public methodSelect Selects the currently highlighted items on.
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.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Fields
 NameDescription
Protected field_CurrentMenu Media device's Current Menu sig.
Protected field_CurrentMenuFeedback Media device's Current Menu Feedback sig.
Protected field_End Media device's End sig.
Protected field_Home Media device's Home sig.
Protected field_LineDown Media device's Line Down sig.
Protected field_LineUp Media device's Line Up sig.
Protected field_ListJumpbar Media device's List Jumpbar sig.
Protected field_ListJumpbarFeedback Media device's List Jumpbar Feedback sig.
Protected field_MenuAvailableFeedback Media device's Menu Available Feedback sig.
Protected field_MenuHasTracksFeedback Media device's Menu has Tracks Feedback sig.
Protected field_NumberOfLines Media device's Number of Lines sig.
Protected field_NumberOfLinesFeedback Media device's Number of Lines Feedback sig.
Protected field_PageDown Media device's Page Down sig.
Protected field_PageUp Media device's Page Up sig.
Protected field_PktDelta Media device's Pkt Delta sig.
Protected field_PktTime Media device's Pkt Time sig.
Protected field_ScrollDown Media device's Scroll Down sig.
Protected field_ScrollUp Media device's Scroll Up sig.
Protected field_Select Media device's select sig.
Protected field_SelectedLineFeedback Media device's Selected Line Feedback sig.
Protected field_SelectLine Array of the media device's Select Line sigs.
Protected field_ShowStatusPageFeedback Media device's Show status Feedback sig.
Public fieldStatic memberListJumpbarFeedbackEventId The value of ListJumpbarFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberMenuAvailableFeedbackEventId The state of MenuAvailableFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberMenuHasTracksFeedbackEventId The state of MenuHasTracksFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberPageHeader1FeedbackEventId The value of PageHeaderFeedbacks has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberPageHeader2FeedbackEventId The value of PageHeaderFeedbacks has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberPageHeaderFeedbackEventId The value of PageHeaderFeedbacks has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberShowStatusPageFeedbackEventId The state of ShowStatusPageFeedback has changed.

The BaseEvent event will trigger for this event id.

Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also