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

The AudioTrack class. More...

#include <track.h>

Inheritance diagram for millicast::AudioTrack:
Inheritance graph
[legend]
Collaboration diagram for millicast::AudioTrack:
Collaboration graph
[legend]

Public Member Functions

 AudioTrack ()=default
 
 ~AudioTrack () override=default
 
virtual void add_renderer (AudioRenderer *renderer)=0
 Add an audio renderer to render this track. Several renderers can be added to the track. Each one will be called when a new frame is available.
 
virtual void remove_renderer (AudioRenderer *renderer)=0
 Remove a renderer from the renderer list.
 
virtual void set_volume (double volume)=0
 Set the track's volume.
 
- Public Member Functions inherited from millicast::Track
 Track ()=default
 
virtual ~Track ()=default
 
virtual const std::string & id () const =0
 Get the track's id.
 
virtual const std::string & kind () const =0
 Get the track's kind.
 
virtual bool is_enabled () const =0
 Tell whether the track is enabled or not.
 
virtual void enable (bool e)=0
 enable or disable the track. A disabled track will produce silence (if audio) or black frames (if video). Can be disabled and re-enabled.
 

Detailed Description

The AudioTrack class.

Constructor & Destructor Documentation

◆ AudioTrack()

millicast::AudioTrack::AudioTrack ( )
default

◆ ~AudioTrack()

millicast::AudioTrack::~AudioTrack ( )
overridedefault

Member Function Documentation

◆ add_renderer()

virtual void millicast::AudioTrack::add_renderer ( AudioRenderer renderer)
pure virtual

Add an audio renderer to render this track. Several renderers can be added to the track. Each one will be called when a new frame is available.

Parameters
rendererThe audio renderer.

◆ remove_renderer()

virtual void millicast::AudioTrack::remove_renderer ( AudioRenderer renderer)
pure virtual

Remove a renderer from the renderer list.

Parameters
rendererThe renderer to remove.

◆ set_volume()

virtual void millicast::AudioTrack::set_volume ( double  volume)
pure virtual

Set the track's volume.

Parameters
volumeThe volume as a double between 0 and 1
Warning
Only affect remote track

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