RDK Documentation (Open Sourced RDK Components)
main_aamp.h File Reference

Types and APIs exposed by the AAMP player. More...

#include <memory>
#include <functional>
#include <vector>
#include <string>
#include <string.h>
#include <mutex>
#include <stddef.h>
#include "Accessibility.hpp"
#include "AampEvent.h"
#include "AampEventListener.h"
#include "AampDrmSystems.h"
#include "AampMediaType.h"
#include "AampScheduler.h"
#include "AampConfig.h"
Include dependency graph for main_aamp.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  TuneFailureMap
 Structure holding aamp tune failure code and corresponding application error code and description. More...
 
struct  PreCacheUrlData
 Pre cache the data information. More...
 
struct  AudioTrackInfo
 Structure for audio track information Holds information about an audio track in playlist. More...
 
struct  TextTrackInfo
 Structure for text track information Holds information about a text track in playlist. More...
 
class  StreamSink
 GStreamer Abstraction class for the implementation of AAMPGstPlayer and gstaamp plugin. More...
 
class  PlayerInstanceAAMP
 Player interface class for the JS pluggin. More...
 

Typedefs

using AdObject = std::pair< std::string, std::string >
 
typedef struct PreCacheUrlData PreCacheUrlStruct
 
typedef std::vector< PreCacheUrlStructPreCacheUrlList
 

Enumerations

enum  AAMPAnomalyMessageType
 AAMP anomaly message types. More...
 
enum  MediaTypeTelemetry
 Media types for telemetry. More...
 
enum  StreamOutputFormat
 Media output format. More...
 
enum  VideoZoomMode
 Video zoom mode. More...
 
enum  AuthTokenErrors
 Auth Token Failure codes. More...
 
enum  LangCodePreference
 Language Code Preference types.
 

yes

Types and APIs exposed by the AAMP player.

Definition in file main_aamp.h.


Data Structure Documentation

◆ TuneFailureMap

struct TuneFailureMap

Structure holding aamp tune failure code and corresponding application error code and description.

Definition at line 80 of file main_aamp.h.

Collaboration diagram for TuneFailureMap:
Collaboration graph
Data Fields
AAMPTuneFailure tuneFailure

Failure ID

int code

Error code

const char * description

Textual description

Enumeration Type Documentation

◆ AAMPAnomalyMessageType

AAMP anomaly message types.

Enumerator
ANOMALY_ERROR 

Error Message

ANOMALY_WARNING 

Warning Message

ANOMALY_TRACE 

Trace Message

Definition at line 69 of file main_aamp.h.

◆ MediaTypeTelemetry

Media types for telemetry.

Enumerator
eMEDIATYPE_TELEMETRY_AVS 

Type audio, video or subtitle

eMEDIATYPE_TELEMETRY_DRM 

Type DRM license

eMEDIATYPE_TELEMETRY_INIT 

Type audio or video init fragment

eMEDIATYPE_TELEMETRY_MANIFEST 

Type main or sub manifest file

eMEDIATYPE_TELEMETRY_UNKNOWN 

Type unknown

Definition at line 92 of file main_aamp.h.

◆ StreamOutputFormat

Media output format.

Enumerator
FORMAT_INVALID 

Invalid format

FORMAT_MPEGTS 

MPEG Transport Stream

FORMAT_ISO_BMFF 

ISO Base Media File format

FORMAT_AUDIO_ES_AAC 

AAC Audio Elementary Stream

FORMAT_AUDIO_ES_AC3 

AC3 Audio Elementary Stream

FORMAT_AUDIO_ES_EC3 

Dolby Digital Plus Elementary Stream

FORMAT_AUDIO_ES_ATMOS 

ATMOS Audio stream

FORMAT_AUDIO_ES_AC4 

AC4 Dolby Audio stream

FORMAT_VIDEO_ES_H264 

MPEG-4 Video Elementary Stream

FORMAT_VIDEO_ES_HEVC 

HEVC video elementary stream

FORMAT_VIDEO_ES_MPEG2 

MPEG-2 Video Elementary Stream

FORMAT_SUBTITLE_WEBVTT 

WebVTT subtitle Stream

FORMAT_SUBTITLE_TTML 

WebVTT subtitle Stream

FORMAT_SUBTITLE_MP4 

Generic MP4 stream

FORMAT_UNKNOWN 

Unknown Format

Definition at line 106 of file main_aamp.h.

◆ VideoZoomMode

Video zoom mode.

Enumerator
VIDEO_ZOOM_FULL 

Video Zoom Enabled

VIDEO_ZOOM_NONE 

Video Zoom Disabled

Definition at line 129 of file main_aamp.h.

◆ AuthTokenErrors

Auth Token Failure codes.

Enumerator
eAUTHTOKEN_TOKEN_PARSE_ERROR 

Auth token parse Error

eAUTHTOKEN_INVALID_STATUS_CODE 

Auth token Invalid status

Definition at line 142 of file main_aamp.h.