]> git.sesse.net Git - vlc/commitdiff
macosx/framework: improve comments in VLCMediaPlayer.h.
authorPierre d'Herbemont <pdherbemont@free.fr>
Mon, 21 Dec 2009 14:16:52 +0000 (15:16 +0100)
committerPierre d'Herbemont <pdherbemont@free.fr>
Tue, 22 Dec 2009 16:59:51 +0000 (17:59 +0100)
projects/macosx/framework/Headers/Public/VLCMediaPlayer.h

index 92e6c77b970de470f4028c2ecc5a3e1953fdfeba..efa841477f0f8d984dfbf0f71431b551b2a7e681 100644 (file)
@@ -157,12 +157,18 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
 @property (readonly) int fps;
 
 /**
- * Return the current video subtitle index, or
- * \return NSNotFound if none is set.
+ * Return the current video subtitle index
+ * \return 0 if none is set.
  *
- * To disable subtitle pass NSNotFound.
+ * Pass 0 to disable.
  */
 @property (readwrite) NSUInteger currentVideoSubTitleIndex;
+
+/**
+ * Return the video subtitle tracks
+ *
+ * It includes the disabled fake track at index 0.
+ */
 - (NSArray *)videoSubTitles;
 
 /**
@@ -196,7 +202,20 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
 - (NSArray *)titles;
 
 /* Audio Options */
+
+/**
+ * Return the current audio track index
+ * \return 0 if none is set.
+ *
+ * Pass 0 to disable.
+ */
 @property (readwrite) NSUInteger currentAudioTrackIndex;
+
+/**
+ * Return the audio tracks
+ *
+ * It includes the "Disable" fake track at index 0.
+ */
 - (NSArray *)audioTracks;
 
 - (void)setAudioChannel:(int)value;