IMediaAttributes Class Reference

Inheritance diagram for IMediaAttributes:

Public Types
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 }
enum	PosterType { eNone, eStandard, eFromMedia, eProxyImage }

Public Member Functions
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
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
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
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Member Enumeration Documentation

enum IMediaAttributes::MediaAttributeID

This enum defines the IDs for attributes common to all media types.

Enumerator
enTitle	The media title of user-specified text; type is PMString.
enTitleIsFrozen	A flag which when set, indicates that the title is frozen (may not be changed except by the user).
enDescription	The media description of user-specified text; type is PMString.
enCustomPosterFromMedia	A bool16 flag; when kTrue, indicates that the poster is a custom image created from the media content. If this flag is not set, and enPosterIsFromMedia is set, then the poster is the default image taken from the media content. For movies, the default image is usually the first frame, or it could be an image designated as the poster by the media file format (the QuickTime format, for example, supports a poster atom). Note that this flag can be set only if enPosterIsFromMedia is also set.
enEmbedOnPDFExport	A bool16 flag; when kTrue, indicates that the media content is to be embedded in the PDF file during PDF export. Note that this attribute has no affect when exporting the deprecated PDF Movie Annotation (pre PDF 1.5).
enDoNotPrintPoster	A bool16 flag; when kTrue, indicates that the media poster (if it exists) may not be printed. This flag has no affect when the poster is displayed in the app or exported to PDF.
enDoNotIncludePosterWithOutput	A bool16 flag; when kTrue, indicates that the media poster (if it exists) may not be include with print or export output. This attribute is the same as enDoNotPrintPoster; the wording has been changed to indicate that it has been generalized to all forms of output.
enPlayOnPageTurn	A bool16 flag; when kTrue, indicates that the media item should be exported to PDF so that it automatically starts playing when the page it is on is visible in the PDF viewer.
enPosterTime	A uint32; the point in time in the media (movie) at which the poster was taken.
enControllerSkinName	A PMString for the name of the controller skin.
enReserved1	Reserved for internal use by Adobe only
enPlayStartPoint	A uint32 specifying the time in 1/100 seconds to start playing the video (default is 0).
enPlayEndPoint	A uint32 specifying the time in 1/100 seconds to stop playing the video (default is video total time).
enShowControllerOnRollover	A bool16 flag; when kTrue, mousing over the video will show the controller.
enStopPlayOnPageTurn	A bool16 flag; when kTrue, media stops playing when its page is turned. Currently relevant only for sound (audio) media.
enLoopForever	A bool16 flag; when kTrue, media loops forever. Currently relevant only for sound (audio) media exported to SWF.
enPlayFullScreen_Obsolete	Obsolete
enPageLoadDelay_Obsolete	Obsolete
enShowControllerOnTap_Obsolete	Obsolete
enControllerAssetFolder_Obsolete	Obsolete
enReserved	This value must not be used as an attribute ID outside of the Media plugin.

enum IMediaAttributes::PosterType

This enum defines the types of media posters.

Enumerator
eNone	There is no poster.
eStandard	Poster is a standard poster icon.
eFromMedia	Poster originated from the media location.
eProxyImage	Poster is an arbitrary proxy image not taken from the media content location.

Member Function Documentation

virtual ErrorCode IMediaAttributes::ApplyAttributes ( ISetMediaAttrCmdData *  destData ) const

pure virtual

Applies all set attribute values to an ISetMediaAttrCmdData instance.

Parameters

destData

valid pointer to an ISetMediaAttrCmdData to receive the attribute values.

virtual void IMediaAttributes::ClearAllAttributes ( )

pure virtual

Removes/Clears all Attributes.

virtual void IMediaAttributes::ClearInt16Value ( uint32  attributeID )

pure virtual

Clears the value of an int16 attribute. When this method returns, the attribute will no longer be found.

Parameters

attributeID

may be either a MediaAttributeID or a media-specific ID.

virtual void IMediaAttributes::ClearPMPointValue ( uint32  attributeID )

pure virtual

Clears the value of a PMPoint attribute. When this method returns, the attribute will no longer be found.

Parameters

attributeID

may be either a MediaAttributeID or a media-specific ID.

virtual ErrorCode IMediaAttributes::GetAttribute ( uint32  attributeID, int16 &  value  ) const

pure virtual

Retrieves an attribute of type int16.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	a variable to contain the attribute's value.

Returns

kSuccess if the attribute exists; kFailure otherwise.

virtual ErrorCode IMediaAttributes::GetAttribute ( uint32  attributeID, int32 &  value  ) const

pure virtual

