Pārlūkot izejas kodu

VLCAudio: add documentation

Felix Paul Kühne 9 gadi atpakaļ
vecāks
revīzija
d0847e0418
1 mainītis faili ar 18 papildinājumiem un 5 dzēšanām
  1. 18 5
      Headers/Public/VLCAudio.h

+ 18 - 5
Headers/Public/VLCAudio.h

@@ -30,19 +30,32 @@
  */
 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;
+
+/**
+ * control the current audio output volume
+ * \note This is a NO-OP on iOS and tvOS */
 @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));
 
+/**
+ * lower the current audio output volume
+ * \note This is a NO-OP on iOS and tvOS */
 - (void)volumeDown;
+
+/**
+ * higher the current audio output volume
+ * \note This is a NO-OP on iOS and tvOS */
 - (void)volumeUp;
+
 @end