Browse Source

VLCMediaPlayer: add documentation for aspect ratio and crop

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

+ 14 - 0
Headers/Public/VLCMediaPlayer.h

@@ -117,9 +117,23 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
 
 @property (retain) id drawable; /* The videoView or videoLayer */
 
+/**
+ * Set/Get current video aspect ratio.
+ *
+ * \param psz_aspect new video aspect-ratio or NULL to reset to default
+ * \note Invalid aspect ratios are ignored.
+ * \return the video aspect ratio or NULL if unspecified
+ * (the result must be released with free()).
+ */
 - (void)setVideoAspectRatio:(char *)value;
 - (char *)videoAspectRatio;
 
+/**
+ * Set/Get current crop filter geometry.
+ *
+ * \param psz_geometry new crop filter geometry (NULL to unset)
+ * \return the crop filter geometry or NULL if unset
+ */
 - (void)setVideoCropGeometry:(char *)value;
 - (char *)videoCropGeometry;