AAX_IController.h

Go to the documentation of this file.

/*================================================================================================*/
/*
 *
 *  Copyright 2013 by Avid Technology, Inc.
 *  All rights reserved.
 *  
 *  CONFIDENTIAL: This document contains confidential information.  Do not 
 *  read or examine this document unless you are an Avid Technology employee
 *  or have signed a non-disclosure agreement with Avid Technology which protects
 *  the confidentiality of this document.  DO NOT DISCLOSE ANY INFORMATION 
 *  CONTAINED IN THIS DOCUMENT TO ANY THIRD-PARTY WITHOUT THE PRIOR WRITTEN CONSENT 
 *  OF Avid Technolgy, INC.
 *
 */

/*================================================================================================*/


#ifndef _AAX_ICONTROLLER_H_
#define _AAX_ICONTROLLER_H_

#include "AAX_Properties.h"
#include "AAX_IString.h"
#include "AAX.h"

class AAX_IController
{
public: 
    
        virtual ~AAX_IController(void) {}
    
        virtual AAX_Result  GetEffectID (
            AAX_IString *   oEffectID) const = 0;
        virtual // AAX_VController
        AAX_Result
        GetSampleRate (
            AAX_CSampleRate *oSampleRate ) const = 0;
        virtual // AAX_VController
        AAX_Result
        GetInputStemFormat (
            AAX_EStemFormat *oStemFormat ) const = 0;
        virtual // AAX_VController
        AAX_Result
        GetOutputStemFormat (
            AAX_EStemFormat *oStemFormat) const = 0;
        virtual 
        AAX_Result  
        GetSignalLatency(
            int32_t* oSamples) const = 0;
        virtual
        AAX_Result
        GetCycleCount(
            AAX_EProperty iWhichCycleCount,
            AAX_CPropertyValue* oValue) const = 0;
        virtual
        AAX_Result
        GetTODLocation (
            AAX_CTimeOfDay* oTODLocation ) const = 0;
        
        virtual 
        AAX_Result  
        SetSignalLatency(
            int32_t iNumSamples) = 0;
        virtual
        AAX_Result
        SetCycleCount(
            AAX_EProperty* iWhichCycleCounts,
            AAX_CPropertyValue* iValues,
            int32_t oNumValues) = 0;

        virtual // AAX_VController
        AAX_Result
        PostPacket (
            AAX_CFieldIndex iFieldIndex,
            const void *    iPayloadP, 
            uint32_t        iPayloadSize) = 0;

        virtual AAX_Result  SendNotification (/* AAX_ENotificationEvent */ AAX_CTypeID iNotificationType, const void* iNotificationData, uint32_t iNotificationDataSize) = 0;

        virtual AAX_Result  GetCurrentMeterValue ( AAX_CTypeID iMeterID, float * oMeterValue ) const = 0;
        virtual AAX_Result  GetMeterPeakValue ( AAX_CTypeID iMeterID, float * oPeakValue ) const = 0;
        virtual AAX_Result  ClearMeterPeakValue ( AAX_CTypeID iMeterID ) const = 0;
        virtual AAX_Result  GetMeterCount ( uint32_t * oMeterCount ) const = 0;
        virtual AAX_Result  GetMeterClipped ( AAX_CTypeID iMeterID, AAX_CBoolean * oClipped ) const = 0;
        virtual AAX_Result  ClearMeterClipped ( AAX_CTypeID iMeterID ) const = 0;


        virtual AAX_Result  GetNextMIDIPacket ( AAX_CFieldIndex* oPort, AAX_CMidiPacket* oPacket ) = 0;
        
        virtual
        AAX_Result GetHybridSignalLatency(int32_t* oSamples) const = 0;
        virtual
        AAX_Result GetCurrentAutomationTimestamp(AAX_CTransportCounter* oTimestamp) const = 0;
        virtual
        AAX_Result GetHostName(AAX_IString* oHostNameString) const = 0;


};

#endif // #ifndef _AAX_IPLUGIN_H_