Implemented toggling main interface in iTunesRemote

[MenuTunes.git] / ITMTRemote.h

diff --git a/ITMTRemote.h b/ITMTRemote.h
index b65b2d1..b77fc22 100755 (executable)
--- a/ITMTRemote.h
+++ b/ITMTRemote.h
@@ -53,6 +53,33 @@ typedef enum {
     ITMTRemotePlayerForwarding
 } ITMTRemotePlayerPlayingState;
 
     ITMTRemotePlayerForwarding
 } ITMTRemotePlayerPlayingState;
 

+/*!
+ * @enum ITMTRemotePlayerPlaylistClass
+ * @abstract Possible playlist classes used by a remote's player
+ * @discussion Used in functions that report the class of a playlist to MenuTunes. While we borrow the terms/descriptions from iTunes, these should work fine with any other player. If your player doesn't support a given type of playlist, then just return 
+
+ITMTRemotePlayerPlaylist.
+ * @constant ITMTRemotePlayerLibraryPlaylist For players that have one playlist that contains all of a user's music, or for players that don't have the concept of multiple playlists, this is the class for that "Master" list.
+ * @constant ITMTRemotePlayerPlaylist The generic playlist. Created and maintained by the user.
+ * @constant ITMTRemotePlayerSmartPlaylist A smart playlist is a playlist who's contents are dynamic, based on a set of criteria or updated by a script. These are usually not edited directly by the user, but instead maintained by the player.
+ * @constant ITMTRemotePlayerRadioPlaylist This is for when playing tracks off of (online) radio stations.
+ */
+typedef enum {
+    ITMTRemotePlayerLibraryPlaylist = -1,
+    ITMTRemotePlayerPlaylist,
+    ITMTRemotePlayerSmartPlaylist,
+    ITMTRemotePlayerRadioPlaylist
+} ITMTRemotePlayerPlaylistClass;
+
+typedef enum {
+    ITMTRemoteLibrarySource = -1,
+    ITMTRemoteCDSource,
+    ITMTRemoteRadioSource,
+    ITMTRemoteiPodSource,
+    ITMTRemoteGenericDeviceSource,
+    ITMTRemoteSharedLibrarySource
+} ITMTRemotePlayerSource;
+

 /*!
  * @enum ITMTRemotePlayerRepeatMode
  * @abstract Possible repeat modes for the remote's player.
 /*!
  * @enum ITMTRemotePlayerRepeatMode
  * @abstract Possible repeat modes for the remote's player.


@@ -129,7 +156,9 @@ typedef enum {
 /*!
  * @method playerFullName
  * @abstract Returns the remote's player's application filename.
 /*!
  * @method playerFullName
  * @abstract Returns the remote's player's application filename.

- * @discussion This string should be the name typically used by the remote's player's application bundle/file. For example, Panic's Audion audio player is known simply as "Audion", however, the application bundle is called "Audion 3" for version 3 of their application. This should return "Audion 3", not simply "Audion". See playerSimpleName.
+ * @discussion This string should be the name typically used by the remote's player's application bundle/file. For example, Panic's Audion audio player is known simply as "Audion", however, the application bundle is called "Audion 3" for version 3 of thei
+
+r application. This should return "Audion 3", not simply "Audion". See playerSimpleName.

  * @result An NSString containing the remote's player's application filename
  */
 - (NSString *)playerFullName;
  * @result An NSString containing the remote's player's application filename
  */
 - (NSString *)playerFullName;


