Click or drag to resize

CenNsp1TransportControls Class

Transport control class for CenNsp1 devices.

This class will trigger BaseEvent, PlayControlChange, ShuffleChange, RepeatChange, PresetChange and PresetNameChange events.

Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpPro.MediaBaseTransportControls
    Crestron.SimplSharpPro.MediaCenNsp1TransportControls

Namespace: Crestron.SimplSharpPro.Media
Assembly: Crestron.SimplSharpPro.Media (in Crestron.SimplSharpPro.Media.dll) Version: 2.21.121
Syntax
C#
public sealed class CenNsp1TransportControls : BaseTransportControls, 
	IStreamProvider

The CenNsp1TransportControls type exposes the following members.

Properties
 NameDescription
Public propertyAirplayPassword When AirPlay password is enabled, uses this string to authenticate streaming via AirPlay.
Public propertyAirplayPasswordEnable Enables/Disables Airplay password (required when streaming via Airplay).
Public propertyAirplayPasswordEnableFeedback Indicates that Airplay password (required when trying to stream via Airplay) is enabled.

The BaseEvent event will trigger with CharacterConversionFeedbackEventId.

Public propertyAlbumArtURLFeedback The URL of the current (or next) album cover art being displayed.

The BaseEvent event will trigger with AlbumArtURLFeedbackEventId.

The BaseEvent event will trigger with AlbumArtURLFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyAlbumFeedback Get the corresponding string of information about the current track.

The BaseEvent event will trigger with AlbumFeedbackEventId.

The BaseEvent event will trigger with AlbumFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyArtistFeedback Get the corresponding string of information about the current track.

The BaseEvent event will trigger with ArtistFeedbackEventId.

The BaseEvent event will trigger with ArtistFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyAudioFeedback The sample rate, stereo/mono state, and bitrate.

The BaseEvent event will trigger with AudioFeedbackEventId.

Public propertyAudioPlaylistCountFeedback The total number of audio playlists on the iPod.

The BaseEvent event will trigger with AudioPlaylistCountFeedbackEventId.

Public propertyAudioPlaylistIndex Plays back the corresponding audio playlist.
Public propertyAudioPlaylistIndexFeedback Reports the index of the current audio playlist.

The BaseEvent event will trigger with AudioPlaylistIndexFeedbackEventId.

Public propertyAudioPlaylistName The name of the current audio playlist.
(Inherited from BaseTransportControls)
Public propertyBusyFeedback Indicates that the device is busy and cannot accept commands. The output remains high for as long as the device is busy.

The BaseEvent event will trigger with BusyFeedbackEventId.

The BaseEvent event will trigger with BusyFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyCapabilitiesFeedback Reports the supported Stream providers.

The BaseEvent event will trigger with CapabilitiesEventId.

The enum provides the capabilities.
Public propertyCharacterConversion Selects the character set for conversion of strings reported via the legacy interface.
Public propertyCharacterConversionFeedback Reports the selected character set.

The BaseEvent event will trigger with CharacterConversionFeedbackEventId.

Public propertyCodecFeedback The name of the audio codec being used to play the stream.

The BaseEvent event will trigger with CodecFeedbackEventId.

Public propertyComposerFeedback Get the corresponding string of information about the current track.

The BaseEvent event will trigger with ComposerFeedbackEventId.

The BaseEvent event will trigger with ComposerFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyCRPC Intended for use ONLY with the Smart Graphics Media Player Extender.
(Inherited from BaseTransportControls)
Public propertyCRPCFeedback Intended for use ONLY with the Smart Graphics Media Player Extender. The Media Server Object Router supports multiple server connections and this input should be connected to the Device_X_In signal in the Server Connection group on the Media Object Router module.

The BaseEvent event will trigger with CRPCFeedbackEventId.

The BaseEvent event will trigger with CRPCFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyDirectConnectInformationFeedback Provides the list of CRPC direct connection info (IP Address:Port) in json format.

The BaseEvent event will trigger with DirectConnectInformationFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyDisableAllFeedbacks Disables PlayFeedback, PauseFeedback, StopFeedback, RewindFeedback, FastForwardFeedback, ElapsedSecondsFeedback, PlayProgressFeedback, SongNumberFeedback, and SongCountFeedback for as long as the input is 'true'.

The BaseEvent event will trigger with DisableAllFeedbacksEventId.


(Inherited from BaseTransportControls)
Public propertyDisableAllFeedbacksFeedback Indicates that the indicator outputs are currently disabled. The output remains 'true' for as long as the outputs are disabled.

The BaseEvent event will trigger with DisableAllFeedbacksEventId.


(Inherited from BaseTransportControls)
Public propertyDisableElapsedSeconds Disables the ElapsedSecondsFeedback for as long as the input is 'true'. This mode is useful to reduce Ethernet traffic when the remaining seconds information is not needed.

