RDK Documentation (Open Sourced RDK Components)
MediaErrorEvent Class Reference

Class for the Media Error event. More...

#include <AampEvent.h>

Inheritance diagram for MediaErrorEvent:
Inheritance graph
Collaboration diagram for MediaErrorEvent:
Collaboration graph

Public Member Functions

 MediaErrorEvent ()=delete
 
 MediaErrorEvent (const MediaErrorEvent &)=delete
 
MediaErrorEventoperator= (const MediaErrorEvent &)=delete
 
 MediaErrorEvent (AAMPTuneFailure failure, int code, const std::string &desc, bool shouldRetry, int32_t classCode, int32_t reason, int32_t businessStatus)
 
virtual ~MediaErrorEvent ()
 MediaErrorEvent Destructor.
 
AAMPTuneFailure getFailure () const
 Get Failure Type. More...
 
int getCode () const
 Get Error Code. More...
 
const std::string & getDescription () const
 Get Description. More...
 
bool shouldRetry () const
 Retry or not. More...
 
int32_t getClass () const
 
int32_t getReason () const
 
int32_t getBusinessStatus () const
 
- Public Member Functions inherited from AAMPEventObject
 AAMPEventObject (const AAMPEventObject &)=delete
 Copy constructor disabled. More...
 
AAMPEventObjectoperator= (const AAMPEventObject &)=delete
 assignment operator disabled More...
 
 AAMPEventObject (AAMPEventType type)
 AAMPEventObject Constructor.
 
virtual ~AAMPEventObject ()
 AAMPEvent Destructor.
 
AAMPEventType getType () const
 Get Event Type. More...
 

Private Attributes

AAMPTuneFailure mFailure
 
int mCode
 
std::string mDescription
 
bool mShouldRetry
 
int32_t mSecManagerClass
 
int32_t mSecManagerReasonCode
 
int32_t mBusinessStatus
 

yes

Class for the Media Error event.

Definition at line 534 of file AampEvent.h.

Constructor & Destructor Documentation

◆ MediaErrorEvent()

MediaErrorEvent::MediaErrorEvent ( )
delete
Parameters
[in]failure- Failure type
[in]code- Error code
[in]desc- Error description
[in]shouldRetry- Retry or not

Member Function Documentation

◆ getFailure()

MediaErrorEvent::getFailure ( ) const

Get Failure Type.

Returns
Tune failure type

Definition at line 134 of file AampEvent.cpp.

◆ getCode()

MediaErrorEvent::getCode ( ) const

Get Error Code.

Returns
Tune error code

Definition at line 144 of file AampEvent.cpp.

◆ getDescription()

const std::string & MediaErrorEvent::getDescription ( ) const

Get Description.

Returns
Error description

Definition at line 154 of file AampEvent.cpp.

◆ shouldRetry()

MediaErrorEvent::shouldRetry ( ) const

Retry or not.

Returns
Retry or don't retry

Definition at line 164 of file AampEvent.cpp.

Field Documentation

◆ mFailure

AAMPTuneFailure MediaErrorEvent::mFailure
private

Error Type

Definition at line 536 of file AampEvent.h.

◆ mCode

int MediaErrorEvent::mCode
private

Error code

Definition at line 537 of file AampEvent.h.

◆ mDescription

std::string MediaErrorEvent::mDescription
private

Error description

Definition at line 538 of file AampEvent.h.

◆ mShouldRetry

bool MediaErrorEvent::mShouldRetry
private

If recovery on retry is possible

Definition at line 539 of file AampEvent.h.

◆ mSecManagerClass

int32_t MediaErrorEvent::mSecManagerClass
private

Secmanager error class

Definition at line 541 of file AampEvent.h.

◆ mSecManagerReasonCode

int32_t MediaErrorEvent::mSecManagerReasonCode
private

Secmanager reason code

Definition at line 542 of file AampEvent.h.

◆ mBusinessStatus

int32_t MediaErrorEvent::mBusinessStatus
private

secclient business reason code

Definition at line 543 of file AampEvent.h.


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