AAX_CSessionDocumentClient.h

Go to the documentation of this file.

/*================================================================================================*/
/*
 *
 *  Copyright 2023-2024 Avid Technology, Inc.
 *  All rights reserved.
 *  
 *  This file is part of the Avid AAX SDK.
 *  
 *  The AAX SDK is subject to commercial or open-source licensing.
 *  
 *  By using the AAX SDK, you agree to the terms of both the Avid AAX SDK License
 *  Agreement and Avid Privacy Policy.
 *  
 *  AAX SDK License: https://developer.avid.com/aax
 *  Privacy Policy: https://www.avid.com/legal/privacy-policy-statement
 *  
 *  Or: You may also use this code under the terms of the GPL v3 (see
 *  www.gnu.org/licenses).
 *  
 *  THE AAX SDK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
 *  EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
 *  DISCLAIMED.
 *
 */
 
/*================================================================================================*/
 
#pragma once
#ifndef AAX_CSessionDocumentClient_H
#define AAX_CSessionDocumentClient_H
 
#include "AAX_ISessionDocumentClient.h"
#include <memory>
 
#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wunused-parameter"
#endif
 
class AAX_IController;
class AAX_IEffectParameters;
class AAX_ISessionDocument;
class AAX_VSessionDocument;
 
 
class AAX_CSessionDocumentClient :  public AAX_ISessionDocumentClient
{
public: 
 
    AAX_CSessionDocumentClient(void);
    ~AAX_CSessionDocumentClient(void) AAX_OVERRIDE;
 
public: 
 
    AAX_Result Initialize (IACFUnknown * iUnknown) AAX_OVERRIDE;
    AAX_Result Uninitialize (void) AAX_OVERRIDE;
 
    AAX_Result SetSessionDocument(IACFUnknown * iSessionDocument) AAX_OVERRIDE;
    
    AAX_Result NotificationReceived(/* AAX_ENotificationEvent */ AAX_CTypeID /*inNotificationType*/, const void * /*inNotificationData*/, uint32_t /*inNotificationDataSize*/) AAX_OVERRIDE { return AAX_SUCCESS; }
 
protected: 
 
    virtual AAX_Result SessionDocumentWillChange() { return AAX_SUCCESS; }
    virtual AAX_Result SessionDocumentChanged() { return AAX_SUCCESS; }
 
    AAX_IController* GetController (void);
    const AAX_IController* GetController (void) const; 
    
    AAX_IEffectParameters* GetEffectParameters (void);
    const AAX_IEffectParameters* GetEffectParameters (void) const; 
    
    std::shared_ptr<AAX_ISessionDocument> GetSessionDocument (void);
    std::shared_ptr<const AAX_ISessionDocument> GetSessionDocument (void) const; 
 
private:
    void ClearInternalState();
 
    //These are private, but they all have protected accessors. 
    AAX_UNIQUE_PTR(AAX_IController) mController;
    AAX_IEffectParameters * mEffectParameters;
    std::shared_ptr<AAX_VSessionDocument> mSessionDocument;
};
 
#ifdef __clang__
#pragma clang diagnostic pop
#endif
 
#endif // AAX_CSessionDocumentClient