AampRDKCCManager Class Reference

Handling CC operations. More...

#include <AampRDKCCManager.h>

Inheritance diagram for AampRDKCCManager:

Collaboration diagram for AampRDKCCManager:

Public Member Functions
void	Release (int iID) override
	Release CC resources.
	AampRDKCCManager ()=default
	Constructor.
	~AampRDKCCManager ()=default
	Destructor.
	AampRDKCCManager (const AampRDKCCManager &)=delete
AampRDKCCManager &	operator= (const AampRDKCCManager &)=delete
Public Member Functions inherited from AampCCManagerBase
int	Init (void *handle)
	Initialize CC resource. More...
virtual int	GetId ()
	Gets Handle or ID, Every client using subtec must call GetId in the begining , save id, which is required for Release funciton. More...
int	SetStatus (bool enable)
	Enable/disable CC rendering. More...
bool	GetStatus ()
	Get CC rendering status. More...
const std::string &	GetTrack ()
	Get current CC track. More...
int	SetTrack (const std::string &track, const CCFormat format=eCLOSEDCAPTION_FORMAT_DEFAULT)
	Set CC track. More...
int	SetStyle (const std::string &options)
	Set CC styles for rendering. More...
const std::string &	GetStyle ()
	Get current CC styles. More...
void	SetTrickplayStatus (bool enable)
	To enable/disable CC when trickplay starts/ends. More...
void	SetParentalControlStatus (bool locked)
	To enable/disable CC when parental control locked/unlocked. More...
void	RestoreCC ()
	To restore cc state after new tune. More...
void	updateLastTextTracks (const std::vector< TextTrackInfo > &newTextTracks)
	update stored list of text tracks More...
const std::vector< TextTrackInfo > &	getLastTextTracks () const
	Get list of text tracks. More...
void	SetLogger (AampLogManager *logObj)
bool	IsOOBCCRenderingSupported ()
	To check whether Out of Band Closed caption/Subtile rendering supported or not. More...

Private Member Functions
void	StartRendering () override
	To start CC rendering. More...
void	StopRendering () override
	To stop CC rendering. More...
int	Initialize (void *handle) override
	Impl specific initialization code called once in Init() function. More...
int	SetDigitalChannel (unsigned int id) override
	set digital channel with specified id More...
int	SetAnalogChannel (unsigned int id) override
	set analog channel with specified id More...
bool	CheckCCHandle () const override
	validate mCCHandle More...

Private Attributes
void *	mCCHandle {nullptr}

Additional Inherited Members
Protected Member Functions inherited from AampCCManagerBase
virtual void	EnsureInitialized ()
	Impl specific initialization code called before each public interface call. More...
virtual void	EnsureHALInitialized ()
	Impl specific initialization code for HAL. More...
virtual void	EnsureRendererCommsInitialized ()
	Impl specific initialization code for Communication with renderer. More...
void	Start ()
	To start CC rendering. More...
void	Stop ()
	To stop CC rendering. More...
Protected Attributes inherited from AampCCManagerBase
std::string	mOptions {}
std::string	mTrack {}
std::vector< TextTrackInfo >	mLastTextTracks {}
bool	mEnabled {false}
bool	mTrickplayStarted {false}
bool	mParentalCtrlLocked {false}
AampLogManager *	mLogObj {NULL}

yes

Handling CC operations.

Definition at line 39 of file AampRDKCCManager.h.

Member Function Documentation

StartRendering()

AampRDKCCManager::StartRendering ( )

overrideprivatevirtual

To start CC rendering.

Returns

void

Implements AampCCManagerBase.

Definition at line 55 of file AampRDKCCManager.cpp.

StopRendering()

AampRDKCCManager::StopRendering ( )

overrideprivatevirtual

To stop CC rendering.

Returns

void

Implements AampCCManagerBase.

Definition at line 63 of file AampRDKCCManager.cpp.

Initialize()

AampRDKCCManager::Initialize ( void *  handle )

overrideprivatevirtual

Impl specific initialization code called once in Init() function.

Returns

0 - success, -1 - failure

Reimplemented from AampCCManagerBase.

Definition at line 71 of file AampRDKCCManager.cpp.

SetDigitalChannel()

AampRDKCCManager::SetDigitalChannel ( unsigned int  id )

overrideprivatevirtual

set digital channel with specified id

Returns

CC_VL_OS_API_RESULT

Implements AampCCManagerBase.

Definition at line 101 of file AampRDKCCManager.cpp.

SetAnalogChannel()

AampRDKCCManager::SetAnalogChannel ( unsigned int  id )

overrideprivatevirtual

set analog channel with specified id

Returns

CC_VL_OS_API_RESULT

Implements AampCCManagerBase.

Definition at line 109 of file AampRDKCCManager.cpp.

CheckCCHandle()

bool AampRDKCCManager::CheckCCHandle ( ) const

inlineoverrideprivatevirtual

validate mCCHandle

Returns

bool

Reimplemented from AampCCManagerBase.

Definition at line 102 of file AampRDKCCManager.h.

Field Documentation

mCCHandle

void* AampRDKCCManager::mCCHandle {nullptr}

private

Decoder handle for intializing CC resources

Definition at line 105 of file AampRDKCCManager.h.

---

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

• components/generic/aamp/closedcaptions/rdk/AampRDKCCManager.h
• components/generic/aamp/closedcaptions/rdk/AampRDKCCManager.cpp