Click or drag to resize

XmBrowseContext Class

Xm browse context class for XM tuner cards.
Inheritance Hierarchy

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

The XmBrowseContext type exposes the following members.

Constructors
 NameDescription
Public methodXmBrowseContext Constructs an XmBrowseContext instance.
Top
Properties
 NameDescription
Public propertyAboutFeedback This output string reports diagnostic messages such as firmware version information.
(Inherited from SatelliteBrowseContext)
Public propertyActivationNumberFeedback The activation code, as received from Sirius or XM.
(Inherited from SatelliteBrowseContext)
Public propertyBusyTuningFeedback Indicates that the Tuner is tuning to the selected channel.
(Inherited from SatelliteBrowseContext)
Public propertyControlOKFeedback Indicates that the tuner has powered up and all Guide information has been loaded. The output will pulse when the tuner is ready.
(Inherited from SatelliteBrowseContext)
Public propertyDisableTunerNowPlayingFeedback Indicates that the Now Playing page is disabled.
(Inherited from TunerBrowseContextBase)
Public propertyDisplayCategoriesFeedback Indicates that the DisplayCategories input has been triggered. When connected properly to the associated page in the VTPro-e project, this will flip to the Categories page.
(Inherited from SatelliteBrowseContext)
Public propertyDisplayChannelsFeedback Indicates that the DisplayChannels input has been triggered. When connected properly to the associated page in the VTPro-e project, this will flip to the Channels page.
(Inherited from SatelliteBrowseContext)
Public propertyDisplayNowPlayingFeedback Indicates that the DisplayNowPlaying input has been triggered. When connected properly to the associated page in the VTPro-e project, this will flip to the Now Playing page.
(Inherited from TunerBrowseContextBase)
Public propertyDisplayPresetsFeedback Indicates that the DisplayPresets input has been triggered. When connected properly to the associated page in the VTPro-e project, this will flip to the Presets page.
(Inherited from TunerBrowseContextBase)
Public propertyDisplayTechFeedback Indicates that the DisplayTech input has been triggered. When connected properly to the associated page in the VTPro-e project, this will flip to the Channels page. ///
(Inherited from SatelliteBrowseContext)
Public propertyEnableTunerNowPlayingFeedback Indicates that the Now Playing page is enabled.
(Inherited from TunerBrowseContextBase)
Public propertyErrorNoAntennaFeedback Indicates that the corresponding error condition has been detected.
(Inherited from SatelliteBrowseContext)
Public propertyErrorNoSignalFeedback Indicates that the corresponding error condition has been detected.
(Inherited from SatelliteBrowseContext)
Public propertyGroundRepeaterSignalStrengthFeedback Reports the signal strength of the ground repeater signal when signal strength reporting is enabled.
(Inherited from SatelliteBrowseContext)
Public propertyKeypadResultFeedback The contents of the keypad buffer.
(Inherited from TunerBrowseContextBase)
Public propertyLastCategorySelectedFeedback The last selected category.
(Inherited from SatelliteBrowseContext)
Public propertyNumberOfLinesToScroll Specifies the maximum number of scrolling list items to display on one page. Valid values range from 1d to 12d.
(Inherited from TunerBrowseContextBase)
Public propertyParent The parent that a given object was added to.
(Inherited from TunerBrowseContextBase)
Public propertyPresetSave_ClearSubpageFeedback When the Presets page is active, this output indicates that a ScrollSelect# input has been held true for more than 2 seconds.
(Inherited from TunerBrowseContextBase)
Public propertySatelliteSignalStrengthFeedback Reports the signal strength of the satellite signal when signal strength reporting is enabled.
(Inherited from SatelliteBrowseContext)
Public propertyScrollbarFeedback The current position of the scroll bar indicator, where 100% corresponds to the first item in the scrolling list and 0% to the last item.
(Inherited from TunerBrowseContextBase)
Public propertyShowAboutSubpageFeedback When the Tech page is active, this output indicates that the TechSelectAbout input has been triggered. When connected properly to the associated subpage in the VTPro-e project, this will activate the About subpage.
(Inherited from SatelliteBrowseContext)
Public propertyShowCategoriesChannelsSubpageFeedback When the Categories subpage is active, this output indicates that a ScrollSelect# input has been triggered. When connected properly to the associated subpage in the VTPro-e project, this will activate the Category Select subpage.
(Inherited from SatelliteBrowseContext)
Public propertyShowCategoriesSubpageFeedback When the Categories subpage is active, this output indicates that a ScrollSelect# input has been triggered. When connected properly to the associated subpage in the VTPro-e project, this will activate the Category Select subpage.
(Inherited from SatelliteBrowseContext)
Public propertyShowChannelsSubpageFeedback Indicates that the DisplayChannels input has been triggered. When connected properly to the associated subpage in the VTPro-e project, this will activate the Channels subpage.
(Inherited from SatelliteBrowseContext)
Public propertyShowDownloadingGuideSubpageFeedback Indicates that the tuner Guide is being downloaded. When connected properly to the associated subpage in the VTPro-e project, this will activate the Downloading Guide subpage.
(Inherited from SatelliteBrowseContext)
Public propertyShowKeypadSignalStrengthSubpageFeedback Indicates that the DisplayKeypad input has been triggered.
(Inherited from TunerBrowseContextBase)
Public propertyShowNowPlayingSubpageFeedback Indicates that the DisplayNowPlaying input has been triggered.
(Inherited from TunerBrowseContextBase)
Public propertyShowPresetsSubpageFeedback Indicates that the DisplayPresets input has been triggered.
(Inherited from TunerBrowseContextBase)
Public propertyShowSetupChannelsSubpageFeedback When the Tech page is active, this output indicates that the TechSelectSetupChannels input has been triggered. When connected properly to the associated subpage in the VTPro-e project, this will activate the Setup Channels subpage.
(Inherited from SatelliteBrowseContext)
Public propertyShowTechSubpageFeedback Indicates that the DisplayTech input has been triggered. When connected properly to the associated subpage in the VTPro-e project, this will activate the Tech subpage.
(Inherited from SatelliteBrowseContext)
Public propertyTunedArtistFeedback Reports information about the artist that is currently playing.
(Inherited from SatelliteBrowseContext)
Public propertyTunedCategoryFeedback Reports information about the category of the selection that is currently playing.
(Inherited from SatelliteBrowseContext)
Public propertyTunedChannelNameFeedback Reports information about the channel name that is currently playing.
(Inherited from SatelliteBrowseContext)
Public propertyTunedChannelNumberAsStringFeedback Reports information about the channel that is currently playing.
(Inherited from SatelliteBrowseContext)
Public propertyTunedChannelNumberFeedback The channel number of the current selection.
(Inherited from SatelliteBrowseContext)
Public propertyTunedSongFeedback Reports information about the song that is currently playing.
(Inherited from SatelliteBrowseContext)
Public propertyTunerChannelHiddenFeedback Indicates that the current channel is hidden (skipped) in the channel list.
(Inherited from SatelliteBrowseContext)
Public propertyUserSpecifiedObject Can be assigned anything that user wants.
(Inherited from TunerBrowseContextBase)
Top
Methods
 NameDescription
