Handles closed caption operations. More...

#include <AampCCManager.h>

Inheritance diagram for AampCCManagerBase:

Collaboration diagram for AampCCManagerBase:

Public Member Functions
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...

virtual void	Release (int iID)=0
	Release CC resources. 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...

Protected Member Functions
virtual void	StartRendering ()=0
	To start CC rendering. More...

virtual void	StopRendering ()=0
	To stop CC rendering. More...

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...

virtual int	Initialize (void *handle)
	Impl specific initialization code called once in Init() function. More...

virtual int	SetDigitalChannel (unsigned int id)=0
	set digital channel with specified id More...

virtual int	SetAnalogChannel (unsigned int id)=0
	set analog channel with specified id More...

virtual bool	CheckCCHandle () const
	validate mCCHandle More...

void	Start ()
	To start CC rendering. More...

void	Stop ()
	To stop CC rendering. More...

Protected Attributes
std::string	mOptions {}

std::string	mTrack {}

std::vector< TextTrackInfo >	mLastTextTracks {}

bool	mEnabled {false}

bool	mTrickplayStarted {false}

bool	mParentalCtrlLocked {false}

AampLogManager *	mLogObj {NULL}

yes

Handles closed caption operations.

Definition at line 51 of file AampCCManager.h.

Member Function Documentation

◆ Init()

AampCCManagerBase::Init ( void * handle )

Initialize CC resource.

Parameters

[in] handle - decoder handle

Returns: int - 0 on sucess, -1 on failure

Definition at line 578 of file AampCCManager.cpp.

◆ GetId()

virtual int AampCCManagerBase::GetId ( )

inlinevirtual

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 in AampSubtecCCManager.

Definition at line 66 of file AampCCManager.h.

◆ Release()

virtual void AampCCManagerBase::Release ( int iID )

pure virtual

Release CC resources.

Parameters

[in] id - returned from GetId function

Implemented in AampSubtecCCManager, and AampRDKCCManager.

◆ SetStatus()

AampCCManagerBase::SetStatus ( bool enable )

Enable/disable CC rendering.

Parameters

[in] enable - true to enable CC rendering

Returns: int - 0 on success, -1 on failure

Definition at line 755 of file AampCCManager.cpp.

◆ GetStatus()

bool AampCCManagerBase::GetStatus ( )

inline

Get CC rendering status.

Returns: bool - true if enabled, false otherwise

Definition at line 87 of file AampCCManager.h.

◆ GetTrack()

const std::string& AampCCManagerBase::GetTrack ( )

inline

Get current CC track.

Returns: std::string - current CC track

Definition at line 94 of file AampCCManager.h.

◆ SetTrack()

AampCCManagerBase::SetTrack	(	const std::string &	track,
		const CCFormat	format = `eCLOSEDCAPTION_FORMAT_DEFAULT`
	)

Set CC track.

Parameters

[in]	track	- CC track to be selected
[in]	format	- force track to 608/708 or default

Returns: int - 0 on success, -1 on failure

Definition at line 651 of file AampCCManager.cpp.

◆ SetStyle()

AampCCManagerBase::SetStyle ( const std::string & options )

Set CC styles for rendering.

Parameters

[in] options - rendering style options

Returns: int - 0 on success, -1 on failure

Definition at line 400 of file AampCCManager.cpp.

◆ GetStyle()

const std::string& AampCCManagerBase::GetStyle ( )

inline

Get current CC styles.

Returns: std::string - current CC options

Definition at line 119 of file AampCCManager.h.

◆ SetTrickplayStatus()

AampCCManagerBase::SetTrickplayStatus ( bool enable )

To enable/disable CC when trickplay starts/ends.

Parameters

[in] enable - true when trickplay starts, false otherwise

Returns: void

Definition at line 609 of file AampCCManager.cpp.

◆ SetParentalControlStatus()

AampCCManagerBase::SetParentalControlStatus ( bool locked )

To enable/disable CC when parental control locked/unlocked.

Parameters

[in] locked - true when parental control lock enabled, false otherwise

Returns: void

Definition at line 628 of file AampCCManager.cpp.

◆ RestoreCC()

AampCCManagerBase::RestoreCC ( )

To restore cc state after new tune.

Returns: void

Definition at line 744 of file AampCCManager.cpp.

◆ updateLastTextTracks()

void AampCCManagerBase::updateLastTextTracks ( const std::vector< TextTrackInfo > & newTextTracks )

inline

update stored list of text tracks

Parameters

[in] newTextTracks - list of text tracks to store

Returns: void

Definition at line 152 of file AampCCManager.h.

◆ getLastTextTracks()

const std::vector<TextTrackInfo>& AampCCManagerBase::getLastTextTracks ( ) const

inline

Get list of text tracks.

Returns: const std::vector<TextTrackInfo>& - list of text tracks

Definition at line 159 of file AampCCManager.h.

◆ IsOOBCCRenderingSupported()

bool AampCCManagerBase::IsOOBCCRenderingSupported ( )

