Click or drag to resize

AtcAudionetBrowseContext Class

BrowseContext for ATC-AUDIONET devices.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpPro.MediaBaseBrowseContext
    Crestron.SimplSharpPro.MediaAtcAudionetBrowseContext

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

The AtcAudionetBrowseContext type exposes the following members.

Constructors
 NameDescription
Public methodAtcAudionetBrowseContext Constructs an AtcAudionetBrowseContext instance.
Top
Properties
 NameDescription
Protected property_MediaDevice Reference back to the media device this browse context is a part of.
(Inherited from BaseBrowseContext)
Public propertyBrowseFeedback Indicates that the browse mode of menu operation is active.
Public propertyBrowseMainMenuFeedback Tracks the state of the BrowseMainMenu input.
Public propertyCreateNewStationFeedback Tracks the state of the corresponding CreateNewStation input.
Public propertyCurrentLine Jumps to the specified line number.
Public propertyCurrentLineFeedback Reports the current line number.
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 propertyFavoriteSaveAvailableFeedback Indicates that the currently playing item can be saved as a preset.
Public propertyFavoritesFeedback Indicates that the favorites mode of menu operation is active.
Public propertyFavoritesMainMenuFeedback Tracks the state of the FavoritesMainMenu input.
Public propertyID Get the ID of this BaseBrowseContext.
(Inherited from BaseBrowseContext)
Public propertyKeyboardNoMatchFeedback Indicates that the KeyboardTextFeedback search string does not match any items.
Public propertyKeyboardText The current search buffer, i.e., the item that's being searched for, or the string that the user has entered via KeyboardText.
Public propertyKeyboardTextFeedback For small panels such as the APAD, this string reports the currently highlighted letter.
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 propertyListJumpbar Jumps to the corresponding position in the browse list.
(Inherited from BaseBrowseContext)
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 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 propertyNumberOfValidLinesFeedback Reports the number of valid lines, i.e., how many lines are not blank on the current menu.
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 propertySelectedLineFeedback Property to return the currently selected line of the device.

The BrowseContextLineChange event will trigger with SelectedFeedbackEventId.


(Inherited from BaseBrowseContext)
Public propertySetupFeedback Indicates that the setup mode of menu operation is active.
Public propertySetupMainMenuFeedback Tracks the state of the SetupMainMenu input.
Public propertyShowKeyboardFeedback Indicates that the user interface should present a keyboard to the user, such as when a menu is displayed that requires user input.
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 propertyUserSpecifiedObject Can be assigned anything that user wants.
(Inherited from BaseBrowseContext)
Top
Methods
 NameDescription
Public methodBack Moves back one level in the menu hierarchy.
Public methodBrowse Activates the browse mode of menu operation and opens the menu last viewed by the user.
Public methodBrowseMainMenu Activates the browse mode of menu operation, and opens the top-level (main) menu.
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 methodFavoriteRemove Removes the currently selected (highlighted) preset from the presets list.
Public methodFavorites Activates the favorites mode of menu operation and opens the menu last viewed by the user.
Public methodFavoriteSave Adds the currently playing station to the presets list.
Public methodFavoritesMainMenu Activates the favorites mode of menu operation, and opens the top-level (main) menu.
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 Initializes the signals that are in the BrowseBase parent class.
(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 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 methodSetup Activates the setup mode of menu operation and opens the menu last viewed by the user.
Public methodSetupMainMenu Activates the setup main menu mode of menu operation, and opens the top-level (main) menu.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
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)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also