InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IMediaReadFormatInfo Class Referenceabstract

#include <IMediaReadFormatInfo.h>

Inheritance diagram for IMediaReadFormatInfo:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IMEDIAREADFORMATINFO }
 

Public Member Functions

virtual void GetFileTypes (OSTypeList *fileTypeList)=0
 
virtual void GetExtensions (ExtensionList *extensionList)=0
 
virtual void GetFormatName (PMString *formatName)=0
 
virtual void GetExternalFlavors (ExternalPMFlavorList *flavorList)=0
 
virtual MediaType GetMediaType () const =0
 
virtual PMString GetMimeType (MediaLocation loc=MediaLocation())=0
 
virtual bool16 CanReadFileType (OSType fileType)=0
 
virtual bool16 CanReadExtension (const PMString &extension)=0
 
virtual const PMString GetStandardPosterFileName () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

This interface provides metadata for a specific kind of media format. This interface must be supported by all media filters.

Member Function Documentation

virtual bool16 IMediaReadFormatInfo::CanReadExtension (const PMStringextension)
pure virtual

Tests if a specific extension is recognized by this filter.

Parameters
extensiona PMString containing the extension to test.
Returns
kTrue if the extension is recognized; kFalse otherwise.
virtual bool16 IMediaReadFormatInfo::CanReadFileType (OSType fileType)
pure virtual

Tests if a specific file type is recognized by this filter.

Parameters
fileTypethe OSType to test.
Returns
kTrue if the fileType is recognized; kFalse otherwise.
virtual void IMediaReadFormatInfo::GetExtensions (ExtensionListextensionList)
pure virtual

Retrieves a list of extensions that the filter supports.

Parameters
extensionListvalid pointer to an ExtensionList object to be populated by this method.
virtual void IMediaReadFormatInfo::GetExternalFlavors (ExternalPMFlavorListflavorList)
pure virtual

Retrieves a list of external flavors.

Clipboard support: On the Mac, a clipboard flavor/type is equivalent to an OSType. On Windows, to get the clipboard flavor/type you must register the format name with Windows and it will return the format.

Parameters
flavorListvalid pointer to an ExternalPMFlavorList object to be populated by this method.
virtual void IMediaReadFormatInfo::GetFileTypes (OSTypeListfileTypeList)
pure virtual

Retrieves a list of file types that the filter supports.

Parameters
fileTypeListvalid pointer to an OSTypeList object to be populated by this method.
virtual void IMediaReadFormatInfo::GetFormatName (PMStringformatName)
pure virtual

Retrieves the format name identifier.

Parameters
formatNamevalid pointer to a PMString object to be populated with the format name string by this method.
virtual MediaType IMediaReadFormatInfo::GetMediaType () const
pure virtual

Retrieves the MediaType defined in MediaID.h.

Returns
the MediaType.
virtual PMString IMediaReadFormatInfo::GetMimeType (MediaLocation loc = MediaLocation())
pure virtual

Retrieves the media's mime type as defined in RFC 2046, Multipurpose Mail Extensions (MIME) Part Two: Media Types.

Returns
a PMString representing the mime type; a null PMString if the mime type is not known.
virtual const PMString IMediaReadFormatInfo::GetStandardPosterFileName () const
pure virtual

Retrieves the base filename (with jpg extension) of the standard poster to represent the media type.

Returns
the name of an existing poster jpg file.