The BaseEvent event will trigger with DisableElapsedSecondsFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyDisableElapsedSecondsFeedback Indicates that elapsed seconds reporting is disabled. The output remains 'true' for as long as reporting is disabled.

The BaseEvent event will trigger with DisableElapsedSecondsFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyDisablePlayProgress Disables the PlayProgressFeedback for as long as the input is 'true'. This mode is useful to reduce Ethernet traffic when the remaining seconds information is not needed.

The BaseEvent event will trigger with DisablePlayProgressFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyDisablePlayProgressFeedback Indicates that play progress reporting is disabled. The output remains 'true' for as long as reporting is disabled.

The BaseEvent event will trigger with DisablePlayProgressFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyDisableRemainingSeconds Disables the RemainingSecondsFeedback for as long as the input is 'true'. This mode is useful to reduce Ethernet traffic when the remaining seconds information is not needed.

The BaseEvent event will trigger with DisableRemainingSecondsFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyDisableRemainingSecondsFeedback Indicates that remaining seconds reporting is disabled. The output remains 'true' for as long as reporting is disabled.

The BaseEvent event will trigger with DisableRemainingSecondsFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyElapsedSecondsFeedback The elapsed seconds of the current track.

The BaseEvent event will trigger with ElapsedSecondsFeedbackEventId.

The BaseEvent event will trigger with ElapsedSecondsFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyFastForward Moves the position within the current track forward, for as long as the input is true.
(Inherited from BaseTransportControls)
Public propertyFastForwardFeedback Indicates that the current track is fast-forwarding. The output remains 'true' for as long as the fast forward is active.

The PlayControlChange event will trigger with FastForwardFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyGenreFeedback Get the corresponding string of information about the current track.

The BaseEvent event will trigger with GenreFeedbackEventId.

The BaseEvent event will trigger with GenreFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyIndex Index of this BaseTransportControls device.
(Inherited from BaseTransportControls)
Public propertyIpodNameFeedback The name of the docked iPod as configured by the user in iTunes.

The BaseEvent event will trigger with IpodNameFeedbackEventId.

Public propertyIpodNotSupportedFeedback Indicates that the particular iPod model is not supported, i.e., the model can't be controlled via USB.

The BaseEvent event will trigger with IpodNotSupportedFeedbackEventId.

Public propertyIpodPresentFeedback Indicates that the iPod is docked and communicating successfully.

The BaseEvent event will trigger with IpodPresentFeedbackEventId.

Public propertyIsRootMenu Select the main menu to be displayed. When true, this will set the provider's menu as the main menu. When false will display the main menu.
Public propertyIsRootMenuFeedback Indicates the main menu. When true, the stream provider's menu is the main menu.

The BaseEvent event will trigger with StreamProviderIsRootMenuEventId.

Public propertyLengthSecondsFeedback The total length of the current track in seconds (1 = 1 second).

The BaseEvent event will trigger with LengthSecondsFeedbackEventId.

The BaseEvent event will trigger with LengthSecondsFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyLocalVolumeControl When set, enables the local volume control on the NSP (set using SetVolume analog join or remote volume control notifications from iOS device in airplay mode).
Public propertyLocalVolumeCtrlFeedback Feedback for LocalVolumeCtrl.

The BaseEvent event will trigger with LocalVolumeCtrlFeedbackEventId.

Public propertyMaximumNumberOfStreamProviders Maximum number of stream providers that the source can support
Public propertyMetadataLineFeedback Metadata strings (up to 250 characters) for the currently playing track in order of priority (1-highest to 5-lowest) to enable a generic display for all sources.

The BaseEvent event will trigger with MetadataLineFeedbackEventId.

Public propertyNameFeedback The radio station or source.

The BaseEvent event will trigger with NameFeedbackEventId.

Public propertyNextAlbumFeedback Get the corresponding string of information about the next track.

The BaseEvent event will trigger with NextAlbumFeedbackEventId.

The BaseEvent event will trigger with NextAlbumFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyNextArtistFeedback Get the corresponding string of information about the next track.

The BaseEvent event will trigger with NextArtistFeedbackEventId.

The BaseEvent event will trigger with NextArtistFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyNextComposerFeedback Get the corresponding string of information about the next track.

The BaseEvent event will trigger with NextComposerFeedbackEventId.

The BaseEvent event will trigger with NextComposerFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyNextGenreFeedback Get the corresponding string of information about the next track.

The BaseEvent event will trigger with NextGenreFeedbackEventId.

The BaseEvent event will trigger with NextGenreFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyNextTitleFeedback Get the corresponding string of information about the next track.

The BaseEvent event will trigger with NextTitleFeedbackEventId.

