Click or drag to resize

BaseTransportControls Class

Base class for transport controls.

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

Inheritance Hierarchy

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

The BaseTransportControls type exposes the following members.

Constructors
 NameDescription
Public methodBaseTransportControls Base constructor for transport controls.
Top
Properties
 NameDescription
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.

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.

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.

Public propertyAudioPlaylistName The name of the current audio playlist.
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.

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.

Public propertyCRPC Intended for use ONLY with the Smart Graphics Media Player Extender.
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.

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

The BaseEvent event will trigger with DirectConnectInformationFeedbackEventId.

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.

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.

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.

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.

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.

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.

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.

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.

Public propertyElapsedSecondsFeedback The elapsed seconds of the current track.

The BaseEvent event will trigger with ElapsedSecondsFeedbackEventId.

The BaseEvent event will trigger with ElapsedSecondsFeedbackEventId.

Public propertyFastForward Moves the position within the current track forward, for as long as the input is true.
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.

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.

Public propertyIndex Index of this BaseTransportControls device.
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.

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.

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.

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.

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.

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.

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.

Public propertyParent The parent that a given object was added to.
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.

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.

Public propertyPlayMatching Plays back all tracks that match the specified criteria. Syntax: {{TITLE:'Title'}} {{ARTIST:'Artist'}} {{ALBUM:'Name'}} {{GENRE:'Genre'}} {{YEAR:'Year'}} {{COMPOSER:'Composer'}}
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.

Public propertyRemainingSecondsFeedback The remaining seconds in the current track.

The BaseEvent event will trigger with RemainingSecondsFeedbackEventId.

The BaseEvent event will trigger with RemainingSecondsFeedbackEventId.

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.

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.

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.

Public propertyRewind Moves the position within the current track backward.
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.

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.

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.

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.

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.

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.

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.

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.

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.

Public propertyUserSpecifiedObject Can be assigned anything that user wants.
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.

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.
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)
Protected methodInitializeDevice Method used to initialize transport controls.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodNextPlayList Plays the next (higher-numbered) non-empty playlist.
Public methodNextTrack Plays the next track in the current list.
Public methodPause Pauses playback.
Public methodPlay Starts playback.
Public methodPlayAll Starts playback from the beginning.
Public methodPreviousPlayList Plays the previous (lower-numbered) non-empty playlist.
Public methodPreviousTrack Plays the current or previous track.
Public methodRepeatAll Select the "Repeat All" Mode.
Public methodRepeatCycle Cycles to the next repeat mode of the device.
Public methodRepeatOff Select the "Repeat Off" Mode.
Public methodRepeatTrack Select the "Repeat Track" Mode.
Public methodShuffleAlbum Select the "Shuffle Album" Mode.
Public methodShuffleCycle Cycles to the next shuffle option mode of the device.
Public methodShuffleOff Select the "Shuffle Off" Mode.
Public methodShuffleTrack Select the "Shuffle Track" Mode.
Public methodStop Stops playback and clears the current playlist.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Fields
 NameDescription
Public fieldStatic memberAlbumArtURLFeedbackEventId The value of AlbumArtURLFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberAlbumFeedbackEventId The value of AlbumFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberArtistFeedbackEventId The value of ArtistFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberBusyFeedbackEventId The state of BusyFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberCapabilitiesEventId The value of CapabilitiesFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberComposerFeedbackEventId The value of ComposerFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberCRPCFeedbackEventId The value of CRPCFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberDirectConnectInformationFeedbackEventId The value of DirectConnectInformationFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberDisableAllFeedbacksEventId The state of DisableAllFeedbacksFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberDisableElapsedSecondsFeedbackEventId The state of DisableElapsedSecondsFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberDisablePlayProgressFeedbackEventId The state of DisablePlayProgressFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberDisableRemainingSecondsFeedbackEventId The state of DisableRemainingSecondsFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberElapsedSecondsFeedbackEventId The value of ElapsedSecondsFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberGenreFeedbackEventId The value of GenreFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberLengthSecondsFeedbackEventId The value of LengthSecondsFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberNextAlbumFeedbackEventId The value of NextAlbumFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberNextArtistFeedbackEventId The value of NextArtistFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberNextComposerFeedbackEventId The value of NextComposerFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberNextGenreFeedbackEventId The value of NextGenreFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberNextTitleFeedbackEventId The value of NextTitleFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberNextYearFeedbackEventId The value of NextYearFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberPlayProgressFeedbackEventId The value of PlayProgressFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberRemainingSecondsFeedbackEventId The value of RemainingSecondsFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberSongCountFeedbackEventId The value of SongCountFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberSongNumberFeedbackEventId The value of SongNumberFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberSongNumberOfFeedbackEventId The value of SongNumberOfFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberStreamProviderIconUrlEventId The value of StreamProviderIconUrlFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberStreamProviderIsRootMenuEventId The value of IsRootMenuFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberStreamProviderNameEventId The value of StreamProviderNameFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberTitleFeedbackEventId The value of TitleFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberYearFeedbackEventId The value of YearFeedback 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