To check whether Out of Band Closed caption/Subtile rendering supported or not.

To check whether Out of Band Closed caption/subtitle rendering supported or not.

Returns: bool, True if Out of Band Closed caption/subtitle rendering supported

Definition at line 781 of file AampCCManager.cpp.

◆ StartRendering()

virtual void AampCCManagerBase::StartRendering ( )

protectedpure virtual

To start CC rendering.

Returns: void

Implemented in AampSubtecCCManager, and AampRDKCCManager.

◆ StopRendering()

virtual void AampCCManagerBase::StopRendering ( )

protectedpure virtual

To stop CC rendering.

Returns: void

Implemented in AampSubtecCCManager, and AampRDKCCManager.

◆ EnsureInitialized()

virtual void AampCCManagerBase::EnsureInitialized ( )

inlineprotectedvirtual

Impl specific initialization code called before each public interface call.

Returns: void

Reimplemented in AampSubtecCCManager.

Definition at line 189 of file AampCCManager.h.

◆ EnsureHALInitialized()

virtual void AampCCManagerBase::EnsureHALInitialized ( )

inlineprotectedvirtual

Impl specific initialization code for HAL.

Returns: void

Reimplemented in AampSubtecCCManager.

Definition at line 195 of file AampCCManager.h.

◆ EnsureRendererCommsInitialized()

virtual void AampCCManagerBase::EnsureRendererCommsInitialized ( )

inlineprotectedvirtual

Impl specific initialization code for Communication with renderer.

Returns: void

Reimplemented in AampSubtecCCManager.

Definition at line 201 of file AampCCManager.h.

◆ Initialize()

virtual int AampCCManagerBase::Initialize ( void * handle )

inlineprotectedvirtual

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

Returns: 0 - success, -1 - failure

Reimplemented in AampRDKCCManager.

Definition at line 208 of file AampCCManager.h.

◆ SetDigitalChannel()

virtual int AampCCManagerBase::SetDigitalChannel ( unsigned int id )

protectedpure virtual

set digital channel with specified id

Returns: CC_VL_OS_API_RESULT

Implemented in AampSubtecCCManager, and AampRDKCCManager.

◆ SetAnalogChannel()

virtual int AampCCManagerBase::SetAnalogChannel ( unsigned int id )

protectedpure virtual

set analog channel with specified id

Returns: CC_VL_OS_API_RESULT

Implemented in AampSubtecCCManager, and AampRDKCCManager.

◆ CheckCCHandle()

virtual bool AampCCManagerBase::CheckCCHandle ( ) const

inlineprotectedvirtual

validate mCCHandle

Returns: bool

Reimplemented in AampRDKCCManager.

Definition at line 229 of file AampCCManager.h.

◆ Start()

AampCCManagerBase::Start ( )

protected

To start CC rendering.

Returns: void

Definition at line 568 of file AampCCManager.cpp.

◆ Stop()

AampCCManagerBase::Stop ( )

protected

To stop CC rendering.

Returns: void

Definition at line 558 of file AampCCManager.cpp.

Field Documentation

◆ mOptions

std::string AampCCManagerBase::mOptions {}

protected

CC rendering styles

Definition at line 246 of file AampCCManager.h.

◆ mTrack

std::string AampCCManagerBase::mTrack {}

protected

CC track

Definition at line 247 of file AampCCManager.h.

◆ mEnabled

bool AampCCManagerBase::mEnabled {false}

protected

true if CC rendering enabled, false otherwise

Definition at line 249 of file AampCCManager.h.

◆ mTrickplayStarted

bool AampCCManagerBase::mTrickplayStarted {false}

protected

If a trickplay is going on or not

Definition at line 250 of file AampCCManager.h.

◆ mParentalCtrlLocked

bool AampCCManagerBase::mParentalCtrlLocked {false}

protected

If Parental Control lock enabled on not

Definition at line 251 of file AampCCManager.h.

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

components/generic/aamp/closedcaptions/AampCCManager.h
components/generic/aamp/closedcaptions/AampCCManager.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

yes

Member Function Documentation

◆ Init()

◆ GetId()

◆ Release()

◆ SetStatus()

◆ GetStatus()

◆ GetTrack()

◆ SetTrack()

◆ SetStyle()

◆ GetStyle()

◆ SetTrickplayStatus()

◆ SetParentalControlStatus()

◆ RestoreCC()

◆ updateLastTextTracks()

◆ getLastTextTracks()

◆ IsOOBCCRenderingSupported()

◆ StartRendering()

◆ StopRendering()

◆ EnsureInitialized()

◆ EnsureHALInitialized()

◆ EnsureRendererCommsInitialized()

◆ Initialize()

◆ SetDigitalChannel()

◆ SetAnalogChannel()

◆ CheckCCHandle()

◆ Start()

◆ Stop()

Field Documentation

◆ mOptions

◆ mTrack

◆ mEnabled

◆ mTrickplayStarted

◆ mParentalCtrlLocked