RDK Documentation (Open Sourced RDK Components)
Public Member Functions | Private Member Functions | Private Attributes
AampSubtecCCManager Class Reference

Handling Subtec CC operation. More...

#include <AampSubtecCCManager.h>

Inheritance diagram for AampSubtecCCManager:
Inheritance graph
Collaboration diagram for AampSubtecCCManager:
Collaboration graph

Public Member Functions

void Release (int iID) override
 Release CC resources. 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...
 
 AampSubtecCCManager ()
 Constructor.
 
 ~AampSubtecCCManager ()=default
 Destructor.
 
 AampSubtecCCManager (const AampSubtecCCManager &)=delete
 
AampSubtecCCManager & operator= (const AampSubtecCCManager &)=delete
 
- Public Member Functions inherited from AampCCManagerBase
int Init (void *handle)
 Initialize CC resource. 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...
 
void EnsureInitialized () override
 Impl specific initialization code called before each public interface call. More...
 
void EnsureHALInitialized () override
 Impl specific initialization code for HAL. More...
 
void EnsureRendererCommsInitialized () override
 Impl specific initialization code for Communication with rendered. 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...
 
void EnsureRendererStateConsistency ()
 ensure mRendering is consistent with renderer state More...
 

Private Attributes

bool mRendererInitialized {false}
 
bool mHALInitialized {false}
 
std::mutex mIdLock
 
int mId {0}
 
std::set< int > mIdSet
 

Additional Inherited Members

- Protected Member Functions inherited from AampCCManagerBase
virtual int Initialize (void *handle)
 Impl specific initialization code called once in Init() function. More...
 
virtual bool CheckCCHandle () const
 validate mCCHandle 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 Subtec CC operation.

Definition at line 43 of file AampSubtecCCManager.h.

Member Function Documentation

◆ Release()

AampSubtecCCManager::Release ( int  iID)
overridevirtual

Release CC resources.

Parameters
[in]id- returned from GetId function

Implements AampCCManagerBase.

Definition at line 95 of file AampSubtecCCManager.cpp.

◆ GetId()

AampSubtecCCManager::GetId ( )
virtual

Gets Handle or ID, Every client using subtec must call GetId in the begining , save id, which is required for Release funciton.

Returns
int - unique ID

Reimplemented from AampCCManagerBase.

Definition at line 84 of file AampSubtecCCManager.cpp.

◆ StartRendering()

AampSubtecCCManager::StartRendering ( )
overrideprivatevirtual

To start CC rendering.

Returns
void

Implements AampCCManagerBase.

Definition at line 124 of file AampSubtecCCManager.cpp.

◆ StopRendering()

AampSubtecCCManager::StopRendering ( )
overrideprivatevirtual

To stop CC rendering.

Returns
void

Implements AampCCManagerBase.

Definition at line 132 of file AampSubtecCCManager.cpp.

◆ EnsureInitialized()

AampSubtecCCManager::EnsureInitialized ( )
overrideprivatevirtual

Impl specific initialization code called before each public interface call.

Returns
void

Reimplemented from AampCCManagerBase.

Definition at line 37 of file AampSubtecCCManager.cpp.

◆ EnsureHALInitialized()

AampSubtecCCManager::EnsureHALInitialized ( )
overrideprivatevirtual

Impl specific initialization code for HAL.

Returns
void

Reimplemented from AampCCManagerBase.

Definition at line 46 of file AampSubtecCCManager.cpp.

◆ EnsureRendererCommsInitialized()

AampSubtecCCManager::EnsureRendererCommsInitialized ( )
overrideprivatevirtual

Impl specific initialization code for Communication with rendered.

Returns
void

Reimplemented from AampCCManagerBase.

Definition at line 65 of file AampSubtecCCManager.cpp.

◆ SetDigitalChannel()

AampSubtecCCManager::SetDigitalChannel ( unsigned int  id)
overrideprivatevirtual

set digital channel with specified id

Returns
CC_VL_OS_API_RESULT

Implements AampCCManagerBase.

Definition at line 140 of file AampSubtecCCManager.cpp.

◆ SetAnalogChannel()

AampSubtecCCManager::SetAnalogChannel ( unsigned int  id)
overrideprivatevirtual

set analog channel with specified id

Returns
CC_VL_OS_API_RESULT

Implements AampCCManagerBase.

Definition at line 150 of file AampSubtecCCManager.cpp.

◆ EnsureRendererStateConsistency()

AampSubtecCCManager::EnsureRendererStateConsistency ( )
private

ensure mRendering is consistent with renderer state

Returns
void

Definition at line 160 of file AampSubtecCCManager.cpp.

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