Public methodBackFromScrollCategoryChannels This input should be triggered when the Tech page should be displayed.
(Inherited from SatelliteBrowseContext)
Public methodDisableBrowsing Disables browsing
(Inherited from TunerBrowseContextBase)
Public methodDisableTunerNowPlaying Disables the "Now Playing" page in the VTPro-e project.
(Inherited from TunerBrowseContextBase)
Public methodDisplayCategories This input should be triggered when the Categories page should be displayed.
(Inherited from SatelliteBrowseContext)
Public methodDisplayChannels This input should be triggered when the Channels page should be displayed.
(Inherited from SatelliteBrowseContext)
Public methodDisplayNowPlaying When the Now Playing page is enabled, this input should be triggered when the Now Playing page should be displayed
(Inherited from TunerBrowseContextBase)
Public methodDisplayPresets Causes the Presets page to be displayed.
(Inherited from TunerBrowseContextBase)
Public methodDisplayTech This input should be triggered when the Tech page should be displayed.
(Inherited from SatelliteBrowseContext)
Public methodDispose Disposes of browse.
(Inherited from TunerBrowseContextBase)
Protected methodDispose(Boolean) Dispose method used to dispose of object.
(Overrides TunerBrowseContextBaseDispose(Boolean))
Public methodEnableBrowsing Enables the GUI Browse Context to connect to the tuner cards. This allows the GUI to communicate with the card and refreshes all the data.
(Inherited from TunerBrowseContextBase)
Public methodEnableTunerNowPlaying Enables the "Now Playing" page in the VTPro-e project.
(Inherited from TunerBrowseContextBase)
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 methodHide_ShowChannel Toggles the hide/show channel setting.
(Inherited from SatelliteBrowseContext)
Public methodKeypad Adds the corresponding digit to the keypad buffer reported by KeypadResultFeedback. This allows direct entry of the tuner channel number.
(Inherited from TunerBrowseContextBase)
Public methodKeypadClear Activates the keypad's Clear command.
(Inherited from TunerBrowseContextBase)
Public methodKeypadEnter Activates the keypad's Enter command.
(Inherited from TunerBrowseContextBase)
Protected methodOnBrowseChange Method to trigger the BrowseChange event.
(Inherited from TunerBrowseContextBase)
Public methodPresetSave_ClearSubpageCancel When the Preset Save/Clear subpage is active, this input triggers the Cancel command.
(Inherited from TunerBrowseContextBase)
Public methodPresetSave_ClearSubpageClear When the Preset Save/Clear subpage is active, this input triggers the Clear command.
(Inherited from TunerBrowseContextBase)
Public methodPresetSave_ClearSubpageSave When the Preset Save/Clear subpage is active, this input triggers the Save command.
(Inherited from TunerBrowseContextBase)
Public methodScrollDisplayCycle Toggles between reporting the Song and Artist on the Song/Artist1-12Feedback serial outputs.
Public methodScrollEnd Scrolls to the bottom (End) of the scrolling list.
(Inherited from TunerBrowseContextBase)
Public methodScrollHome Scrolls to the top (Home) of the scrolling list.
(Inherited from TunerBrowseContextBase)
Public methodScrollPageDown Scrolls to the next (Down) page in the scrolling list.
(Inherited from TunerBrowseContextBase)
Public methodScrollPageUp Scrolls to the previous (Up) page in the scrolling list.
(Inherited from TunerBrowseContextBase)
Public methodTechExitAbout When the About subpage is active, this input should be triggered when the subpage should be closed.
(Inherited from SatelliteBrowseContext)
Public methodTechExitSetupChannels When the Setup Channels subpage is active, this input should be triggered when the Setup Channels subpage should be closed.
(Inherited from SatelliteBrowseContext)
Public methodTechSelectAbout When the About subpage is active, this input should be triggered when the subpage should be closed.
(Inherited from SatelliteBrowseContext)
Public methodTechSelectSetupChannels When the Tech page is active, this input should be triggered when the Setup Channels subpage should be displayed.
(Inherited from SatelliteBrowseContext)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventBrowseChange Event triggered when a browse event occurs on the device. EventIds for this event are located in the BrowseEventIds class.
(Inherited from TunerBrowseContextBase)
Top
Fields
 NameDescription
