ISound.h

Go to the documentation of this file.

/******************************************************************************
* ADOBE CONFIDENTIAL
* ___________________
*
*  Copyright [2013] Adobe Systems Incorporated
*  All Rights Reserved.
*
* NOTICE:  All information contained herein is, and remains
* the property of Adobe Systems Incorporated and its suppliers,
* if any.  The intellectual and technical concepts contained
* herein are proprietary to Adobe Systems Incorporated and its
* suppliers and are protected by all applicable intellectual 
* property laws, including trade secret and copyright laws.
* Dissemination of this information or reproduction of this material
* is strictly forbidden unless prior written permission is obtained
* from Adobe Systems Incorporated.
******************************************************************************/

#ifndef ISOUND_ELEMENT_H_
#define ISOUND_ELEMENT_H_

#include "FCMPreConfig.h"
#include "FCMPluginInterface.h"
#include "Utils/DOMTypes.h"


/* -------------------------------------------------- Forward Decl */

namespace DOM
{
    namespace Utils
    {
        FORWARD_DECLARE_INTERFACE(ISoundEffect);
    }

    namespace LibraryItem
    {
        FORWARD_DECLARE_INTERFACE(IMediaItem);
    }
}


/* -------------------------------------------------- Enums */

namespace DOM
{
    namespace FrameElement
    {
        enum SoundRepeatMode
        {
            SOUND_REPEAT_INFINITE,


            SOUND_REPEAT_FINITE
        }; 


        enum SoundSyncMode
        {
            SOUND_SYNC_EVENT,


            SOUND_SYNC_START,


            SOUND_SYNC_STOP,
            

            SOUND_SYNC_STREAM
        };
    }
}


/* -------------------------------------------------- Macros / Constants */

namespace DOM
{
    namespace FrameElement
    {
        FCM::ConstFCMIID IID_ISOUND_ELEMENT =
            {0xef9dff11, 0x1b84, 0x41ba, {0xac, 0x7f, 0xc2, 0x56, 0xf, 0x69, 0x2f, 0x30}};
    }
}


/* -------------------------------------------------- Structs / Unions */

namespace DOM
{
    namespace FrameElement
    {
        struct SOUND_LOOP_MODE
        {
            size_t structSize;


            SoundRepeatMode loopMode;


            FCM::U_Int16 repeatCount;
        };


        struct SOUND_LIMIT
        {
            size_t structSize;
            

            FCM::S_Int32 inPos44;


            FCM::S_Int32 outPos44;
        };
    }
}

/* -------------------------------------------------- Class Decl */


namespace DOM 
{
    namespace FrameElement
    {
        BEGIN_DECLARE_INTERFACE(ISound, IID_ISOUND_ELEMENT)

            
            virtual FCM::Result _FCMCALL GetSoundItem(DOM::LibraryItem::PIMediaItem& pSoundItem) = 0;


            virtual FCM::Result _FCMCALL GetSoundEffect(PIFCMList& pISoundEffects) = 0;


            virtual FCM::Result _FCMCALL GetLoopMode(SOUND_LOOP_MODE& loopMode) = 0;


            virtual FCM::Result _FCMCALL GetSyncMode(SoundSyncMode& syncMode) = 0;


            virtual FCM::Result _FCMCALL GetSoundLimit(SOUND_LIMIT& soundLimit) = 0;

        END_DECLARE_INTERFACE 
    }
}


/* -------------------------------------------------- Inline / Functions */


#include "FCMPostConfig.h"

#endif // ISOUND_ELEMENT_H_