Commit 9654fccc authored by Pierre d'Herbemont's avatar Pierre d'Herbemont

macosx/framework: improve comments in VLCMediaPlayer.h.

parent 6f4f5211
...@@ -157,12 +157,18 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state); ...@@ -157,12 +157,18 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
@property (readonly) int fps; @property (readonly) int fps;
/** /**
* Return the current video subtitle index, or * Return the current video subtitle index
* \return NSNotFound if none is set. * \return 0 if none is set.
* *
* To disable subtitle pass NSNotFound. * Pass 0 to disable.
*/ */
@property (readwrite) NSUInteger currentVideoSubTitleIndex; @property (readwrite) NSUInteger currentVideoSubTitleIndex;
/**
* Return the video subtitle tracks
*
* It includes the disabled fake track at index 0.
*/
- (NSArray *)videoSubTitles; - (NSArray *)videoSubTitles;
/** /**
...@@ -196,7 +202,20 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state); ...@@ -196,7 +202,20 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
- (NSArray *)titles; - (NSArray *)titles;
/* Audio Options */ /* Audio Options */
/**
* Return the current audio track index
* \return 0 if none is set.
*
* Pass 0 to disable.
*/
@property (readwrite) NSUInteger currentAudioTrackIndex; @property (readwrite) NSUInteger currentAudioTrackIndex;
/**
* Return the audio tracks
*
* It includes the "Disable" fake track at index 0.
*/
- (NSArray *)audioTracks; - (NSArray *)audioTracks;
- (void)setAudioChannel:(int)value; - (void)setAudioChannel:(int)value;
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment