swift
Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
swift::core::context::CContextAudioBase Class Reference

Audio context base class. More...

Inheritance diagram for swift::core::context::CContextAudioBase:
[legend]

Signals

void changedAudioVolume (int volume)
 Audio volume changed. More...
 
void changedOutputMute (bool muted)
 Output mute changed.
 
void changedLocalAudioDevices (const swift::misc::audio::CAudioDeviceInfoList &devices)
 Changed audio devices (e.g. device enabled/disable)
 
void startedAudio (const swift::misc::audio::CAudioDeviceInfo &input, const swift::misc::audio::CAudioDeviceInfo &output)
 Audio started with devices.
 
void stoppedAudio ()
 Audio stopped.
 
void ptt (bool active, const swift::misc::CIdentifier &identifier)
 PTT in voice client received.
 
- Signals inherited from swift::core::context::IContextAudio
void voiceClientFailure (const swift::misc::CStatusMessage &msg)
 Authentication failed, ....
 
- Signals inherited from swift::core::context::IContext
void changedLogOrDebugSettings ()
 Log or debug values changed.
 

Public Member Functions

 ~CContextAudioBase ()
 Destructor.
 
void gracefulShutdown ()
 Graceful shutdown.
 
swift::misc::audio::CAudioDeviceInfoList getCurrentAudioDevices () const
 Get current audio device. More...
 
void setCurrentAudioDevices (const swift::misc::audio::CAudioDeviceInfo &inputDevice, const swift::misc::audio::CAudioDeviceInfo &outputDevice)
 Set current audio devices.
 
void playSelcalTone (const swift::misc::aviation::CSelcal &selcal)
 SELCAL.
 
void playNotification (swift::misc::audio::CNotificationSounds::NotificationFlag notification, bool considerSettings, int volume=-1)
 Notification sounds.
 
QString audioRunsWhereInfo () const
 Info string about audio.
 
const swift::misc::CIdentifieraudioRunsWhere () const
 Audio runs where.
 
bool isEnabledComUnit (swift::misc::aviation::CComSystem::ComUnit comUnit) const
 Is COM unit enabled?
 
bool isTransmittingComUnit (swift::misc::aviation::CComSystem::ComUnit comUnit) const
 Is COM unit transmitting?
 
bool connectAudioWithNetworkCredentials ()
 Connect to audio with network credentials. More...
 
bool isAudioConnected () const
 Is audio connected?
 
bool isAudioStarted () const
 Is audio started?
 
bool isAudioEnabled () const
 Is audio enabled?
 
bool isComUnitIntegrated () const
 Integrated with COM unit?
 
afv::clients::CAfvClientafvClient () const
 
 CContextAudioBase (const CContextAudioBase &)=delete
 Copy operations.
 
CContextAudioBaseoperator= (const CContextAudioBase &)=delete
 Copy operations.
 
 CContextAudioBase (CContextAudioBase &&)=delete
 Move operations.
 
CContextAudioBaseoperator= (CContextAudioBase &&)=delete
 Move operations.
 
void setRxTx (bool rx1, bool tx1, bool rx2, bool tx2)
 Receive/transmit.
 
void getRxTx (bool &rx1, bool &tx1, bool &rx2, bool &tx2) const
 Receive/transmit.
 
swift::misc::audio::CAudioDeviceInfoList getAudioDevices () const
 Audio devices.
 
swift::misc::audio::CAudioDeviceInfoList getAudioInputDevices () const
 Audio devices.
 
swift::misc::audio::CAudioDeviceInfoList getAudioOutputDevices () const
 Audio devices.
 
void setMasterOutputVolume (int volume)
 Volume.
 
void setComOutputVolume (swift::misc::aviation::CComSystem::ComUnit comUnit, int volume)
 Volume.
 
int getMasterOutputVolume () const
 Volume.
 
int getComOutputVolume (swift::misc::aviation::CComSystem::ComUnit comUnit) const
 Volume.
 
void setOutputMute (bool muted)
 Volume.
 
bool isOutputMuted () const
 Volume.
 
void enableAudioLoopback (bool enable=true)
 Loopback.
 
bool isAudioLoopbackEnabled () const
 Loopback.
 
- Public Member Functions inherited from swift::core::context::IContextAudio
QString getPathAndContextId () const
 Id and path name for round trip protection. More...
 
- Public Member Functions inherited from swift::core::context::IContext
 ~IContext ()=default
 Destructor.
 
bool isUsingImplementingObject () const
 Using local implementing object?
 
bool isLocalObject () const
 Local or remote object?
 
bool isEmptyObject () const
 Empty object?
 
CCoreFacadegetRuntime ()
 Runtime.
 
const CCoreFacadegetRuntime () const
 Const runtime.
 
CCoreFacadeConfig::ContextMode getMode () const
 Mode.
 
qint64 getUniqueId () const
 Unique id.
 
const IContextApplicationgetIContextApplication () const
 Context for application.
 
IContextApplicationgetIContextApplication ()
 Application.
 
IContextAudiogetIContextAudio ()
 Context for network.
 
const IContextAudiogetIContextAudio () const
 Context for network.
 
IContextNetworkgetIContextNetwork ()
 Context for network.
 
const IContextNetworkgetIContextNetwork () const
 Context for network.
 
IContextOwnAircraftgetIContextOwnAircraft ()
 Context for own aircraft.
 
const IContextOwnAircraftgetIContextOwnAircraft () const
 Context for own aircraft.
 
const IContextSimulatorgetIContextSimulator () const
 Context for simulator.
 
