OpenShot Library | OpenShotAudio 0.2.2
juce_SystemAudioVolume.h
1
2/** @weakgroup juce_audio_devices-audio_io
3 * @{
4 */
5/*
6 ==============================================================================
7
8 This file is part of the JUCE library.
9 Copyright (c) 2017 - ROLI Ltd.
10
11 JUCE is an open source library subject to commercial or open-source
12 licensing.
13
14 The code included in this file is provided under the terms of the ISC license
15 http://www.isc.org/downloads/software-support-policy/isc-license. Permission
16 To use, copy, modify, and/or distribute this software for any purpose with or
17 without fee is hereby granted provided that the above copyright notice and
18 this permission notice appear in all copies.
19
20 JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
21 EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
22 DISCLAIMED.
23
24 ==============================================================================
25*/
26
27namespace juce
28{
29
30//==============================================================================
31/**
32 Contains functions to control the system's master volume.
33
34 @tags{Audio}
35*/
37{
38public:
39 //==============================================================================
40 /** Returns the operating system's current volume level in the range 0 to 1.0 */
41 static float JUCE_CALLTYPE getGain();
42
43 /** Attempts to set the operating system's current volume level.
44 @param newGain the level, between 0 and 1.0
45 @returns true if the operation succeeds
46 */
47 static bool JUCE_CALLTYPE setGain (float newGain);
48
49 /** Returns true if the system's audio output is currently muted. */
50 static bool JUCE_CALLTYPE isMuted();
51
52 /** Attempts to mute the operating system's audio output.
53 @param shouldBeMuted true if you want it to be muted
54 @returns true if the operation succeeds
55 */
56 static bool JUCE_CALLTYPE setMuted (bool shouldBeMuted);
57
58private:
59 SystemAudioVolume(); // Don't instantiate this class, just call its static fns.
60 JUCE_DECLARE_NON_COPYABLE (SystemAudioVolume)
61};
62
63} // namespace juce
64
65/** @}*/
Contains functions to control the system's master volume.
static float JUCE_CALLTYPE getGain()
Returns the operating system's current volume level in the range 0 to 1.0.
static bool JUCE_CALLTYPE setMuted(bool shouldBeMuted)
Attempts to mute the operating system's audio output.
static bool JUCE_CALLTYPE setGain(float newGain)
Attempts to set the operating system's current volume level.
static bool JUCE_CALLTYPE isMuted()
Returns true if the system's audio output is currently muted.
#define JUCE_API
This macro is added to all JUCE public class declarations.