libdisplaydevice master
C++ library to modify display devices.
display_device::NoopAudioContext Class Reference

A no-operation implementation for AudioContextInterface. More...

#include <src/common/include/display_device/noop_audio_context.h>

Inheritance diagram for display_device::NoopAudioContext:
[legend]
Collaboration diagram for display_device::NoopAudioContext:
[legend]

Public Member Functions

bool capture () override
 Capture audio context for currently active devices.
 
bool isCaptured () const override
 Check if the context is already captured.
 
void release () override
 Release captured audio context for the devices (if any).
 
- Public Member Functions inherited from display_device::AudioContextInterface
virtual ~AudioContextInterface ()=default
 Default virtual destructor.
 

Detailed Description

A no-operation implementation for AudioContextInterface.

Member Function Documentation

◆ capture()

bool display_device::NoopAudioContext::capture ( )
nodiscardoverridevirtual

Capture audio context for currently active devices.

Returns
True if the contexts could be captured, false otherwise.

*Examples**

AudioContextInterface* iface = getIface(...);
const auto result { iface->capture() };
A class for capturing associated audio context (settings, info or whatever).
Definition audio_context_interface.h:15
virtual bool capture()=0
Capture audio context for currently active devices.

Implements display_device::AudioContextInterface.

◆ isCaptured()

bool display_device::NoopAudioContext::isCaptured ( ) const
nodiscardoverridevirtual

Check if the context is already captured.

Returns
True if the context is captured, false otherwise.

*Examples**

AudioContextInterface* iface = getIface(...);
const auto result { iface->isCaptured() };
virtual bool isCaptured() const =0
Check if the context is already captured.

Implements display_device::AudioContextInterface.

◆ release()

void display_device::NoopAudioContext::release ( )
overridevirtual

Release captured audio context for the devices (if any).

*Examples**

AudioContextInterface* iface = getIface(...);
const auto result { iface->release() };
virtual void release()=0
Release captured audio context for the devices (if any).

Implements display_device::AudioContextInterface.


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