AJA NTV2 SDK  17.6.0.2675
NTV2 SDK 17.6.0.2675
NTV2Overlay Class Reference

Outputs live input video overlaid with image having transparency. More...

#include <ntv2overlay.h>

Public Member Functions

 NTV2Overlay (const OverlayConfig &inConfig)
 Construct from OverlayConfig. More...
 
virtual ~NTV2Overlay ()
 My destructor. More...
 
AJAStatus Init (void)
 Prepares me to Run() More...
 
AJAStatus Run (void)
 Runs me (only after Init called) More...
 
void Quit (void)
 Gracefully stops me. More...
 

Protected Member Functions

AJAStatus SetupVideo (void)
 Performs all video setup. More...
 
AJAStatus SetupAudio (void)
 Performs all audio setup. More...
 
AJAStatus SetupCaptureBuffers (void)
 Allocates capture buffers & ring. More...
 
void ReleaseCaptureBuffers (void)
 Frees capture buffers & ring. More...
 
AJAStatus SetupOverlayBug (void)
 Sets up overlay "bug". More...
 
NTV2VideoFormat WaitForStableInputSignal (void)
 Waits for stable input signal. More...
 
bool IsInputSignalRGB (void)
 
void RouteInputSignal (void)
 Performs input routing. More...
 
void RouteOverlaySignal (void)
 Performs overlay routing. More...
 
void RouteOutputSignal (void)
 Performs output routing. More...
 
void StartOutputThread (void)
 Starts output thread. More...
 
void OutputThread (void)
 The output/playout thread function. More...
 
void StartInputThread (void)
 Starts input thread. More...
 
void InputThread (void)
 The input/capture thread function. More...
 

Static Protected Member Functions

static void OutputThreadStatic (AJAThread *pThread, void *pInstance)
 
static void InputThreadStatic (AJAThread *pThread, void *pInstance)
 Static output/playout thread function. More...
 

Detailed Description

Outputs live input video overlaid with image having transparency.

Definition at line 22 of file ntv2overlay.h.

Constructor & Destructor Documentation

◆ NTV2Overlay()

NTV2Overlay::NTV2Overlay ( const OverlayConfig inConfig)

Construct from OverlayConfig.

Definition at line 24 of file ntv2overlay.cpp.

◆ ~NTV2Overlay()

NTV2Overlay::~NTV2Overlay ( )
virtual

My destructor.

Definition at line 38 of file ntv2overlay.cpp.

Member Function Documentation

◆ Init()

AJAStatus NTV2Overlay::Init ( void  )

Prepares me to Run()

Definition at line 68 of file ntv2overlay.cpp.

◆ InputThread()

void NTV2Overlay::InputThread ( void  )
protected

The input/capture thread function.

Definition at line 537 of file ntv2overlay.cpp.

◆ InputThreadStatic()

void NTV2Overlay::InputThreadStatic ( AJAThread pThread,
void *  pInstance 
)
staticprotected

Static output/playout thread function.

Definition at line 517 of file ntv2overlay.cpp.

◆ IsInputSignalRGB()

bool NTV2Overlay::IsInputSignalRGB ( void  )
protected
Returns
true if input signal is RGB

Definition at line 157 of file ntv2overlay.cpp.

◆ OutputThread()

void NTV2Overlay::OutputThread ( void  )
protected

The output/playout thread function.

Definition at line 411 of file ntv2overlay.cpp.

◆ OutputThreadStatic()

void NTV2Overlay::OutputThreadStatic ( AJAThread pThread,
void *  pInstance 
)
staticprotected

Definition at line 390 of file ntv2overlay.cpp.

◆ Quit()

void NTV2Overlay::Quit ( void  )

Gracefully stops me.

Definition at line 48 of file ntv2overlay.cpp.

◆ ReleaseCaptureBuffers()

void NTV2Overlay::ReleaseCaptureBuffers ( void  )
protected

Frees capture buffers & ring.

Definition at line 252 of file ntv2overlay.cpp.

◆ RouteInputSignal()

void NTV2Overlay::RouteInputSignal ( void  )
protected

Performs input routing.

Definition at line 168 of file ntv2overlay.cpp.

◆ RouteOutputSignal()

void NTV2Overlay::RouteOutputSignal ( void  )
protected

Performs output routing.

Definition at line 207 of file ntv2overlay.cpp.

◆ RouteOverlaySignal()

void NTV2Overlay::RouteOverlaySignal ( void  )
protected

Performs overlay routing.

Definition at line 198 of file ntv2overlay.cpp.

◆ Run()

AJAStatus NTV2Overlay::Run ( void  )

Runs me (only after Init called)

Definition at line 370 of file ntv2overlay.cpp.

◆ SetupAudio()

AJAStatus NTV2Overlay::SetupAudio ( void  )
protected

Performs all audio setup.

Definition at line 215 of file ntv2overlay.cpp.

◆ SetupCaptureBuffers()

AJAStatus NTV2Overlay::SetupCaptureBuffers ( void  )
protected

Allocates capture buffers & ring.

Definition at line 229 of file ntv2overlay.cpp.

◆ SetupOverlayBug()

AJAStatus NTV2Overlay::SetupOverlayBug ( void  )
protected

Sets up overlay "bug".

Definition at line 290 of file ntv2overlay.cpp.

◆ SetupVideo()

AJAStatus NTV2Overlay::SetupVideo ( void  )
protected

Performs all video setup.

Definition at line 127 of file ntv2overlay.cpp.

◆ StartInputThread()

void NTV2Overlay::StartInputThread ( void  )
protected

Starts input thread.

Definition at line 508 of file ntv2overlay.cpp.

◆ StartOutputThread()

void NTV2Overlay::StartOutputThread ( void  )
protected

Starts output thread.

Definition at line 381 of file ntv2overlay.cpp.

◆ WaitForStableInputSignal()

NTV2VideoFormat NTV2Overlay::WaitForStableInputSignal ( void  )
protected

Waits for stable input signal.

Definition at line 321 of file ntv2overlay.cpp.


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