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

The VideoTrack class. More...

#include <track.h>

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

Public Types

enum class  ContentHint { NONE , FLUID , DETAILED , TEXT }
 Video track content hint, used to override the source is_screencast property. More...
 

Public Member Functions

 VideoTrack ()=default
 
 ~VideoTrack () override=default
 
virtual void add_renderer (VideoRenderer *renderer)=0
 Add a VideoRenderer to render this video track. Several renderers can be added to the track. Each one will be called when a new frame is available.
 
virtual void remove_renderer (VideoRenderer *renderer)=0
 Remove a renderer from the renderer list.
 
virtual void set_content_hint (ContentHint hint) noexcept=0
 Set the content hint for this track.
 
virtual ContentHint content_hint () const noexcept=0
 Get the current content hint for this track.
 
- 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 VideoTrack class.

Member Enumeration Documentation

◆ ContentHint

Video track content hint, used to override the source is_screencast property.

Enumerator
NONE 
FLUID 
DETAILED 
TEXT 

Constructor & Destructor Documentation

◆ VideoTrack()

millicast::VideoTrack::VideoTrack ( )
default

◆ ~VideoTrack()

millicast::VideoTrack::~VideoTrack ( )
overridedefault

Member Function Documentation

◆ add_renderer()

virtual void millicast::VideoTrack::add_renderer ( VideoRenderer renderer)
pure virtual

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

Parameters
rendererThe video renderer.

◆ content_hint()

virtual ContentHint millicast::VideoTrack::content_hint ( ) const
pure virtualnoexcept

Get the current content hint for this track.

Returns
The current content hint

◆ remove_renderer()

virtual void millicast::VideoTrack::remove_renderer ( VideoRenderer renderer)
pure virtual

Remove a renderer from the renderer list.

Parameters
rendererThe renderer to remove.

◆ set_content_hint()

virtual void millicast::VideoTrack::set_content_hint ( ContentHint  hint)
pure virtualnoexcept

Set the content hint for this track.

Parameters
hintThe hint to set

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