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

The DeckLinkRenderer class is used to render video on a DeckLink device. More...

#include <renderer.h>

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

Public Member Functions

 DeckLinkRenderer ()=default
 
 ~DeckLinkRenderer () override=default
 
virtual MILLICAST_API void set_source (VideoSource::Ptr device)=0
 Set the decklink device to used to render video.
 
virtual MILLICAST_API void stop ()=0
 
- 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 std::vector< VideoSource::Ptrget_decklink_devices ()
 Get all decklink devices that can output video.
 
static MILLICAST_API DeckLinkRenderercreate ()
 Create a DeckLink renderer.
 

Detailed Description

The DeckLinkRenderer class is used to render video on a DeckLink device.

Remarks
For now, this class does not render audio on decklink devices, use AudioPlayback with a DeckLink device instead.

Constructor & Destructor Documentation

◆ DeckLinkRenderer()

millicast::DeckLinkRenderer::DeckLinkRenderer ( )
default

◆ ~DeckLinkRenderer()

millicast::DeckLinkRenderer::~DeckLinkRenderer ( )
overridedefault

Member Function Documentation

◆ create()

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

Create a DeckLink renderer.

Returns
A DeckLink renderer object.

◆ get_decklink_devices()

static MILLICAST_API std::vector< VideoSource::Ptr > millicast::DeckLinkRenderer::get_decklink_devices ( )
static

Get all decklink devices that can output video.

Returns
An array of decklink output devices.

◆ set_source()

virtual MILLICAST_API void millicast::DeckLinkRenderer::set_source ( VideoSource::Ptr  device)
pure virtual

Set the decklink device to used to render video.

Parameters
deviceThe DeckLink device.

◆ stop()

virtual MILLICAST_API void millicast::DeckLinkRenderer::stop ( )
pure virtual

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