RDK Documentation (Open Sourced RDK Components)
BitrateChangeEvent Class Reference

Class for the Bitrate change event. More...

#include <AampEvent.h>

Inheritance diagram for BitrateChangeEvent:
Inheritance graph
Collaboration diagram for BitrateChangeEvent:
Collaboration graph

Public Member Functions

 BitrateChangeEvent ()=delete
 
 BitrateChangeEvent (const BitrateChangeEvent &)=delete
 
BitrateChangeEventoperator= (const BitrateChangeEvent &)=delete
 
 BitrateChangeEvent (int time, long bitrate, const std::string &desc, int width, int height, double frameRate, double position, bool mCappedProfile, int mDisplayWidth, int mDisplayHeight, VideoScanType videoScanType, int aspectRatioWidth, int aspectRatioHeight)
 BitrateChangeEvent Constructor.
 
virtual ~BitrateChangeEvent ()
 BitrateChangeEvent Destructor.
 
int getTime () const
 Get Time. More...
 
long getBitrate () const
 Get Bitrate. More...
 
const std::string & getDescription () const
 Get Description. More...
 
int getWidth () const
 Get Width. More...
 
int getHeight () const
 Get Height. More...
 
double getFrameRate () const
 Get Frame Rate. More...
 
double getPosition () const
 Get Position. More...
 
bool getCappedProfileStatus () const
 Get Capped Profile status. More...
 
int getDisplayWidth () const
 Get display width. More...
 
int getDisplayHeight () const
 Get output tv display Height. More...
 
VideoScanType getScanType () const
 Get Video Scan Type. More...
 
int getAspectRatioWidth () const
 Get Aspect Ratio Width. More...
 
int getAspectRatioHeight () const
 Get Aspect Ratio Height. 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

int mTime
 
long mBitrate
 
std::string mDescription
 
int mWidth
 
int mHeight
 
double mFrameRate
 
double mPosition
 
bool mCappedProfile
 
int mDisplayWidth
 
int mDisplayHeight
 
VideoScanType mVideoScanType
 
int mAspectRatioWidth
 
int mAspectRatioHeight
 

yes

Class for the Bitrate change event.

Definition at line 1021 of file AampEvent.h.

Constructor & Destructor Documentation

◆ BitrateChangeEvent()

BitrateChangeEvent::BitrateChangeEvent ( )
delete
Parameters
[in]time- Time of bitrate change
[in]bitrate- New bitrate
[in]desc- Reason of change
[in]width- Video width
[in]height- Video height
[in]frameRate- Framerate
[in]position- Position
[in]cappedProfile- Profile capping status
[in]displayWidth- Output tv display width
[in]displayHeight- Output tv dispay height
[in]videoScanType- Video Scan Type
[in]position- Aspect Ratio Width
[in]position- Aspect Ratio Height

Member Function Documentation

◆ getTime()

BitrateChangeEvent::getTime ( ) const

Get Time.

Returns
Playback time

Definition at line 539 of file AampEvent.cpp.

◆ getBitrate()

BitrateChangeEvent::getBitrate ( ) const

Get Bitrate.

Returns
Current bitrate

Definition at line 549 of file AampEvent.cpp.

◆ getDescription()

BitrateChangeEvent::getDescription ( ) const

Get Description.

Returns
Reason of bitrate change

Definition at line 559 of file AampEvent.cpp.

◆ getWidth()

BitrateChangeEvent::getWidth ( ) const

Get Width.

Returns
Video width

Definition at line 569 of file AampEvent.cpp.

◆ getHeight()

BitrateChangeEvent::getHeight ( ) const

Get Height.

Returns
Video height

Definition at line 579 of file AampEvent.cpp.

◆ getFrameRate()

BitrateChangeEvent::getFrameRate ( ) const

Get Frame Rate.

Returns
Frame Rate

Definition at line 589 of file AampEvent.cpp.

◆ getPosition()

BitrateChangeEvent::getPosition ( ) const

Get Position.

Returns
Position

Definition at line 599 of file AampEvent.cpp.

◆ getCappedProfileStatus()

BitrateChangeEvent::getCappedProfileStatus ( ) const

Get Capped Profile status.

Returns
profile filterting restricted status

Definition at line 609 of file AampEvent.cpp.

◆ getDisplayWidth()

BitrateChangeEvent::getDisplayWidth ( ) const

Get display width.

Returns
output display tv width

Definition at line 619 of file AampEvent.cpp.

◆ getDisplayHeight()

BitrateChangeEvent::getDisplayHeight ( ) const

Get output tv display Height.

Returns
output display tv height

Definition at line 629 of file AampEvent.cpp.

◆ getScanType()

BitrateChangeEvent::getScanType ( ) const

Get Video Scan Type.

Returns
output video scan type

Definition at line 639 of file AampEvent.cpp.

◆ getAspectRatioWidth()

BitrateChangeEvent::getAspectRatioWidth ( ) const

Get Aspect Ratio Width.

Returns
output aspect ratio width

Definition at line 649 of file AampEvent.cpp.

◆ getAspectRatioHeight()

BitrateChangeEvent::getAspectRatioHeight ( ) const

Get Aspect Ratio Height.

Returns
output Aspect Ratio Height

Definition at line 659 of file AampEvent.cpp.

Field Documentation

◆ mTime

int BitrateChangeEvent::mTime
private

Playback time

Definition at line 1023 of file AampEvent.h.

◆ mBitrate

long BitrateChangeEvent::mBitrate
private

Playback bitrate

Definition at line 1024 of file AampEvent.h.

◆ mDescription

std::string BitrateChangeEvent::mDescription
private

Bitrate change reason

Definition at line 1025 of file AampEvent.h.

◆ mWidth

int BitrateChangeEvent::mWidth
private

Video width

Definition at line 1026 of file AampEvent.h.

◆ mHeight

int BitrateChangeEvent::mHeight
private

Video height

Definition at line 1027 of file AampEvent.h.

◆ mFrameRate

double BitrateChangeEvent::mFrameRate
private

FrameRate

Definition at line 1028 of file AampEvent.h.

◆ mPosition

double BitrateChangeEvent::mPosition
private

Position at which bitrate changed

Definition at line 1029 of file AampEvent.h.

◆ mCappedProfile

bool BitrateChangeEvent::mCappedProfile
private

Capped/Restricted profile status

Definition at line 1030 of file AampEvent.h.

◆ mDisplayWidth

int BitrateChangeEvent::mDisplayWidth
private

TV display width

Definition at line 1031 of file AampEvent.h.

◆ mDisplayHeight

int BitrateChangeEvent::mDisplayHeight
private

TV display height

Definition at line 1032 of file AampEvent.h.

◆ mVideoScanType

VideoScanType BitrateChangeEvent::mVideoScanType
private

Video Scan Type progressive/interlaced

Definition at line 1033 of file AampEvent.h.

◆ mAspectRatioWidth

int BitrateChangeEvent::mAspectRatioWidth
private

Aspect Ratio Width

Definition at line 1034 of file AampEvent.h.

◆ mAspectRatioHeight

int BitrateChangeEvent::mAspectRatioHeight
private

Aspect Ratio Height

Definition at line 1035 of file AampEvent.h.


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