ramses::IDcsmConsumerEventHandler Class Reference

Callback interface for received DCSM consumer side events. Used with DcsmConsumer::dispatchEvents(). More...

#include <IDcsmConsumerEventHandler.h>

Public Member Functions
virtual	~IDcsmConsumerEventHandler ()=default
virtual void	contentOffered (ramses::ContentID contentID, ramses::Category category, ramses::ETechnicalContentType contentType)=0
	Provider offered new content that can be controlled. More...
virtual void	contentDescription (ramses::ContentID contentID, ramses::TechnicalContentDescriptor contentDescriptor)=0
	Provides the content description. It will be triggered by provider after the content is assigned to consumer. It will always be called before the contentReady callback. More...
virtual void	contentReady (ramses::ContentID contentID)=0
	Provider made content ready and available to use. This is an answer to DcsmConsumer::sendContentStatusChange with EDcsmState::Ready. Will be called after receiving a contentDescription callback with the necessary content description. More...
virtual void	contentEnableFocusRequest (ramses::ContentID contentID, int32_t focusRequest)=0
	Provider requested to switch to/focus this content within the category. Consumer may or may not follow this request. More...
virtual void	contentDisableFocusRequest (ramses::ContentID contentID, int32_t focusRequest)=0
	Provider requested to no longer request focusing this content within the category. Consumer may or may not follow this request. More...
virtual void	contentStopOfferRequest (ramses::ContentID contentID)=0
	Provider no longer wants to offer the content and wants to remove it. Requests consumer to release the content and reply with DcsmConsumer::acceptStopOffer. Optionally the consumer may trigger contentStateChanges to release content in a controlled manner. More...
virtual void	forceContentOfferStopped (ramses::ContentID contentID)=0
	Content disappeared unexpectedly. Consumer should take immediate actions to handle. It is not possible to send further commands for this content. More...
virtual void	contentMetadataUpdated (ramses::ContentID contentID, const DcsmMetadataUpdate &metadataUpdate)=0
	Update metadata for given content. This callback provides metadata given to DcsmProvider::offerContentWithMetadata() and DcsmProvider::updateContentMetadata(). A consumer will get the combined state of all past metadata updates from the whole lifecycle of the content as first event after it assigned to content to itself. Later events only contain delta updates. When the provider never attached metadata to this content, this callback will never be called. More...

Detailed Description

Callback interface for received DCSM consumer side events. Used with DcsmConsumer::dispatchEvents().

Constructor & Destructor Documentation

~IDcsmConsumerEventHandler()

virtual ramses::IDcsmConsumerEventHandler::~IDcsmConsumerEventHandler ( )

virtualdefault

Member Function Documentation

contentDescription()

virtual void ramses::IDcsmConsumerEventHandler::contentDescription ( ramses::ContentID  contentID, ramses::TechnicalContentDescriptor  contentDescriptor  )

pure virtual

Provides the content description. It will be triggered by provider after the content is assigned to consumer. It will always be called before the contentReady callback.

Parameters

contentID	described content
contentDescriptor	descriptor/id of this content

contentDisableFocusRequest()

virtual void ramses::IDcsmConsumerEventHandler::contentDisableFocusRequest ( ramses::ContentID  contentID, int32_t  focusRequest  )

pure virtual

Provider requested to no longer request focusing this content within the category. Consumer may or may not follow this request.

Parameters

contentID	content that provider should no longer focus
focusRequest	identifier of the focus request

contentEnableFocusRequest()

virtual void ramses::IDcsmConsumerEventHandler::contentEnableFocusRequest ( ramses::ContentID  contentID, int32_t  focusRequest  )

pure virtual

Provider requested to switch to/focus this content within the category. Consumer may or may not follow this request.

Parameters

contentID	content that provider wants to switch focus to
focusRequest	identifier of the focus request

contentMetadataUpdated()

virtual void ramses::IDcsmConsumerEventHandler::contentMetadataUpdated ( ramses::ContentID  contentID, const DcsmMetadataUpdate &  metadataUpdate  )

pure virtual

Update metadata for given content. This callback provides metadata given to DcsmProvider::offerContentWithMetadata() and DcsmProvider::updateContentMetadata(). A consumer will get the combined state of all past metadata updates from the whole lifecycle of the content as first event after it assigned to content to itself. Later events only contain delta updates. When the provider never attached metadata to this content, this callback will never be called.

Parameters

contentID	which content is affected
metadataUpdate	object to get metadata update from. valid for the lifetime of the callback.

contentOffered()

virtual void ramses::IDcsmConsumerEventHandler::contentOffered ( ramses::ContentID  contentID, ramses::Category  category, ramses::ETechnicalContentType  contentType  )

pure virtual

Provider offered new content that can be controlled.

Parameters

contentID	newly available content
category	content category
contentType	what kind of content

contentReady()

virtual void ramses::IDcsmConsumerEventHandler::contentReady ( ramses::ContentID  contentID )

pure virtual

Provider made content ready and available to use. This is an answer to DcsmConsumer::sendContentStatusChange with EDcsmState::Ready. Will be called after receiving a contentDescription callback with the necessary content description.

Parameters

contentID

available content

contentStopOfferRequest()

virtual void ramses::IDcsmConsumerEventHandler::contentStopOfferRequest ( ramses::ContentID  contentID )

pure virtual

Provider no longer wants to offer the content and wants to remove it. Requests consumer to release the content and reply with DcsmConsumer::acceptStopOffer. Optionally the consumer may trigger contentStateChanges to release content in a controlled manner.

Parameters

contentID

content for which the stopOffer is requested

forceContentOfferStopped()

virtual void ramses::IDcsmConsumerEventHandler::forceContentOfferStopped ( ramses::ContentID  contentID )

pure virtual

Content disappeared unexpectedly. Consumer should take immediate actions to handle. It is not possible to send further commands for this content.

Parameters

contentID

which content id affected

---

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

• /home/runner/work/ramses/ramses/framework/ramses-framework-api/include/ramses-framework-api/IDcsmConsumerEventHandler.h