IMediaSuite.h

//========================================================================================
// 
// $File$
// 
// Owner: Bill Tislar
// 
// $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.
// 
// 
// Comments: Selection suite for multimedia page items
// 
//========================================================================================

#ifndef _IMediaSuite_
#define _IMediaSuite_

#include "MediaID.h"
#include "IMediaAttributes.h"
#include "IMediaContent.h"
#include "IMovieAttributes.h"
#include "INavigationPoints.h"
#include "ISetMediaAttrCmdData.h"

class IObserver;

class IMediaSuite : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IMEDIASUITE };

 virtual int32 AddNavigationPoint( uint32 time ) = 0;

 virtual bool CanAddNavigationPoint() const = 0;
 
 virtual bool CanConvertToMedia() const = 0;

 virtual bool CanRemoveNavigationPoint( int32 indexAt ) const = 0;
 
 virtual bool CanSelectNavigationPoints() const = 0;

 virtual bool CanSetPosterForIndex( uint32 optionIndex ) const = 0;
 
 virtual bool CanSetPosters() const = 0;
 
 virtual ErrorCode ChangeNavigationPointDisplayName( const PMString & name, int32 indexAt ) = 0;
 
 virtual bool HasMissingLink() const = 0;
 
 virtual ErrorCode GetAttribute( uint32 attributeID, int16 & value ) const = 0;
 
 virtual ErrorCode GetAttribute( uint32 attributeID, PMString & value ) const = 0;

 virtual int GetControllerOptions( K2Vector<PMString> & optionList ) const = 0;
 
 virtual uint32 GetControllerOptionIndex() const = 0;

 virtual bool IsControllerOptionEnabled( uint32 optionIndex ) const = 0;
 
 virtual bool IsControllerSelectionEnabled() const = 0;
 
 virtual void SetControllerOption( uint32 optionIndex ) = 0;
 
 virtual UIDRef GetEmptyFrameRef() const = 0;

 virtual bool GetMediaLocation( MediaLocation & outLocation ) const = 0;

 virtual bool GetMediaURL( WideString & outURL ) const = 0;
 
 virtual IMediaContent::MediaType GetMediaType() const = 0;

 virtual bool GetNavigationPointDisplayName( int32 indexAt, PMString & outName ) = 0;

 virtual bool GetNextNavigationPoint( INavigationPoints::NavigationPoint & navPoint ) const = 0;

 virtual uint32 GetNumberOfNavigationPoints() const = 0;

 virtual IMediaAttributes::PosterType GetPosterType() const = 0;
 
 virtual bool16 IsAttributeEnabled( uint32 attributeID ) const = 0;

 virtual bool16 IsFlagSet( uint32 attributeID ) const = 0;
 
 virtual bool IsMediaSelection() const = 0;
 
 virtual ErrorCode RemoveNavigationPoints( const K2Vector<int32> & indexList ) = 0; 

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

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

 virtual ErrorCode SetAttribute( uint32 attributeID, const NamedUint32AttributeList & value ) = 0;

 virtual ErrorCode SetAttributes( const ISetMediaAttrCmdData * inData ) = 0;
 
 virtual ErrorCode SetPoster( IMediaAttributes::PosterType posterType, int32 time ) = 0;

 virtual ErrorCode SetPoster( IDFile & file ) = 0;

 virtual ErrorCode SetFlag( uint32 attributeID, bool16 b = kTrue ) = 0;
 
 virtual ErrorCode SetPoster( IMediaAttributes::PosterType posterType, IPMStream * posterStream, bool setUndoable = false) = 0;
 
 virtual int GetPosterOptions( K2Vector<PMString> & stringList ) const = 0;
 
 virtual uint32 GetPosterOptionIndex() const = 0;
 
 virtual bool IsPosterOptionEnabled( uint32 optionIndex ) const = 0;
 
 virtual bool IsPosterFromMediaEnabled() const = 0;
 
 virtual ErrorCode SetMediaLocation( IMediaContent::MediaType mediaType, const WideString & loc, bool isURL = false ) = 0;
 
 virtual uint32 GetFloatingWindowPositionIndex() const = 0;
 
 virtual uint32 GetFloatingWindowScaleIndex() const = 0;
 
 virtual bool16 AreNavigationPointsEnabled() const = 0;
 
 virtual bool16 CanChangePDFOptions() const = 0;
 
 virtual bool16 CanPlaceMediaFromURL() const = 0;
 
 virtual bool GetMediaName( WideString & outName ) const = 0;
 
 virtual ErrorCode PlaceMediaFromURL( IMediaContent::MediaType type, const WideString & url ) = 0;
 
 virtual ErrorCode StartMediaPreview( IMediaContent::MediaType type, IObserver * iObserver = nil ) = 0;
 
 virtual ErrorCode StopMediaPreview( IMediaContent::MediaType type ) = 0;

};


#endif // _IMediaSuite_