Base |
This class will trigger BaseEvent, PlayControlChange, ShuffleChange and RepeatChange events.
public class BaseTransportControls : IParentInformation
The BaseTransportControls type exposes the following members.
| Name | Description | |
|---|---|---|
| BaseTransportControls | Base constructor for transport controls. |
| Name | Description | |
|---|---|---|
| AlbumArtURLFeedback |
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. | |
| AlbumFeedback |
Get the corresponding string of information about the current track.
The BaseEvent event will trigger with AlbumFeedbackEventId. The BaseEvent event will trigger with AlbumFeedbackEventId. | |
| ArtistFeedback |
Get the corresponding string of information about the current track.
The BaseEvent event will trigger with ArtistFeedbackEventId. The BaseEvent event will trigger with ArtistFeedbackEventId. | |
| AudioPlaylistName | The name of the current audio playlist. | |
| BusyFeedback |
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. | |
| ComposerFeedback |
Get the corresponding string of information about the current track.
The BaseEvent event will trigger with ComposerFeedbackEventId. The BaseEvent event will trigger with ComposerFeedbackEventId. | |
| CRPC | Intended for use ONLY with the Smart Graphics Media Player Extender. | |
| CRPCFeedback |
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. | |
| DirectConnectInformationFeedback |
Provides the list of CRPC direct connection info (IP Address:Port) in json format.
The BaseEvent event will trigger with DirectConnectInformationFeedbackEventId. | |
| DisableAllFeedbacks |
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. | |
| DisableAllFeedbacksFeedback |
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. | |
| DisableElapsedSeconds |
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. | |
| DisableElapsedSecondsFeedback |
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. | |
| DisablePlayProgress |
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. | |
| DisablePlayProgressFeedback |
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. | |
| DisableRemainingSeconds |
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. | |
| DisableRemainingSecondsFeedback |
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. | |
| ElapsedSecondsFeedback |
The elapsed seconds of the current track.
The BaseEvent event will trigger with ElapsedSecondsFeedbackEventId. The BaseEvent event will trigger with ElapsedSecondsFeedbackEventId. | |
| FastForward | Moves the position within the current track forward, for as long as the input is true. | |
| FastForwardFeedback |
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. | |
| GenreFeedback |
Get the corresponding string of information about the current track.
The BaseEvent event will trigger with GenreFeedbackEventId. The BaseEvent event will trigger with GenreFeedbackEventId. | |
| Index | Index of this BaseTransportControls device. | |
| LengthSecondsFeedback |
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. | |
| NextAlbumFeedback |
Get the corresponding string of information about the next track.
The BaseEvent event will trigger with NextAlbumFeedbackEventId. The BaseEvent event will trigger with NextAlbumFeedbackEventId. | |
| NextArtistFeedback |
Get the corresponding string of information about the next track.
The BaseEvent event will trigger with NextArtistFeedbackEventId. The BaseEvent event will trigger with NextArtistFeedbackEventId. | |
| NextComposerFeedback |
Get the corresponding string of information about the next track.
The BaseEvent event will trigger with NextComposerFeedbackEventId. The BaseEvent event will trigger with NextComposerFeedbackEventId. | |
| NextGenreFeedback |
Get the corresponding string of information about the next track.
The BaseEvent event will trigger with NextGenreFeedbackEventId. The BaseEvent event will trigger with NextGenreFeedbackEventId. | |
| NextTitleFeedback |
Get the corresponding string of information about the next track.
The BaseEvent event will trigger with NextTitleFeedbackEventId. The BaseEvent event will trigger with NextTitleFeedbackEventId. | |
| NextYearFeedback |
Get the corresponding string of information about the next track.
The BaseEvent event will trigger with NextYearFeedbackEventId. The BaseEvent event will trigger with NextYearFeedbackEventId. | |
| Parent | The parent that a given object was added to. | |
| PauseFeedback |
Indicates that playback has been paused. The output remains 'true' for as long as playback is paused.
The PlayControlChange event will trigger with PauseFeedbackEventId. | |
| PlayFeedback |
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. | |
| PlayMatching | Plays back all tracks that match the specified criteria. Syntax: {{TITLE:'Title'}} {{ARTIST:'Artist'}} {{ALBUM:'Name'}} {{GENRE:'Genre'}} {{YEAR:'Year'}} {{COMPOSER:'Composer'}} | |
| PlayProgressFeedback |
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. | |
| RemainingSecondsFeedback |
The remaining seconds in the current track.
The BaseEvent event will trigger with RemainingSecondsFeedbackEventId. The BaseEvent event will trigger with RemainingSecondsFeedbackEventId. | |
| RepeatAllFeedback |
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. | |
| RepeatOffFeedback |
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. | |
| RepeatTrackFeedback |
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. | |
| Rewind | Moves the position within the current track backward. | |
| RewindFeedback |
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. | |
| ShuffleAlbumFeedback |
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. | |
| ShuffleOffFeedback |
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. | |
| ShuffleTrackFeedback |
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. | |
| SongCountFeedback |
The total number of tracks in the current playlist.
The BaseEvent event will trigger with SongCountFeedbackEventId. The BaseEvent event will trigger with SongCountFeedbackEventId. | |
| SongNumberFeedback |
The index of the current track in the current playlist.
The BaseEvent event will trigger with SongNumberFeedbackEventId. The BaseEvent event will trigger with SongNumberFeedbackEventId. | |
| SongNumberOfFeedback |
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. | |
| StopFeedback |
Indicates that playback has been stopped. The output remains 'true' for as long as playback is stopped.
The PlayControlChange event will trigger with StopFeedbackEventId. | |
| TitleFeedback |
Get the corresponding string of information about the current track.
The BaseEvent event will trigger with TitleFeedbackEventId. The BaseEvent event will trigger with TitleFeedbackEventId. | |
| UserSpecifiedObject | Can be assigned anything that user wants. | |
| YearFeedback |
Get the corresponding string of information about the current track.
The BaseEvent event will trigger with YearFeedbackEventId. The BaseEvent event will trigger with YearFeedbackEventId. |
| Name | Description | |
|---|---|---|
| _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. | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) | |
| GetType | Gets the Type of the current instance. (Inherited from Object) | |
| InitializeDevice | Method used to initialize transport controls. | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) | |
| NextPlayList | Plays the next (higher-numbered) non-empty playlist. | |
| NextTrack | Plays the next track in the current list. | |
| Pause | Pauses playback. | |
| Play | Starts playback. | |
| PlayAll | Starts playback from the beginning. | |
| PreviousPlayList | Plays the previous (lower-numbered) non-empty playlist. | |
| PreviousTrack | Plays the current or previous track. | |
| RepeatAll | Select the "Repeat All" Mode. | |
| RepeatCycle | Cycles to the next repeat mode of the device. | |
| RepeatOff | Select the "Repeat Off" Mode. | |
| RepeatTrack | Select the "Repeat Track" Mode. | |
| ShuffleAlbum | Select the "Shuffle Album" Mode. | |
| ShuffleCycle | Cycles to the next shuffle option mode of the device. | |
| ShuffleOff | Select the "Shuffle Off" Mode. | |
| ShuffleTrack | Select the "Shuffle Track" Mode. | |
| Stop | Stops playback and clears the current playlist. | |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| Name | Description | |
|---|---|---|
| AlbumArtURLFeedbackEventId |
The value of AlbumArtURLFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| AlbumFeedbackEventId |
The value of AlbumFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| ArtistFeedbackEventId |
The value of ArtistFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| BusyFeedbackEventId |
The state of BusyFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| CapabilitiesEventId |
The value of CapabilitiesFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| ComposerFeedbackEventId |
The value of ComposerFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| CRPCFeedbackEventId |
The value of CRPCFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| DirectConnectInformationFeedbackEventId |
The value of DirectConnectInformationFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| DisableAllFeedbacksEventId |
The state of DisableAllFeedbacksFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| DisableElapsedSecondsFeedbackEventId |
The state of DisableElapsedSecondsFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| DisablePlayProgressFeedbackEventId |
The state of DisablePlayProgressFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| DisableRemainingSecondsFeedbackEventId |
The state of DisableRemainingSecondsFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| ElapsedSecondsFeedbackEventId |
The value of ElapsedSecondsFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| GenreFeedbackEventId |
The value of GenreFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| LengthSecondsFeedbackEventId |
The value of LengthSecondsFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| NextAlbumFeedbackEventId |
The value of NextAlbumFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| NextArtistFeedbackEventId |
The value of NextArtistFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| NextComposerFeedbackEventId |
The value of NextComposerFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| NextGenreFeedbackEventId |
The value of NextGenreFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| NextTitleFeedbackEventId |
The value of NextTitleFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| NextYearFeedbackEventId |
The value of NextYearFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| PlayProgressFeedbackEventId |
The value of PlayProgressFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| RemainingSecondsFeedbackEventId |
The value of RemainingSecondsFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| SongCountFeedbackEventId |
The value of SongCountFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| SongNumberFeedbackEventId |
The value of SongNumberFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| SongNumberOfFeedbackEventId |
The value of SongNumberOfFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| StreamProviderIconUrlEventId |
The value of StreamProviderIconUrlFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| StreamProviderIsRootMenuEventId |
The value of IsRootMenuFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| StreamProviderNameEventId |
The value of StreamProviderNameFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| TitleFeedbackEventId |
The value of TitleFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| YearFeedbackEventId |
The value of YearFeedback has changed.
The BaseEvent event will trigger for this event id. |