Commit d0847e04 authored by Felix Paul Kühne's avatar Felix Paul Kühne
Browse files

VLCAudio: add documentation

parent a104f605
...@@ -30,19 +30,32 @@ ...@@ -30,19 +30,32 @@
*/ */
extern NSString *const VLCMediaPlayerVolumeChanged; extern NSString *const VLCMediaPlayerVolumeChanged;
@class VLCMediaPlayer; @interface VLCAudio : NSObject
/** /**
* TODO: Documentation VLCAudio * Property to mute the current audio output
* \note decoding continues when muted, so consider disabling the audio track if you don't want audio for a long time
*/ */
@interface VLCAudio : NSObject
/* Properties */
@property (getter=isMuted) BOOL muted; @property (getter=isMuted) BOOL muted;
/**
* control the current audio output volume
* \note This is a NO-OP on iOS and tvOS */
@property (assign) int volume; @property (assign) int volume;
/**
* Mute the current audio output.
* \note This selector is deprecated and will be removed in the next release */
- (void)setMute:(BOOL)value __attribute__((deprecated)); - (void)setMute:(BOOL)value __attribute__((deprecated));
/**
* lower the current audio output volume
* \note This is a NO-OP on iOS and tvOS */
- (void)volumeDown; - (void)volumeDown;
/**
* higher the current audio output volume
* \note This is a NO-OP on iOS and tvOS */
- (void)volumeUp; - (void)volumeUp;
@end @end
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