MillicastSDK 2.0.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
millicast::AudioControl Class Referenceabstract

The AudioControl class. More...

#include <source.h>

Inheritance diagram for millicast::AudioControl:
Inheritance graph
[legend]

Public Member Functions

virtual void set_volume (uint32_t v)=0
 Set the microphone / speaker volume.
 
virtual void set_num_channel (uint8_t n)=0
 Set the number of channels to use.
 
virtual void mute (bool m)=0
 Mute the microphone or the speakers.
 
virtual uint32_t get_volume ()=0
 Get the current volume.
 
virtual bool is_muted () const =0
 Tell whether the mic / speaker is muted or not.
 

Detailed Description

The AudioControl class.

Member Function Documentation

◆ get_volume()

virtual uint32_t millicast::AudioControl::get_volume ( )
pure virtual

Get the current volume.

Returns
The current volume.

◆ is_muted()

virtual bool millicast::AudioControl::is_muted ( ) const
pure virtual

Tell whether the mic / speaker is muted or not.

Returns
true if muted, false otherwise.

◆ mute()

virtual void millicast::AudioControl::mute ( bool  m)
pure virtual

Mute the microphone or the speakers.

Parameters
mtrue if you want to mute, false if you want to unmute

◆ set_num_channel()

virtual void millicast::AudioControl::set_num_channel ( uint8_t  n)
pure virtual

Set the number of channels to use.

Parameters
nThe number of channels.
Warning
Only implemented for Source::Type::Device for now. Possible values are 1 or 2.

◆ set_volume()

virtual void millicast::AudioControl::set_volume ( uint32_t  v)
pure virtual

Set the microphone / speaker volume.

Parameters
vThe volume as an integer.

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