#include <AampLogManager.h>

Collaboration diagram for AampLogManager:

Public Member Functions
	AampLogManager ()
	AampLogManager constructor.

void	LogNetworkLatency (const char *url, int downloadTime, int downloadThresholdTimeoutMs, MediaType type)
	Print the network latency level logging for triage purpose. More...

void	LogNetworkError (const char *url, AAMPNetworkErrorType errorType, int errorCode, MediaType type)
	Print the network error level logging for triage purpose. More...

void	ParseContentUrl (const char *url, std::string &contentType, std::string &location, std::string &symptom, MediaType type)
	To get the issue symptom based on the error type for triage purpose. More...

void	LogDRMError (int major, int minor)
	Print the DRM error level logging for triage purpose. More...

void	LogABRInfo (AAMPAbrInfo *pstAbrInfo)
	Log ABR info for triage purpose. More...

bool	isLogLevelAllowed (AAMP_LogLevel chkLevel)
	To check the given log level is allowed to print mechanism. More...

void	setPlayerId (int playerId)
	Set PlayerId. More...

int	getPlayerId ()
	Get PlayerId. More...

void	setLogLevel (AAMP_LogLevel newLevel)
	Set the log level for print mechanism. More...

void	setLogAndCfgDirectory (char driveName)
	Set log file and cfg directory index.

bool	isLogworthyErrorCode (int errorCode)
	Check curl error before log on console. More...

const char *	getAampCfgPath (void)
	Get aamp cfg directory.

const char *	getAampCliCfgPath (void)
	Get aampcli cfg directory.

Static Public Member Functions
static std::string	getHexDebugStr (const std::vector< uint8_t > &data)
	Get a hex string representation of a vector of bytes.

Data Fields
bool	info

bool	debug

bool	trace

bool	gst

bool	curl

bool	progress

bool	failover

bool	stream

bool	curlHeader

bool	curlLicense

bool	logMetadata

bool	id3

int	mPlayerId

Static Public Attributes
static bool	disableLogRedirection = false

Private Attributes
AAMP_LogLevel	aampLoglevel

yes

AampLogManager Class.

Definition at line 150 of file AampLogManager.h.

Member Function Documentation

◆ LogNetworkLatency()

void AampLogManager::LogNetworkLatency	(	const char *	url,
		int	downloadTime,
		int	downloadThresholdTimeoutMs,
		MediaType	type
	)

Print the network latency level logging for triage purpose.

Parameters

[in]	url	- content url
[in]	downloadTime	- download time of the fragment or manifest
[in]	downloadThresholdTimeoutMs	- specified download threshold time out value
[in]	type	- media type

Returns: void

Definition at line 105 of file aamplogging.cpp.

◆ LogNetworkError()

void AampLogManager::LogNetworkError	(	const char *	url,
		AAMPNetworkErrorType	errorType,
		int	errorCode,
		MediaType	type
	)

Print the network error level logging for triage purpose.

Parameters

[in]	url	- content url
[in]	errorType	- it can be http or curl errors
[in]	errorCode	- it can be http error or curl error code
[in]	type	- media type

Returns: void

Definition at line 120 of file aamplogging.cpp.

◆ ParseContentUrl()

AampLogManager::ParseContentUrl	(	const char *	url,
		std::string &	contentType,
		std::string &	location,
		std::string &	symptom,
		MediaType	type
	)

To get the issue symptom based on the error type for triage purpose.

Parameters

[in]	url	- content url
[out]	contentType	- it could be a manifest or other audio/video/iframe tracks
[out]	location	- server location
[out]	symptom	- issue exhibiting scenario for error case
[in]	type	- media type

Returns: void

Definition at line 169 of file aamplogging.cpp.

◆ LogDRMError()

AampLogManager::LogDRMError	(	int	major,
		int	minor
	)

Print the DRM error level logging for triage purpose.

Parameters

[in]	major	- drm major error code
[in]	minor	- drm minor error code

Returns: void

Definition at line 267 of file aamplogging.cpp.

◆ LogABRInfo()

