DcsmProvider.h

Go to the documentation of this file.

//  -------------------------------------------------------------------------
//  Copyright (C) 2019 BMW AG
//  -------------------------------------------------------------------------
//  This Source Code Form is subject to the terms of the Mozilla Public
//  License, v. 2.0. If a copy of the MPL was not distributed with this
//  file, You can obtain one at https://mozilla.org/MPL/2.0/.
//  -------------------------------------------------------------------------
 
#ifndef RAMSES_DCSMPROVIDER_H
#define RAMSES_DCSMPROVIDER_H
 
#include "ramses-framework-api/RamsesFrameworkTypes.h"
#include "ramses-framework-api/RamsesFramework.h"
#include "ramses-framework-api/IDcsmProviderEventHandler.h"
#include "ramses-framework-api/StatusObject.h"
#include "ramses-framework-api/DcsmMetadataCreator.h"
#include "ramses-framework-api/EDcsmOfferingMode.h"
 
namespace ramses
{
    class DcsmProviderImpl;
 
    class RAMSES_API DcsmProvider : public StatusObject
    {
    public:
        status_t offerContent(ContentID contentID, Category category, sceneId_t scene, EDcsmOfferingMode mode);
 
        status_t offerContentWithMetadata(ContentID contentID, Category category, sceneId_t scene, EDcsmOfferingMode mode, const DcsmMetadataCreator& metadata);
 
        status_t offerContent(ContentID contentID, Category category, waylandIviSurfaceId_t surfaceId, EDcsmOfferingMode mode);
 
        status_t offerContentWithMetadata(ContentID contentID, Category category, waylandIviSurfaceId_t surfaceId, EDcsmOfferingMode mode, const DcsmMetadataCreator& metadata);
 
        status_t updateContentMetadata(ContentID contentID, const DcsmMetadataCreator& metadata);
 
        status_t requestStopOfferContent(ContentID contentID);
 
        status_t markContentReady(ContentID contentID);
 
        status_t enableFocusRequest(ContentID contentID, int32_t focusRequest);
 
        status_t disableFocusRequest(ContentID contentID, int32_t focusRequest);
 
        status_t dispatchEvents(IDcsmProviderEventHandler& handler);
 
        status_t dispatchEvents(IDcsmProviderEventHandlerExtended& handler);
 
        explicit DcsmProvider(DcsmProviderImpl&);
 
        ~DcsmProvider();
 
        class DcsmProviderImpl& impl;
 
        DcsmProvider() = delete;
 
        DcsmProvider(const DcsmProvider& other) = delete;
 
        DcsmProvider& operator=(const DcsmProvider& other) = delete;
    };
}
 
#endif