diff options
| author | Teddy Wing | 2022-10-27 02:44:57 +0200 |
|---|---|---|
| committer | Teddy Wing | 2022-10-27 02:44:57 +0200 |
| commit | a27b62c0db1498eea8a2bea6deabd256b275bccb (patch) | |
| tree | 6064f518703b20086b21911f6b286704007692ee | |
| parent | c683588fe736327b3b3341a42a6813dacc6e8a2b (diff) | |
| download | SSVLSystemAlertVolume-a27b62c0db1498eea8a2bea6deabd256b275bccb.tar.bz2 | |
SSVLSystemAlertVolume.h: Add function documentation
| -rw-r--r-- | SSVLSystemAlertVolume.h | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/SSVLSystemAlertVolume.h b/SSVLSystemAlertVolume.h index 3bf1bc7..8f9cfc5 100644 --- a/SSVLSystemAlertVolume.h +++ b/SSVLSystemAlertVolume.h @@ -4,11 +4,18 @@ #include <AudioToolbox/AudioToolbox.h> #include <CoreFoundation/CoreFoundation.h> -// TODO: docs -// Float between 0 an 1. +// Get the system alert volume. +// +// Sets `volume` to the current system alert volume. +// +// Returns the result of `AudioServicesGetProperty`. OSStatus SSVLGetSystemVolume(Float32 *volume); -// TODO: docs +// Set the system alert volume. +// +// The input `volume` must be a float between 0 an 1. +// +// Returns the result of `AudioServicesSetProperty`. OSStatus SSVLSetSystemVolume(Float32 volume); #endif /* SSVLSystemAlertVolume_h */ |