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

The Track class represent a media sources. More...

#include <track.h>

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

Public Member Functions

 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 Track class represent a media sources.

Constructor & Destructor Documentation

◆ Track()

millicast::Track::Track ( )
default

◆ ~Track()

virtual millicast::Track::~Track ( )
virtualdefault

Member Function Documentation

◆ enable()

virtual void millicast::Track::enable ( bool  e)
pure virtual

enable or disable the track. A disabled track will produce silence (if audio) or black frames (if video). Can be disabled and re-enabled.

Parameters
etrue to enable, false to disable.

◆ id()

virtual const std::string & millicast::Track::id ( ) const
pure virtual

Get the track's id.

Returns
The track's id.

◆ is_enabled()

virtual bool millicast::Track::is_enabled ( ) const
pure virtual

Tell whether the track is enabled or not.

Returns
true if the track is enabled, false otherwise.

◆ kind()

virtual const std::string & millicast::Track::kind ( ) const
pure virtual

Get the track's kind.

Returns
The track's kind. Either audio or video.

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