@@ -150,10 +179,17 @@ typedef enum {
  */
 - (NSDictionary *)capabilities;
 
  */
 - (NSDictionary *)capabilities;
 

+/*!
+ * @method showPrimaryInterface
+ */
+- (BOOL)showPrimaryInterface;
+

 /*!
  * @method playerRunningState
  * @abstract Returns the running state of the remote's player.
 /*!
  * @method playerRunningState
  * @abstract Returns the running state of the remote's player.

- * @discussion While most remotes will use only ITMTRemotePlayerNotRunning or ITMTRemotePlayerRunning, we have included support for ITMTRemotePlayerLaunching (see ITMTRemotePlayerRunningState) for remotes that want the most precise control over their player's process managment.
+ * @discussion While most remotes will use only ITMTRemotePlayerNotRunning or ITMTRemotePlayerRunning, we have included support for ITMTRemotePlayerLaunching (see ITMTRemotePlayerRunningState) for remotes that want the most precise control over their play
+
+er's process managment.

  * @result An ITMTRemotePlayerRunningState defining the running state of the remote's player.
  */
 - (ITMTRemotePlayerRunningState)playerRunningState;
  * @result An ITMTRemotePlayerRunningState defining the running state of the remote's player.
  */
 - (ITMTRemotePlayerRunningState)playerRunningState;


@@ -174,9 +210,19 @@ typedef enum {
 - (int)numberOfSongsInPlaylistAtIndex:(int)index;
 
 /*!
 - (int)numberOfSongsInPlaylistAtIndex:(int)index;
 
 /*!

- * @method classOfPlaylistAtIndex:
+ * @method currentSource
+ */
+- (ITMTRemotePlayerSource)currentSource;
+
+/*!
+ * @method currentSourceIndex

  */
  */

-- (NSString *)classOfPlaylistAtIndex:(int)index;
+- (int)currentSourceIndex;
+
+/*!
+ * @method currentPlaylistClass
+ */
+- (ITMTRemotePlayerPlaylistClass)currentPlaylistClass;

 
 /*!
  * @method currentPlaylistIndex
 
 /*!
  * @method currentPlaylistIndex


@@ -188,6 +234,21 @@ typedef enum {
  */
 - (NSString *)songTitleAtIndex:(int)index;
 
  */
 - (NSString *)songTitleAtIndex:(int)index;
 

+/*!
+ * @method currentAlbumTrackCount:
+ */
+- (int)currentAlbumTrackCount;
+
+/*!
+ * @method currentSongTrack:
+ */
+- (int)currentSongTrack;
+
+/*!
+ * @method playerStateUniqueIdentifier:
+ */
+- (NSString *)playerStateUniqueIdentifier;
+

 /*!
  * @method currentSongIndex
  */
 /*!
  * @method currentSongIndex
  */


@@ -224,24 +285,24 @@ typedef enum {
 - (NSString *)currentSongRemaining;
 
 /*!
 - (NSString *)currentSongRemaining;
 
 /*!

- * @method currentSongRating
+ * @method currentSongElapsed

  */
  */

-- (float)currentSongRating;
+- (NSString *)currentSongElapsed;

 
 /*!
 
 /*!

- * @method setCurrentSongRating:
+ * @method currentSongAlbumArt

  */
  */

-- (BOOL)setCurrentSongRating:(float)rating;
+- (NSImage *)currentSongAlbumArt;

 
 /*!
 
 /*!

- * @method equalizerEnabled
+ * @method currentSongRating

  */
  */

-- (BOOL)equalizerEnabled;
+- (float)currentSongRating;

 
 /*!
 
 /*!

- * @method setEqualizerEnabled:
+ * @method setCurrentSongRating:

  */
  */

-- (BOOL)setEqualizerEnabled:(BOOL)enabled;
+- (BOOL)setCurrentSongRating:(float)rating;

 
 /*!
  * @method eqPresets
 
 /*!
  * @method eqPresets


@@ -318,6 +379,11 @@ typedef enum {
  */
 - (BOOL)switchToPlaylistAtIndex:(int)index;
 
  */
 - (BOOL)switchToPlaylistAtIndex:(int)index;
 

+/*!
+ * @method switchToPlaylistAtIndex:
+ */
+//- (BOOL)switchToPlaylistAtIndex:(int)index ofSourceAtIndex:(int)index2;
+

 /*!
  * @method switchToSongAtIndex:
  */
 /*!
  * @method switchToSongAtIndex:
  */