Protected field_BackFromScrollCategoryChannels When the Category Select subpage is active, this input triggers the Back function.
(Inherited from SatelliteBrowseContext)
Protected field_DisableBrowsing Disables browsing.
(Inherited from TunerBrowseContextBase)
Protected field_DisableTunerNowPlaying Disables the "Now Playing" page in the VTPro-e project, on the rising edge of the input.
(Inherited from TunerBrowseContextBase)
Protected field_DisplayCategories This input should be triggered when the Categories page should be displayed.
(Inherited from SatelliteBrowseContext)
Protected field_DisplayChannels This input should be triggered when the Channels page should be displayed.
(Inherited from SatelliteBrowseContext)
Protected field_DisplayNowPlaying When the Now Playing page is enabled, this input should be triggered when the Now Playing page should be displayed.
(Inherited from TunerBrowseContextBase)
Protected field_DisplayPresets This input should be triggered when the Presets page should be displayed.
(Inherited from TunerBrowseContextBase)
Protected field_DisplayTech This input should be triggered when the Tech page should be displayed.
(Inherited from SatelliteBrowseContext)
Protected field_EnableBrowsing Enables the GUI Browse Context to connect to the tuner cards. This allows the GUI to communicate with the card and refreshes all the data.
(Inherited from TunerBrowseContextBase)
Protected field_EnableTunerNowPlaying Enables the "Now Playing" page in the VTPro-e project, on the rising edge of the input.
(Inherited from TunerBrowseContextBase)
Protected field_GroundRepeaterSignalStrengthFeedback Reports the signal strength of the ground repeater signal when signal strength reporting is enabled on the card.
(Inherited from SatelliteBrowseContext)
Protected field_Hide_ShowChannel Toggles the hide/show channel setting.
(Inherited from SatelliteBrowseContext)
Protected field_Keypad Collection of digits that can be added to the keypad buffer.
(Inherited from TunerBrowseContextBase)
Protected field_KeypadClear Clears the contents of the keypad buffer.
(Inherited from TunerBrowseContextBase)
Protected field_KeypadEnter Activates the keypad's Enter command.
(Inherited from TunerBrowseContextBase)
Protected field_PresetSave_ClearSubpageCancel When the Preset Save/Clear subpage is active, this input triggers the Cancel command.
(Inherited from TunerBrowseContextBase)
Protected field_PresetSave_ClearSubpageClear When the Preset Save/Clear subpage is active, this input triggers the Clear command.
(Inherited from TunerBrowseContextBase)
Protected field_PresetSave_ClearSubpageSave When the Preset Save/Clear subpage is active, this input triggers the Save command.
(Inherited from TunerBrowseContextBase)
Protected field_SatelliteSignalStrengthFeedback Reports the signal strength of the satellite signal when signal strength reporting is enabled on the card.
(Inherited from SatelliteBrowseContext)
Protected field_ScrollEnd Scrolls to the bottom (End) of the scrolling list.
(Inherited from TunerBrowseContextBase)
Protected field_ScrollHome Scrolls to the top (Home) of the scrolling list.
(Inherited from TunerBrowseContextBase)
Protected field_ScrollPageDown Scrolls to the next (Down) page in the scrolling list.
(Inherited from TunerBrowseContextBase)
Protected field_ScrollPageUp Scrolls to the previous (Up) page in the scrolling list.
(Inherited from TunerBrowseContextBase)
Protected field_TechExitAbout When the About subpage is active, this input should be triggered when the subpage should be closed.
(Inherited from SatelliteBrowseContext)
Protected field_TechExitSetupChannels When the Setup Channels subpage is active, this input should be triggered when the subpage should be closed.
(Inherited from SatelliteBrowseContext)
Protected field_TechSelectAbout When the Tech page is active, this input should be triggered when the About subpage should be displayed.
(Inherited from SatelliteBrowseContext)
Protected field_TechSelectSetupChannels When the Tech page is active, this input should be triggered when the Setup Channels subpage should be displayed.
(Inherited from SatelliteBrowseContext)
Public fieldArtistFeedback Returns the artist that is being played on the corresponding channel that is visible in the browse.
(Inherited from SatelliteBrowseContext)
Public fieldCategoryFeedback Returns the category of the corresponding channel that is visible in the browse.
(Inherited from SatelliteBrowseContext)
Public fieldChannelNameFeedback Returns the name of the corresponding channel that is visible in the browse.
(Inherited from SatelliteBrowseContext)
Public fieldChannelNumberAsStringFeedback The channel number of each item in the scrolling list, relative to its position on the current page. There are twenty channel number feedbacks numbered 1 - 20.
(Inherited from TunerBrowseContextBase)
Public fieldChannelNumberFeedback The channel (station) number of each item in the scrolling list, relative to its position on the current page. There are twenty channel number feedbacks numbered 1 - 20.
(Inherited from TunerBrowseContextBase)
Public fieldIndexAsStringFeedback Reports the index number of each item in a scrolling list, relative to its position on the current page. There are twenty index number feedbacks numbered 1 - 20.
(Inherited from TunerBrowseContextBase)
Public fieldIndexFeedback The index number of each item in the scrolling list, relative to its position on the current page. There are twenty index number feedbacks numbered 1 - 20.
(Inherited from TunerBrowseContextBase)
Public fieldNumber Browse number on the source.
(Inherited from TunerBrowseContextBase)
Public fieldScrollSelect Selects the corresponding item on the current page. Valid values are 1 - 20.
(Inherited from TunerBrowseContextBase)
Public fieldSkippedChannels List of skipped channels.
(Inherited from SatelliteBrowseContext)
Public fieldSongArtistFeedback Returns song/artist information on the song and artist that are currently being played on the corresponding channel.
(Inherited from SatelliteBrowseContext)
Public fieldSongFeedback Returns the song that is being played on the corresponding channel that is visible in the browse.
(Inherited from SatelliteBrowseContext)
Public fieldSource The source that this browse context is added to.
(Inherited from TunerBrowseContextBase)
Public fieldSourceType Indicates the type of the source that the browse is added to.
(Inherited from TunerBrowseContextBase)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also