Click or drag to resize

CenIdocIserverBrowseContext Class

Browse context device used for media devices that control iPod type sources.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpPro.MediaBaseBrowseContext
    Crestron.SimplSharpPro.MediaCenIdocIserverBrowseContext

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

The CenIdocIserverBrowseContext type exposes the following members.

Constructors
 NameDescription
Public methodCenIdocIserverBrowseContext Constructor to generate a new browse context designed for Crestron media devices controlling iPods.
Top
Properties
 NameDescription
Protected property_MediaDevice Reference back to the media device this browse context is a part of.
(Inherited from BaseBrowseContext)
Public propertyCharacterSetConversion Set the character set for conversion of strings received from the media device.
Public propertyCharacterSetConversionFeedback Reports the character set for the conversion of strings setting from the media device.
Public propertyCurrentMenu Jumps to the corresponding menu of the device.
Public propertyCurrentMenuFeedback Get the current menu as reported by the media device.
Public propertyHideVideo Hides the top-level welcome menu for as long as this is set to 'true'.
Public propertyHideVideoFeedback Indicates that the video options is hidden. A value of 'true' means video option disabled, 'false' means video option enabled.
Public propertyID Get the ID of this BaseBrowseContext.
(Inherited from BaseBrowseContext)
Public propertyIsSearchable Indicates that the current menu is searchable. EventIds: IsSearchableEventId will trigger to indicate change.
Public propertyLineExtraTextFeedbacks Get the secondary text associated with lines one through ten of the current song.
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 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 propertySearch Access to the search module that is built in to the Crestron media device.
Public propertySelectedLineFeedback Property to return the currently selected line of the device.

The BrowseContextLineChange event will trigger with SelectedFeedbackEventId.


(Inherited from BaseBrowseContext)
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 propertySortByAlbumFeedback The first audio or video playlist is currently being sorted by album.
Public propertySortByArtistFeedback The first audio or video playlist is currently being sorted by artist.
Public propertySortByComposerFeedback The first audio or video playlist is currently being sorted by composer.
Public propertySortByGenreFeedback The first audio or video playlist is currently being sorted by genre.
Public propertySortByTitleFeedback The first audio or video playlist is currently being sorted by title.
Public propertySortByYearFeedback The first audio or video playlist is currently being sorted by year.
Public propertyUserSpecifiedObject Can be assigned anything that user wants.
(Inherited from BaseBrowseContext)
Top
Methods
 NameDescription
Public methodBrowseListPlayAll Plays all songs in the current browse list.
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)
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.
(Inherited from BaseBrowseContext)
Protected methodInitializeBrowseBaseSigs Method to initialize the sigs for the base browse context class.
(Overrides BaseBrowseContextInitializeBrowseBaseSigs)
Protected methodInitializeSpecificSigs Method to initialize the specific sigs for 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)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodMenu Move to the next higher level in the menu hierarchy.
Protected methodOnBrowseContextSearchChange Method to fire the BrowseContextLineChange event.
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 methodSortByAlbum Sort the first audio or video playlist by album. Has no effect if not on the first audio or video playlist, which lists every item.
Public methodSortByArtist Sort the first audio or video playlist by artist. Has no effect if not on the first audio or video playlist, which lists every item.
Public methodSortByComposer Sort the first audio or video playlist by composer. Has no effect if not on the first audio or video playlist, which lists every item.
Public methodSortByGenre Sort the first audio or video playlist by genre. Has no effect if not on the first audio or video playlist, which lists every item.
Public methodSortByTitle Sort the first audio or video playlist by title. Has no effect if not on the first audio or video playlist, which lists every item.
Public methodSortByYear Sort the first audio or video playlist by year. Has no effect if not on the first audio or video playlist, which lists every item.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventSearchChange When a Search 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 SearchEventIds class.
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 fieldStatic memberIsSearchableEventId Indicates that the current menu is searchable. The feedback remains True while on the particular menu. Event ID to indicate that IsSearchable has changed.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also