Retrieves the value of an attribute of type int32.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	a variable to contain the attribute's value.

Returns

kSuccess if the attribute exists; kFailure otherwise.

virtual ErrorCode IMediaAttributes::GetAttribute ( uint32  attributeID, uint32 &  value  ) const

pure virtual

Retrieves the value of an attribute of type uint32.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	a variable to contain the attribute's value.

Returns

kSuccess if the attribute exists; kFailure otherwise.

virtual ErrorCode IMediaAttributes::GetAttribute ( uint32  attributeID, ClassID &  value  ) const

pure virtual

Retrieves the value of an attribute of type ClassID.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	a variable to contain the attribute's value.

Returns

kSuccess if the attribute exists; kFailure otherwise.

virtual ErrorCode IMediaAttributes::GetAttribute ( uint32  attributeID, PMPoint &  value  ) const

pure virtual

Retrieves the value of an attribute of type PMPoint.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	a variable to contain the attribute's value.

Returns

kSuccess if the attribute exists; kFailure otherwise.

virtual ErrorCode IMediaAttributes::GetAttribute ( uint32  attributeID, PMReal &  value  ) const

pure virtual

Retrieves the value of an attribute of type PMReal.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	a variable to contain the attribute's value.

Returns

kSuccess if the attribute exists; kFailure otherwise.

virtual ErrorCode IMediaAttributes::GetAttribute ( uint32  attributeID, PMRect &  value  ) const

pure virtual

Retrieves the value of an attribute of type PMRect.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	a variable to contain the attribute's value.

Returns

kSuccess if the attribute exists; kFailure otherwise.

virtual ErrorCode IMediaAttributes::GetAttribute ( uint32  attributeID, PMString &  value  ) const

pure virtual

Retrieves the value of an attribute of type PMString.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	a variable to contain the attribute's value.

Returns

kSuccess if the attribute exists; kFailure otherwise.

virtual ErrorCode IMediaAttributes::GetAttribute ( uint32  attributeID, NamedUint32AttributeList &  value  ) const

pure virtual

Retrieves the value of an attribute of type NamedInt32AttributeList.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	a variable to contain the attribute's value.

Returns

kSuccess if the attribute exists; kFailure otherwise.

virtual bool16 IMediaAttributes::IsFlagSet ( uint32  attributeID ) const

pure virtual

Tests if a flag attribute is set.

Parameters

attributeID

may be either a MediaAttributeID or a media-specific ID.

Returns

kTrue if the flag is set; kFalse otherwise.

virtual void IMediaAttributes::SetAttribute ( uint32  attributeID, int16  value  )

pure virtual

Sets the value of an attribute of type int16.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	the contents of this are copied to the attribute.

virtual void IMediaAttributes::SetAttribute ( uint32  attributeID, int32  value  )

pure virtual

Sets the value of an attribute of type int32.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	the contents of this are copied to the attribute.

virtual void IMediaAttributes::SetAttribute ( uint32  attributeID, uint32  value  )

pure virtual

Sets the value of an attribute of type uint32.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	the contents of this are copied to the attribute.

virtual void IMediaAttributes::SetAttribute ( uint32  attributeID, ClassID  value  )

pure virtual

Sets the value of an attribute of type ClassID.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	the contents of this are copied to the attribute.

virtual void IMediaAttributes::SetAttribute ( uint32  attributeID, const PMPoint &  value  )

pure virtual

Sets the value of an attribute of type PMPoint.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	the contents of this are copied to the attribute.

virtual void IMediaAttributes::SetAttribute ( uint32  attributeID, const PMReal &  value  )

pure virtual

Sets the value of an attribute of type PMReal.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	the contents of this are copied to the attribute.

virtual void IMediaAttributes::SetAttribute ( uint32  attributeID, const PMRect &  value  )

pure virtual

Sets the value of an attribute of type PMRect.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	the contents of this are copied to the attribute.

virtual void IMediaAttributes::SetAttribute ( uint32  attributeID, const PMString &  value  )

pure virtual

Sets the value of an attribute of type PMString.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	the contents of this are copied to the attribute.

virtual void IMediaAttributes::SetAttribute ( uint32  attributeID, const NamedUint32AttributeList &  value  )

pure virtual

Sets the value of an attribute of type NamedInt32AttributeList.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
value	the contents of this are copied to the attribute.

virtual void IMediaAttributes::SetFlag ( uint32  attributeID, bool16  b  )

pure virtual

Sets or clears a flag attribute.

Parameters

attributeID	may be either a MediaAttributeID or a media-specific ID.
b	flag value; specify kTrue to set the flag, or kFalse to clear it.