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

The NdiRenderer class is used to render video as an ndi source. More...

#include <renderer.h>

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

Public Member Functions

 NdiRenderer ()=default
 
 ~NdiRenderer () override=default
 
virtual MILLICAST_API void set_name (const std::string &)=0
 Set the name of the ndi source. This is the name that will be displayed to other ndi application when they search for ndi sources.
 
- Public Member Functions inherited from millicast::VideoRenderer
 VideoRenderer ()=default
 
 ~VideoRenderer () override=default
 
virtual void on_frame (const VideoFrame &frame)=0
 on_frame is called when a new video frame is available ( either captured or received from a peer )
 
- Public Member Functions inherited from millicast::Renderer
 Renderer ()=default
 
virtual ~Renderer ()=default
 
virtual void init ()=0
 init the renderer
 

Static Public Member Functions

static MILLICAST_API NdiRenderercreate ()
 Create an Ndi renderer.
 

Detailed Description

The NdiRenderer class is used to render video as an ndi source.

Remarks
For now, this class does not render audio, use AudioPlayback with Ndi output instead.

Constructor & Destructor Documentation

◆ NdiRenderer()

millicast::NdiRenderer::NdiRenderer ( )
default

◆ ~NdiRenderer()

millicast::NdiRenderer::~NdiRenderer ( )
overridedefault

Member Function Documentation

◆ create()

static MILLICAST_API NdiRenderer * millicast::NdiRenderer::create ( )
static

Create an Ndi renderer.

Returns
An Ndi renderer object.

◆ set_name()

virtual MILLICAST_API void millicast::NdiRenderer::set_name ( const std::string &  )
pure virtual

Set the name of the ndi source. This is the name that will be displayed to other ndi application when they search for ndi sources.

Parameters
nameThe name of the source.

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