IContextSimulatorgetIContextSimulator ()
 Simulator.
 
void setDebugEnabled (bool debug)
 Set debug flag.
 
bool isDebugEnabled () const
 Debug enabled?
 
virtual bool parseCommandLine (const QString &commandLine, const swift::misc::CIdentifier &originator)=0
 Parse a given command line.
 
- Public Member Functions inherited from swift::misc::CIdentifiable
const CIdentifieridentifier () const
 Get identifier.
 
void setIdentifier (const CIdentifier &identifier)
 Set identifier, allows to set an external identifier.
 
bool isMyIdentifier (const CIdentifier &otherIdentifier) const
 My identifier?
 

Static Public Member Functions

static const QList< QCommandLineOption > & getCmdLineOptions ()
 Cmd.line arguments.
 
static bool isNoAudioSet ()
 No audio?
 
static void registerHelp ()
 Register the commands.
 
- Static Public Member Functions inherited from swift::core::context::IContextAudio
static const QString & InterfaceName ()
 Interface name.
 
static const QString & ObjectPath ()
 Object path.
 
static IContextAudiocreate (CCoreFacade *runtime, CCoreFacadeConfig::ContextMode mode, swift::misc::CDBusServer *server, QDBusConnection &connection)
 Factory method.
 
- Static Public Member Functions inherited from swift::core::context::IContext
static const QStringList & getLogCategories ()
 Log categories.
 

Protected Member Functions

 CContextAudioBase (CCoreFacadeConfig::ContextMode mode, CCoreFacade *runtime)
 Constructor.
 
- Protected Member Functions inherited from swift::core::context::IContextAudio
 IContextAudio (CCoreFacadeConfig::ContextMode mode, CCoreFacade *runtime)
 Constructor.
 
void onChangedLocalDevices (const swift::misc::audio::CAudioDeviceInfoList &devices)
 Devices have been changed.
 
- Protected Member Functions inherited from swift::core::context::IContext
 IContext (CCoreFacadeConfig::ContextMode mode, QObject *parent)
 Constructor.
 
QString buildPathAndContextId (const QString &path) const
 Path and context id.
 
void relayBaseClassSignals (const QString &serviceName, QDBusConnection &connection, const QString &objectPath, const QString &interfaceName)
 Relay signals from this class.
 
void logEmptyContextWarning (const QString &functionName) const
 Empty context called.
 
virtual void onAboutToShutdown ()
 Called when shutdown is about to be called.
 
void registerWithDBus (const QString &objectPath, misc::CDBusServer *server)
 Register myself in DBus.
 
- Protected Member Functions inherited from swift::misc::CIdentifiable
 CIdentifiable (const QString &objectName)
 Use literal based object name.
 
 CIdentifiable (QObject *nameProvider)
 Connect with QObject providing the name.
 
 CIdentifiable ()
 Construct without a name.
 
 ~CIdentifiable ()
 Destructor.
 
 CIdentifiable (const CIdentifiable &)=default
 Copy constructor.
 
CIdentifiableoperator= (const CIdentifiable &)=default
 Copy assignment operator.
 

Friends

class swift::core::CCoreFacade
 

Additional Inherited Members

- Public Slots inherited from swift::core::context::IContextAudio
virtual swift::misc::audio::CAudioDeviceInfoList getRegisteredDevices () const =0
 All registered devices.
 
virtual void registerDevices (const swift::misc::audio::CAudioDeviceInfoList &devices)=0
 Register a device on a machine (for core/GUI it will return all known devices on all machines)
 
virtual void unRegisterDevices (const swift::misc::audio::CAudioDeviceInfoList &devices)=0
 Unregister devices.
 
virtual void unRegisterDevicesFor (const swift::misc::CIdentifier &identifier)=0
 Remove all devices for identifier (i.e. "a machine")
 
virtual void registerAudioCallsign (const swift::misc::aviation::CCallsign &callsign, const swift::misc::CIdentifier &identifier)=0
 Register an audio callsign (used with AFV) More...
 
virtual void unRegisterAudioCallsign (const swift::misc::aviation::CCallsign &callsign, const swift::misc::CIdentifier &identifier)=0
 Un-register an audio callsign (used with AFV) More...
 
virtual bool hasRegisteredAudioCallsign (const swift::misc::aviation::CCallsign &callsign) const =0
 Un-register an audio callsign (used with AFV) More...
 
- Static Protected Member Functions inherited from swift::core::context::IContext
static const misc::CStatusMessagestatusMessageEmptyContext ()
 Standard message when status message is returned in empty context.
 

Detailed Description

Audio context base class.

Definition at line 126 of file contextaudio.h.

Member Function Documentation

◆ afvClient()

afv::clients::CAfvClient* swift::core::context::CContextAudioBase::afvClient ( ) const
inline
Todo:
WORKAROUND to hide the "local signals"

Definition at line 229 of file contextaudio.h.

◆ changedAudioVolume

void swift::core::context::CContextAudioBase::changedAudioVolume ( int  volume)
signal

Audio volume changed.

See also
setVoiceOutputVolume

◆ connectAudioWithNetworkCredentials()

bool swift::core::context::CContextAudioBase::connectAudioWithNetworkCredentials ( )

Connect to audio with network credentials.

Remarks
if there is no network connection/credential this just returns

◆ getCurrentAudioDevices()

swift::misc::audio::CAudioDeviceInfoList swift::core::context::CContextAudioBase::getCurrentAudioDevices ( ) const

Get current audio device.

Returns
input and output devices

The documentation for this class was generated from the following file: