IMediaAttributes.h

//========================================================================================
// 
// $File$
// 
// Owner: wtislar
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __IMediaAttributes__
#define __IMediaAttributes__

#include "IPMUnknown.h"
#include "MediaID.h"
#include "MediaLocation.h"
#include "NamedAttribute.h"

const bool16 kDoNotPrintPosterDefault = kFalse;

class ISetMediaAttrCmdData;

class IMediaAttributes : public IPMUnknown
{

public:
 enum { kDefaultIID = IID_IMEDIAATTRIBUTES };
 
 enum { kInvalidAttributeID = 0xffffffff };
 
 enum MediaAttributeID
 {
 enTitle = kMediaPrefix + 0,

 enTitleIsFrozen = kMediaPrefix + 1,

 enDescription = kMediaPrefix + 2,

 enCustomPosterFromMedia = kMediaPrefix + 3,

 enEmbedOnPDFExport = kMediaPrefix + 4,

 enDoNotPrintPoster = kMediaPrefix + 5,
 
 enDoNotIncludePosterWithOutput = enDoNotPrintPoster,
 
 enPlayOnPageTurn = kMediaPrefix + 6,
 
 enPosterTime = kMediaPrefix + 7,
 
 enControllerSkinName = kMediaPrefix + 8,
 
 enReserved1 = kMediaPrefix + 9,
 
 enPlayStartPoint = kMediaPrefix + 10,
 
 enPlayEndPoint = kMediaPrefix + 11,
 
 enShowControllerOnRollover = kMediaPrefix + 12,
 
 enStopPlayOnPageTurn = kMediaPrefix + 13,
 
 enLoopForever = kMediaPrefix + 14,
 
 enPlayFullScreen_Obsolete = kMediaPrefix + 15,
 
 enPageLoadDelay_Obsolete = kMediaPrefix + 16,
 
 enShowControllerOnTap_Obsolete = kMediaPrefix + 17,

 enControllerAssetFolder_Obsolete = kMediaPrefix + 18,
 
 enReserved = kMediaPrefix + 0xff // For internal use
 };

 enum PosterType
 {
 eNone,
 eStandard,
 eFromMedia,
 eProxyImage
 };

 // --- Generic polymorphic attribute accessors for each supported value type:

 virtual ErrorCode GetAttribute( uint32 attributeID, int16 & value ) const = 0;

 virtual ErrorCode GetAttribute( uint32 attributeID, int32 & value ) const = 0;

 virtual ErrorCode GetAttribute( uint32 attributeID, uint32 & value ) const = 0;
 
 virtual ErrorCode GetAttribute( uint32 attributeID, ClassID & value ) const = 0;

 virtual ErrorCode GetAttribute( uint32 attributeID, PMPoint & value ) const = 0;

 virtual ErrorCode GetAttribute( uint32 attributeID, PMReal & value ) const = 0;

 virtual ErrorCode GetAttribute( uint32 attributeID, PMRect & value ) const = 0;

 virtual ErrorCode GetAttribute( uint32 attributeID, PMString & value ) const = 0;

 virtual ErrorCode GetAttribute( uint32 attributeID, NamedUint32AttributeList & value ) const = 0;
 
 // --- Generic polymorphic attribute mutators for each supported value type:

 virtual void SetAttribute( uint32 attributeID, int16 value ) = 0;

 virtual void SetAttribute( uint32 attributeID, int32 value ) = 0;

 virtual void SetAttribute( uint32 attributeID, uint32 value ) = 0;
 
 virtual void SetAttribute( uint32 attributeID, ClassID value ) = 0;

 virtual void SetAttribute( uint32 attributeID, const PMPoint & value ) = 0;

 virtual void SetAttribute( uint32 attributeID, const PMReal & value ) = 0;

 virtual void SetAttribute( uint32 attributeID, const PMRect & value ) = 0;

 virtual void SetAttribute( uint32 attributeID, const PMString & value ) = 0;

 virtual void SetAttribute( uint32 attributeID, const NamedUint32AttributeList & value ) = 0;
 
 // --- Methods for handling conditional attributes

 virtual bool16 IsFlagSet( uint32 attributeID ) const = 0;

 virtual void SetFlag( uint32 attributeID, bool16 b ) = 0;

 virtual ErrorCode ApplyAttributes( ISetMediaAttrCmdData * destData ) const = 0;

 virtual void ClearInt16Value( uint32 attributeID ) = 0;
 
 virtual void ClearPMPointValue( uint32 attributeID ) = 0;

 virtual void ClearAllAttributes() = 0;

}; // end IMediaAttributes interface


#endif // __IMediaAttributes__