Browse Source

VLCMediaPlayer: clarify documentation for the position setter/getter

Felix Paul Kühne 12 years ago
parent
commit
7131675912
1 changed files with 5 additions and 1 deletions
  1. 5 1
      Headers/Public/VLCMediaPlayer.h

+ 5 - 1
Headers/Public/VLCMediaPlayer.h

@@ -354,9 +354,13 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
 
 /**
  * Returns the receiver's position in the reading.
- * \return A number between 0 and 1. indicating the position
+ * \return movie position as percentage between 0.0 and 1.0.
  */
 - (float)position;
+/**
+ * Set movie position. This has no effect if playback is not enabled.
+ * \param movie position as percentage between 0.0 and 1.0.
+ */
 - (void)setPosition:(float)newPosition;
 
 - (BOOL)isSeekable;