RDK Documentation (Open Sourced RDK Components)
WatermarkSessionUpdateEvent Class Reference

Class for the watermarkSession event. More...

#include <AampEvent.h>

Inheritance diagram for WatermarkSessionUpdateEvent:
Inheritance graph
Collaboration diagram for WatermarkSessionUpdateEvent:
Collaboration graph

Public Member Functions

 WatermarkSessionUpdateEvent (const WatermarkSessionUpdateEvent &)=delete
 
WatermarkSessionUpdateEventoperator= (const WatermarkSessionUpdateEvent &)=delete
 
 WatermarkSessionUpdateEvent (uint32_t sessionHandle, uint32_t status, const std::string &system)
 WatermarkSessionUpdateEvent Constructor. More...
 
virtual ~WatermarkSessionUpdateEvent ()
 WatermarkSessionUpdateEvent Destructor.
 
uint32_t getSessionHandle () const
 Get session handle. More...
 
uint32_t getStatus () const
 Get session status. More...
 
const std::string & getSystem () const
 Get System. 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

uint32_t mSessionHandle
 
uint32_t mStatus
 
std::string mSystem
 

yes

Class for the watermarkSession event.

Definition at line 2037 of file AampEvent.h.

Constructor & Destructor Documentation

◆ WatermarkSessionUpdateEvent()

WatermarkSessionUpdateEvent::WatermarkSessionUpdateEvent ( uint32_t  sessionHandle,
uint32_t  status,
const std::string &  system 
)
inline

WatermarkSessionUpdateEvent Constructor.

Parameters
[in]sessionHandle- Handle used to track and manage session
[in]status- Status of the watermark session
[in]system- Watermarking protection provider

Definition at line 2053 of file AampEvent.h.

Member Function Documentation

◆ getSessionHandle()

uint32_t WatermarkSessionUpdateEvent::getSessionHandle ( ) const
inline

Get session handle.

Returns
session handle

Definition at line 2066 of file AampEvent.h.

◆ getStatus()

uint32_t WatermarkSessionUpdateEvent::getStatus ( ) const
inline

Get session status.

Returns
status

Definition at line 2073 of file AampEvent.h.

◆ getSystem()

const std::string& WatermarkSessionUpdateEvent::getSystem ( ) const
inline

Get System.

Returns
System

Definition at line 2080 of file AampEvent.h.

Field Documentation

◆ mSessionHandle

uint32_t WatermarkSessionUpdateEvent::mSessionHandle
private

Playback session handle used to track and manage sessions

Definition at line 2039 of file AampEvent.h.

◆ mStatus

uint32_t WatermarkSessionUpdateEvent::mStatus
private

Provides the status of the watermark session.

Definition at line 2040 of file AampEvent.h.

◆ mSystem

std::string WatermarkSessionUpdateEvent::mSystem
private

Describes content watermarking protection provider

Definition at line 2041 of file AampEvent.h.


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