mixer/Internal: document that caller must lock the mutex
This commit is contained in:
parent
e1e8f45983
commit
6c0546d829
@ -72,18 +72,24 @@ public:
|
||||
/**
|
||||
* Open mixer device
|
||||
*
|
||||
* Caller must lock the mutex.
|
||||
*
|
||||
* Throws std::runtime_error on error.
|
||||
*/
|
||||
virtual void Open() = 0;
|
||||
|
||||
/**
|
||||
* Close mixer device
|
||||
*
|
||||
* Caller must lock the mutex.
|
||||
*/
|
||||
virtual void Close() noexcept = 0;
|
||||
|
||||
/**
|
||||
* Reads the current volume.
|
||||
*
|
||||
* Caller must lock the mutex.
|
||||
*
|
||||
* Throws std::runtime_error on error.
|
||||
*
|
||||
* @return the current volume (0..100 including) or -1 if
|
||||
@ -94,6 +100,8 @@ public:
|
||||
/**
|
||||
* Sets the volume.
|
||||
*
|
||||
* Caller must lock the mutex.
|
||||
*
|
||||
* Throws std::runtime_error on error.
|
||||
*
|
||||
* @param volume the new volume (0..100 including)
|
||||
|
Loading…
Reference in New Issue
Block a user