AampLogManager::LogABRInfo ( AAMPAbrInfo * pstAbrInfo )

Log ABR info for triage purpose.

Parameters

[in] pstAbrInfo - pointer to a structure which will have abr info to be logged

Returns: void

Definition at line 355 of file aamplogging.cpp.

◆ isLogLevelAllowed()

bool AampLogManager::isLogLevelAllowed ( AAMP_LogLevel chkLevel )

To check the given log level is allowed to print mechanism.

Parameters

[in] chkLevel - log level

Return values

true	if the log level allowed for print mechanism

Definition at line 50 of file aamplogging.cpp.

◆ setPlayerId()

void AampLogManager::setPlayerId ( int playerId )

inline

Set PlayerId.

Parameters

[in] playerId - Aamp Player Id

Returns: void

Definition at line 243 of file AampLogManager.h.

◆ getPlayerId()

int AampLogManager::getPlayerId ( )

inline

Get PlayerId.

Returns: int - playerId

Definition at line 249 of file AampLogManager.h.

◆ setLogLevel()

void AampLogManager::setLogLevel ( AAMP_LogLevel newLevel )

Set the log level for print mechanism.

Parameters

[in] newLevel - log level new value

Returns: void

Definition at line 58 of file aamplogging.cpp.

◆ isLogworthyErrorCode()

bool AampLogManager::isLogworthyErrorCode ( int errorCode )

Check curl error before log on console.

Parameters

[in] errorCode - curl error

Returns: true if it is not a curl error 23 and 42, bcasue those are not a real network errors.

Definition at line 417 of file aamplogging.cpp.

Field Documentation

◆ info

bool AampLogManager::info

Info level

Definition at line 154 of file AampLogManager.h.

◆ debug

bool AampLogManager::debug

Debug logs

Definition at line 155 of file AampLogManager.h.

◆ trace

bool AampLogManager::trace

Trace level

Definition at line 156 of file AampLogManager.h.

◆ gst

bool AampLogManager::gst

Gstreamer logs

Definition at line 157 of file AampLogManager.h.

◆ curl

bool AampLogManager::curl

Curl logs

Definition at line 158 of file AampLogManager.h.

◆ progress

bool AampLogManager::progress

Download progress logs

Definition at line 159 of file AampLogManager.h.

◆ failover

bool AampLogManager::failover

server fail over logs

Definition at line 160 of file AampLogManager.h.

◆ stream

bool AampLogManager::stream

Display stream contents

Definition at line 161 of file AampLogManager.h.

◆ curlHeader

bool AampLogManager::curlHeader

Curl header logs

Definition at line 162 of file AampLogManager.h.

◆ curlLicense

bool AampLogManager::curlLicense

Curl logs for License request

Definition at line 163 of file AampLogManager.h.

◆ logMetadata

bool AampLogManager::logMetadata

Timed metadata logs

Definition at line 164 of file AampLogManager.h.

◆ id3

bool AampLogManager::id3

Display ID3 tag from stream logs

Definition at line 165 of file AampLogManager.h.

◆ mPlayerId

int AampLogManager::mPlayerId

Store PlayerId

Definition at line 167 of file AampLogManager.h.

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

components/generic/aamp/AampLogManager.h
components/generic/aamp/aamplogging.cpp
components/generic/aamp/test/Drm/mocks/aampMocks.cpp
components/generic/aamp/test/utests/fakes/FakeAampLogManager.cpp

Public Member Functions

Static Public Member Functions

Data Fields

Static Public Attributes

Private Attributes

yes

Member Function Documentation

◆ LogNetworkLatency()

◆ LogNetworkError()

◆ ParseContentUrl()

◆ LogDRMError()

◆ LogABRInfo()

◆ isLogLevelAllowed()

◆ setPlayerId()

◆ getPlayerId()

◆ setLogLevel()

◆ isLogworthyErrorCode()

Field Documentation

◆ info

◆ debug

◆ trace

◆ gst

◆ curl

◆ progress

◆ failover

◆ stream

◆ curlHeader

◆ curlLicense

◆ logMetadata

◆ id3

◆ mPlayerId