Detailed Description

A class containing the necessary configurations for playback of PlayReady protected media.

This class is provided to CYIAbstractVideoPlayer at prepare time of PlayReady. It contains the information required to contact the PlayReady license acquisition server and obtain the license for playback.

Note: All configurations should be set before calling CYIAbstractVideoPlayer::Prepare to ensure that they will be properly picked up by the player.

#include <player/YiPlayReadyDRMConfiguration.h>

Inheritance diagram for CYIPlayReadyDRMConfiguration:

[legend]

Public Member Functions
	CYIPlayReadyDRMConfiguration (const CYIUrl &licenseAcquisitionUrl=CYIUrl::EmptyUrl(), const CYIString &licenseAcquisitionCustomData=CYIString::EmptyString())

virtual	~CYIPlayReadyDRMConfiguration ()

virtual CYIAbstractVideoPlayer::DRMScheme	GetScheme () const final override

void	SetLicenseAcquisitionCustomData (const CYIString &licenseAcquisitionCustomData)

const CYIString &	GetLicenseAcquisitionCustomData () const

Public Member Functions inherited from CYILicenseAcquisitionDRMConfiguration
	CYILicenseAcquisitionDRMConfiguration ()=default

	CYILicenseAcquisitionDRMConfiguration (const CYIUrl &licenseAcquisitionUrl)

virtual	~CYILicenseAcquisitionDRMConfiguration ()

void	SetLicenseAcquisitionUrl (const CYIUrl &licenseAcquisitionUrl)

const CYIUrl &	GetLicenseAcquisitionUrl () const

void	SetLicenseAcquisitionHeader (const CYIString &headerField, const CYIString headerValue)

void	ClearLicenseAcquisitionHeader (const CYIString &headerField)

void	ClearLicenseAcquisitionHeaders ()

const std::map< CYIString, CYIString > &	GetLicenseAcquisitionHeaders () const

Public Member Functions inherited from CYIAbstractVideoPlayer::DRMConfiguration
virtual	~DRMConfiguration ()=default

Additional Inherited Members
Protected Attributes inherited from CYILicenseAcquisitionDRMConfiguration
CYIUrl	m_licenseAcquisitionUrl

std::map< CYIString, CYIString >	m_licenseAcquisitionHeaders

Constructor & Destructor Documentation

◆ CYIPlayReadyDRMConfiguration()

CYIPlayReadyDRMConfiguration::CYIPlayReadyDRMConfiguration	(	const CYIUrl &	licenseAcquisitionUrl = `CYIUrl::EmptyUrl()`,
		const CYIString &	licenseAcquisitionCustomData = `CYIString::EmptyString()`
	)

Constructs an instance containing the specified licenseAcquisitionUrl and licenseAcquisitionCustomData.

See also: SetLicenseAcquisitionUrl; SetLicenseAcquisitionCustomData

◆ ~CYIPlayReadyDRMConfiguration()

virtual CYIPlayReadyDRMConfiguration::~CYIPlayReadyDRMConfiguration ( )

virtual

Member Function Documentation

◆ GetLicenseAcquisitionCustomData()

const CYIString& CYIPlayReadyDRMConfiguration::GetLicenseAcquisitionCustomData ( ) const

Returns the current license acquisition custom data.

◆ GetScheme()

virtual CYIAbstractVideoPlayer::DRMScheme CYIPlayReadyDRMConfiguration::GetScheme ( ) const

finaloverridevirtual

Returns the DRM scheme which this configuration is associated with.

Implements CYIAbstractVideoPlayer::DRMConfiguration.

◆ SetLicenseAcquisitionCustomData()

void CYIPlayReadyDRMConfiguration::SetLicenseAcquisitionCustomData ( const CYIString & licenseAcquisitionCustomData )

Sets the custom data that may be required by the license server to provide the PlayReady DRM license.

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

player/YiPlayReadyDRMConfiguration.h