Commit aee65c3b authored by Felix Paul Kühne's avatar Felix Paul Kühne

VLCMediaPlayer: add pragmas to make the API more readible

parent 368bfb81
...@@ -108,6 +108,9 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state); ...@@ -108,6 +108,9 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
/* Video View Options */ /* Video View Options */
// TODO: Should be it's own object? // TODO: Should be it's own object?
#pragma mark -
#pragma mark video functionality
#if !TARGET_OS_IPHONE #if !TARGET_OS_IPHONE
- (void)setVideoView:(VLCVideoView *)aVideoView; - (void)setVideoView:(VLCVideoView *)aVideoView;
- (void)setVideoLayer:(VLCVideoLayer *)aVideoLayer; - (void)setVideoLayer:(VLCVideoLayer *)aVideoLayer;
...@@ -234,6 +237,9 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state); ...@@ -234,6 +237,9 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
*/ */
- (float)framesPerSecond; - (float)framesPerSecond;
#pragma mark -
#pragma mark time
/** /**
* Sets the current position (or time) of the feed. * Sets the current position (or time) of the feed.
* \param value New time to set the current position to. If time is [VLCTime nullTime], 0 is assumed. * \param value New time to set the current position to. If time is [VLCTime nullTime], 0 is assumed.
...@@ -255,6 +261,9 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state); ...@@ -255,6 +261,9 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
*/ */
@property (readonly) NSUInteger fps __attribute__((deprecated)); @property (readonly) NSUInteger fps __attribute__((deprecated));
#pragma mark -
#pragma mark ES track handling
/** /**
* Return the current video track index * Return the current video track index
* Note that the handled values do not match the videoTracks array indexes * Note that the handled values do not match the videoTracks array indexes
...@@ -382,6 +391,9 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state); ...@@ -382,6 +391,9 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
*/ */
- (NSArray *)audioTracks __attribute__((deprecated)); - (NSArray *)audioTracks __attribute__((deprecated));
#pragma mark -
#pragma mark audio functionality
- (void)setAudioChannel:(NSInteger)value; - (void)setAudioChannel:(NSInteger)value;
- (NSInteger)audioChannel; - (NSInteger)audioChannel;
...@@ -393,11 +405,15 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state); ...@@ -393,11 +405,15 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
*/ */
@property (readwrite) NSInteger currentAudioPlaybackDelay; @property (readwrite) NSInteger currentAudioPlaybackDelay;
#pragma mark -
#pragma mark media handling
/* Media Options */ /* Media Options */
- (void)setMedia:(VLCMedia *)value; - (void)setMedia:(VLCMedia *)value;
- (VLCMedia *)media; - (VLCMedia *)media;
/* Playback Operations */ #pragma mark -
#pragma mark playback operations
/** /**
* Plays a media resource using the currently selected media controller (or * Plays a media resource using the currently selected media controller (or
* default controller. If feed was paused then the feed resumes at the position * default controller. If feed was paused then the feed resumes at the position
...@@ -495,7 +511,8 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state); ...@@ -495,7 +511,8 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
*/ */
- (void)longJumpForward; - (void)longJumpForward;
/* Playback Information */ #pragma mark -
#pragma mark playback information
/** /**
* Playback state flag identifying that the stream is currently playing. * Playback state flag identifying that the stream is currently playing.
* \return TRUE if the feed is playing, FALSE if otherwise. * \return TRUE if the feed is playing, FALSE if otherwise.
......
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