The BaseEvent event will trigger with NextTitleFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyNextYearFeedback Get the corresponding string of information about the next track.

The BaseEvent event will trigger with NextYearFeedbackEventId.

The BaseEvent event will trigger with NextYearFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyOKFeedback Tracks the state of the corresponding OK input.

The BaseEvent event will trigger with OKFeedbackEventId.

Public propertyParent The parent that a given object was added to.
(Inherited from BaseTransportControls)
Public propertyPauseFeedback Indicates that playback has been paused. The output remains 'true' for as long as playback is paused.

The PlayControlChange event will trigger with PauseFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyPlayFeedback Indicates that playback is in progress. The output remains 'true' for as long as a track is playing.

The PlayControlChange event will trigger with PlayFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyPlayMatching Plays back all tracks that match the specified criteria. Syntax: {{TITLE:'Title'}} {{ARTIST:'Artist'}} {{ALBUM:'Name'}} {{GENRE:'Genre'}} {{YEAR:'Year'}} {{COMPOSER:'Composer'}}
(Inherited from BaseTransportControls)
Public propertyPlayProgressFeedback The playback progress of the current track from 0% to 100%, reported in 1% increments.

Use PercentToUshort to convert the percentage to a ushort value or UshortToPercent to convert the ushort value to percentage.

The BaseEvent event will trigger with PlayProgressFeedbackEventId.

The BaseEvent event will trigger with PlayProgressFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyPresetPressAndHoldTime The amount of time (in milliseconds) to hold the corresponding Preset until it is saved.
Public propertyPresetPressAndHoldTimeFeedback Reports the set PresetPressAndHoldTime in milliseconds.

The BaseEvent event will trigger with PresetPressAndHoldTimeFeedbackEventId.

Public propertyPresets Collection of Preset objects for this Device
Public propertyRemainingSecondsFeedback The remaining seconds in the current track.

The BaseEvent event will trigger with RemainingSecondsFeedbackEventId.

The BaseEvent event will trigger with RemainingSecondsFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyRepeatAllFeedback Indicates that "Repeat All" mode is active. The output remains 'true' for as long as repeat all mode is on.

The RepeatChange event will trigger with RepeatAllFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyRepeatOffFeedback Indicates that "Repeat Track" mode is inactive. The output remains 'true' for as long as repeat track mode is off.

The RepeatChange event will trigger with RepeatOffFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyRepeatTrackFeedback Indicates that "Repeat Track" mode is active. The output remains 'true' for as long as repeat track mode is on.

The RepeatChange event will trigger with RepeatTrackFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyRewind Moves the position within the current track backward.
(Inherited from BaseTransportControls)
Public propertyRewindFeedback Indicates that the current track is rewinding. The output remains 'true' for as long as the rewind is active.

The PlayControlChange event will trigger with RewindFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertySetVolume Analog join with range 0..65535 where 0 is lowest volume and 65535 is highest volume.
Public propertySetVolumeFeedback Feedback for SetVolume.

The BaseEvent event will trigger with SetVolumeFeedbackEventId.

Public propertyShuffleAlbumFeedback Indicates that "Shuffle Album" mode is on. The output remains 'true' for as long as the mode is on.

The ShuffleChange event will trigger with ShuffleAlbumFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyShuffleOffFeedback Indicates that "Shuffle" mode is turned off. The output remains 'true' for as long as shuffle mode is off.

The ShuffleChange event will trigger with ShuffleOffFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyShuffleTrackFeedback Indicates that "Shuffle Track" mode is on. The output remains 'true' for as long as the mode is on.

The ShuffleChange event will trigger with ShuffleTrackFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertySongCountFeedback The total number of tracks in the current playlist.

The BaseEvent event will trigger with SongCountFeedbackEventId.

The BaseEvent event will trigger with SongCountFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertySongNumberFeedback The index of the current track in the current playlist.

The BaseEvent event will trigger with SongNumberFeedbackEventId.

The BaseEvent event will trigger with SongNumberFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertySongNumberOfFeedback The position of the current song within the current playlist, e.g., "Song 10 of 200".

The BaseEvent event will trigger with SongNumberOfFeedbackEventId.

The BaseEvent event will trigger with SongNumberOfFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyStatusMessageFeedback Displays status messages.

The BaseEvent event will trigger with StatusMessageFeedbackEventId.

Public propertyStopFeedback Indicates that playback has been stopped. The output remains 'true' for as long as playback is stopped.

The PlayControlChange event will trigger with StopFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyStreamInfoFeedback Reports the status of the current stream.

The BaseEvent event will trigger with StreamInfoFeedbackEventId.

Public propertyStreamProvider Sets the source providing the current audio stream.
Public propertyStreamProviderFeedback Reports the source that is providing the current audio stream.

