flightsimulatorplatfrom/pilotclient
1
0
Fork 0
mirror of https://github.com/swift-project/pilotclient.git synced 2026-03-22 14:55:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

[FSD] Doxygen

Browse Source
This commit is contained in:
Mat Sutcliffe
2019-10-03 19:09:26 +01:00
parent 6eb008c0a0
commit 2dbc347bd7
3 changed files with 19 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/blackcore/context/contextaudio.h
View File

@@ -91,7 +91,8 @@ namespace BlackCore
//! Reference to voice client
BlackCore::Afv::Clients::CAfvClient &voiceClient() { return m_voiceClient; }
//! Audio devices @{
//! Audio devices
//! @{
BlackMisc::Audio::CAudioDeviceInfoList getAudioDevices() const;
BlackMisc::Audio::CAudioDeviceInfoList getAudioInputDevices() const { return this->getAudioDevices().getInputDevices(); }
BlackMisc::Audio::CAudioDeviceInfoList getAudioOutputDevices() const { return this->getAudioDevices().getOutputDevices(); }
@@ -105,7 +106,8 @@ namespace BlackCore
//! \param audioDevice can be input or audio device
void setCurrentAudioDevices(const BlackMisc::Audio::CAudioDeviceInfo &audioDevice, const BlackMisc::Audio::CAudioDeviceInfo &outputDevice);
//! Volume @{
//! Volume
//! @{
void setVoiceOutputVolume(int volume);
int getVoiceOutputVolume() const;
void setMute(bool muted);
@@ -118,12 +120,14 @@ namespace BlackCore
//! Notification sounds
void playNotification(BlackMisc::Audio::CNotificationSounds::NotificationFlag notification, bool considerSettings, int volume = -1);
//! Loopback @{
//! Loopback
//! @{
void enableAudioLoopback(bool enable = true);
bool isAudioLoopbackEnabled() const;
//! @}
//! Voice setup @{
//! Voice setup
//! @{
BlackMisc::Audio::CVoiceSetup getVoiceSetup() const;
void setVoiceSetup(const BlackMisc::Audio::CVoiceSetup &setup);
//! @}
@@ -161,20 +165,19 @@ namespace BlackCore
// ------------- DBus ---------------
//! \addtogroup swiftdotcommands
//! @{
//! <pre>
//! .mute mute BlackCore::Context::CContextAudio
//! .unmute unmute BlackCore::Context::CContextAudio
//! .vol .volume volume 0..100 set volume BlackCore::Context::CContextAudio
//! </pre>
//! @}
//! \copydoc IContextAudio::parseCommandLine
virtual bool parseCommandLine(const QString &commandLine, const BlackMisc::CIdentifier &originator) override;
// ------------- DBus ---------------
private:
//! Enable/disable voice transmission, nornally used with hotkey @{
//! Enable/disable voice transmission, nornally used with hotkey
//! @{
void setVoiceTransmission(bool enable, BlackMisc::Audio::PTTCOM com);
void setVoiceTransmissionCom1(bool enabled);
void setVoiceTransmissionCom2(bool enabled);
@@ -187,7 +190,8 @@ namespace BlackCore
//! Changed audio settings
void onChangedAudioSettings();
//! Audio increase/decrease volume @{
//! Audio increase/decrease volume
//! @{
void audioIncreaseVolume(bool enabled);
void audioDecreaseVolume(bool enabled);
//! @}

6
src/blackmisc/network/connectionstatus.h
View File

@@ -37,13 +37,13 @@ namespace BlackMisc
//! Constructor
CConnectionStatus(ConnectionStatus status) : m_connectionStatus(status) {}
//! Query status
//! @{
bool isConnected() const { return m_connectionStatus == Connected; }
bool isConnecting() const { return m_connectionStatus == Connecting; }
bool isDisconnecting() const { return m_connectionStatus == Disconnecting; }
bool isDisconnected() const { return m_connectionStatus == Disconnected; }
//! @}
//! Get status
ConnectionStatus getConnectionStatus() const { return m_connectionStatus; }

6
src/blackmisc/network/loginmode.h
View File

@@ -35,14 +35,16 @@ namespace BlackMisc
//! Constructor
CLoginMode(LoginMode mode) : m_loginMode(mode) {}
//! Is login as pilot?
bool isPilot() const { return m_loginMode == Pilot; }
//! Is login as observer?
bool isObserver() const { return m_loginMode == Observer; }
//! Get status
//! Get login mode
LoginMode getLoginMode() const { return m_loginMode; }
//! Set status
//! Set login mode
void setLoginMode(LoginMode mode) { m_loginMode = mode; }
//! \copydoc BlackMisc::Mixin::String::toQString