RDK Documentation (Open Sourced RDK Components)
ProgressEvent Class Reference

Class for the Progress event. More...

#include <AampEvent.h>

Inheritance diagram for ProgressEvent:
Inheritance graph
Collaboration diagram for ProgressEvent:
Collaboration graph

Public Member Functions

 ProgressEvent ()=delete
 
 ProgressEvent (const ProgressEvent &)=delete
 
ProgressEventoperator= (const ProgressEvent &)=delete
 
 ProgressEvent (double duration, double position, double start, double end, float speed, long long pts, double bufferedDuration, std::string seiTimecode)
 ProgressEvent Constructor. More...
 
virtual ~ProgressEvent ()
 ProgressEvent Destructor.
 
double getDuration () const
 Get Duration of Asset. More...
 
double getPosition () const
 Get Current Position. More...
 
double getStart () const
 Get Start Position. More...
 
double getEnd () const
 Get End Position. More...
 
float getSpeed () const
 Get Speed. More...
 
long long getPTS () const
 Get Video PTS. More...
 
double getBufferedDuration () const
 Get Buffered Duration. More...
 
const char * getSEITimeCode () const
 Get SEI Time Code information. More...
 
- 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

double mDuration
 
double mPosition
 
double mStart
 
double mEnd
 
float mSpeed
 
long long mPTS
 
double mBufferedDuration
 
std::string mSEITimecode
 

yes

Class for the Progress event.

Definition at line 636 of file AampEvent.h.

Constructor & Destructor Documentation

◆ ProgressEvent() [1/2]

ProgressEvent::ProgressEvent ( )
delete
Parameters
[in]duration- Duration of Asset
[in]position- Current Position
[in]start- Start Position
[in]end- End Position
[in]speed- Current Speed
[in]pts- Video PTS
[in]bufferedDuration- buffered duration

◆ ProgressEvent() [2/2]

ProgressEvent::ProgressEvent ( double  duration,
double  position,
double  start,
double  end,
float  speed,
long long  pts,
double  bufferedDuration,
std::string  seiTimecode 
)

ProgressEvent Constructor.

Definition at line 215 of file AampEvent.cpp.

Member Function Documentation

◆ getDuration()

ProgressEvent::getDuration ( ) const

Get Duration of Asset.

Returns
Asset duration in MS

Definition at line 230 of file AampEvent.cpp.

◆ getPosition()

ProgressEvent::getPosition ( ) const

Get Current Position.

Returns
Current position in MS

Definition at line 240 of file AampEvent.cpp.

◆ getStart()

ProgressEvent::getStart ( ) const

Get Start Position.

Returns
Start position in MS

Definition at line 250 of file AampEvent.cpp.

◆ getEnd()

ProgressEvent::getEnd ( ) const

Get End Position.

Returns
End position in MS

Definition at line 260 of file AampEvent.cpp.

◆ getSpeed()

ProgressEvent::getSpeed ( ) const

Get Speed.

Returns
Current speed

Definition at line 270 of file AampEvent.cpp.

◆ getPTS()

ProgressEvent::getPTS ( ) const

Get Video PTS.

Returns
Video PTS

Definition at line 280 of file AampEvent.cpp.

◆ getBufferedDuration()

ProgressEvent::getBufferedDuration ( ) const

Get Buffered Duration.

Returns
Buffered duration

Definition at line 290 of file AampEvent.cpp.

◆ getSEITimeCode()

ProgressEvent::getSEITimeCode ( ) const

Get SEI Time Code information.

Returns
SEI Time Code

Definition at line 300 of file AampEvent.cpp.

Field Documentation

◆ mDuration

double ProgressEvent::mDuration
private

current size of time shift buffer in MS

Definition at line 638 of file AampEvent.h.

◆ mPosition

double ProgressEvent::mPosition
private

current play/pause position relative to tune time - starts at zero) in MS

Definition at line 639 of file AampEvent.h.

◆ mStart

double ProgressEvent::mStart
private

time shift buffer start position (relative to tune time - starts at zero) in MS

Definition at line 640 of file AampEvent.h.

◆ mEnd

double ProgressEvent::mEnd
private

time shift buffer end position (relative to tune time - starts at zero) in MS

Definition at line 641 of file AampEvent.h.

◆ mSpeed

float ProgressEvent::mSpeed
private

current trick speed (1.0 for normal play rate)

Definition at line 642 of file AampEvent.h.

◆ mPTS

long long ProgressEvent::mPTS
private

Video Presentation 90 Khz time-stamp

Definition at line 643 of file AampEvent.h.

◆ mBufferedDuration

double ProgressEvent::mBufferedDuration
private

current duration of buffered video ready to playback

Definition at line 644 of file AampEvent.h.

◆ mSEITimecode

std::string ProgressEvent::mSEITimecode
private

SEI Timecode information

Definition at line 645 of file AampEvent.h.


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