The BaseEvent event will trigger with StreamProviderFeedbackEventId.

Public propertyStreamProviderIconUrlFeedback Provides the Url for the graphical Icon for the stream provider

The BaseEvent event will trigger with StreamProviderFeedbackEventId.

Public propertyStreamProviderNameFeedback Provides the textual name for the stream provider

The BaseEvent event will trigger with StreamProviderNameEventId.

Public propertyTitleFeedback Get the corresponding string of information about the current track.

The BaseEvent event will trigger with TitleFeedbackEventId.

The BaseEvent event will trigger with TitleFeedbackEventId.


(Inherited from BaseTransportControls)
Public propertyUserSpecifiedObject Can be assigned anything that user wants.
(Inherited from BaseTransportControls)
Public propertyYearFeedback Get the corresponding string of information about the current track.

The BaseEvent event will trigger with YearFeedbackEventId.

The BaseEvent event will trigger with YearFeedbackEventId.


(Inherited from BaseTransportControls)
Top
Methods
 NameDescription
Protected method_TransportControlsSlot_SigChange_BaseHandler Method to handle the Transport Controls Sig change events. EventIds for this event are located in the BaseTransportControls, PlayControlEventIds, ShuffleEventIds and RepeatEventIds classes.
(Inherited from BaseTransportControls)
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)
Protected methodInitializeDevice Method used to initialize transport controls.
(Overrides BaseTransportControlsInitializeDevice)
Public methodNextPlayList Plays the next (higher-numbered) non-empty playlist.
(Inherited from BaseTransportControls)
Public methodNextTrack Plays the next track in the current list.
(Inherited from BaseTransportControls)
Public methodOK Clears the Pandora-related StatusMessageFeedback on the rising edge of the input.
Public methodPause Pauses playback.
(Inherited from BaseTransportControls)
Public methodPlay Starts playback.
(Inherited from BaseTransportControls)
Public methodPlayAll Starts playback from the beginning.
(Inherited from BaseTransportControls)
Public methodPreviousPlayList Plays the previous (lower-numbered) non-empty playlist.
(Inherited from BaseTransportControls)
Public methodPreviousTrack Plays the current or previous track.
(Inherited from BaseTransportControls)
Public methodRepeatAll Select the "Repeat All" Mode.
(Inherited from BaseTransportControls)
Public methodRepeatCycle Cycles to the next repeat mode of the device.
(Inherited from BaseTransportControls)
Public methodRepeatOff Select the "Repeat Off" Mode.
(Inherited from BaseTransportControls)
Public methodRepeatTrack Select the "Repeat Track" Mode.
(Inherited from BaseTransportControls)
Public methodShuffleAlbum Select the "Shuffle Album" Mode.
(Inherited from BaseTransportControls)
Public methodShuffleCycle Cycles to the next shuffle option mode of the device.
(Inherited from BaseTransportControls)
Public methodShuffleOff Select the "Shuffle Off" Mode.
(Inherited from BaseTransportControls)
Public methodShuffleTrack Select the "Shuffle Track" Mode.
(Inherited from BaseTransportControls)
Public methodStop Stops playback and clears the current playlist.
(Inherited from BaseTransportControls)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Fields
 NameDescription
Public fieldStatic memberAirplayPasswordEnableFeedbackEventId The state of AirplayPasswordEnableFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberAudioFeedbackEventId The value of AudioFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberAudioPlaylistCountFeedbackEventId The value of AudioPlaylistCountFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberAudioPlaylistIndexFeedbackEventId The value of AudioPlaylistIndexFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberCharacterConversionFeedbackEventId The value of CharacterConversionFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberCodecFeedbackEventId The value of CodecFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberIpodNameFeedbackEventId The value of IpodNameFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberIpodNotSupportedFeedbackEventId The state of IpodNotSupportedFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberIpodPresentFeedbackEventId The state of IpodPresentFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberLocalVolumeCtrlFeedbackEventId The state of LocalVolumeCtrlFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberMaximumNumberOfMetadataLineFeedbacks Constant stores the maximum number of MetadataLineFeedback lines.
Public fieldStatic memberMaximumNumberOfPresets Constant stores the maximum number of Presets.
Public fieldStatic memberMetadataLineFeedbackEventId The value of MetadataLineFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberNameFeedbackEventId The value of NameFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberOKFeedbackEventId The state of OKFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberPresetPressAndHoldTimeFeedbackEventId The value of PresetPressAndHoldTimeFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberSetVolumeFeedbackEventId The value of SetVolumeFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberStatusMessageFeedbackEventId The value of StatusMessageFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberStreamInfoFeedbackEventId The value of StreamInfoFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberStreamProviderFeedbackEventId The value of StreamProviderFeedback 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