The IAAFTIFFDescriptor interface is implemented by objects which describe TIFF format media. More...

Public Member Functions
HRESULT	SetIsUniform ([in] aafBoolean_t IsUniform)
	Set to TRUE if essence data has the same number of rows per strip throughout.
HRESULT	GetIsUniform ([out] aafBoolean_t *pIsUniform)
	Places TRUE into *pIsUniform if the data has the same number of rows per strip throughout.
HRESULT	SetIsContiguous ([in] aafBoolean_t IsContiguous)
	Set to TRUE if essence data is stored in contiguous bytes.
HRESULT	GetIsContiguous ([out] aafBoolean_t *pIsContiguous)
	Places TRUE into *pIsContiguous if essence data is stored in contiguous bytes.
HRESULT	SetLeadingLines ([in] aafInt32 LeadingLines)
	Sets the number of leading lines in the TIFF image file.
HRESULT	GetLeadingLines ([out] aafInt32 *pLeadingLines)
	Gets the leading lines of the TIFF image.
HRESULT	SetTrailingLines ([in] aafInt32 TrailingLines)
	Sets the number of trailing lines in the TIFF image file.
HRESULT	GetTrailingLines ([out] aafInt32 *pTrailingLines)
	Gets the trailing lines of the TIFF image.
HRESULT	SetJPEGTableID ([in] aafJPEGTableID_t JPEGTableID)
	Sets the JPEG table code for the TIFF image file.
HRESULT	GetJPEGTableID ([out] aafJPEGTableID_t *pJPEGTableID)
	Gets the JPEG table code of the TIFF image.
HRESULT	GetSummary ([in] aafUInt32 size,[out, size_is(size)] aafDataValue_t pSummary)
	Gets a copy of the TIFF IFD file information without the media.
HRESULT	GetSummaryBufferSize ([out] aafUInt32 *pSize)
	Returns the size of the buffer required for the GetSummary() method.
HRESULT	SetSummary ([in] aafUInt32 size,[in, size_is(size)] aafDataValue_t pSummary)
	Sets the TIFF IFD file information.

Detailed Description

The IAAFTIFFDescriptor interface is implemented by objects which describe TIFF format media.

A TIFFDescriptor object shall be the EssenceDescription of a physical Source Mob.

In addition to the specific error results listed for each method, all methods in this interface may also return one of the following values:

AAFRESULT_NOMEMORY

insufficient system memory is available to perform the operation. Objects that implement IAAFTIFFDescriptor also implement the following interfaces:

IAAFFileDescriptor

Definition at line 26427 of file AAF.idl.

Member Function Documentation

HRESULT IAAFTIFFDescriptor::GetIsContiguous ( [out] aafBoolean_t * pIsContiguous )

Places TRUE into *pIsContiguous if essence data is stored in contiguous bytes.

Succeeds if all of the following are true:

the pIsContiguous pointer is valid.

If this method fails nothing will be written to *pIsContiguous.

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pIsContiguous arg is NULL.

Parameters:

pIsContiguous [out] is this data stored in contiguous bytes

HRESULT IAAFTIFFDescriptor::GetIsUniform ( [out] aafBoolean_t * pIsUniform )

Places TRUE into *pIsUniform if the data has the same number of rows per strip throughout.

Succeeds if all of the following are true:

the pIsUniform pointer is valid.

If this method fails nothing will be written to *pIsUniform.

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pIsUniform arg is NULL.

Parameters:

pIsUniform [out] Gets the IsUniform flag value

HRESULT IAAFTIFFDescriptor::GetJPEGTableID ( [out] aafJPEGTableID_t * pJPEGTableID )

Gets the JPEG table code of the TIFF image.

This method succeeds if all of the following are true:

the pJPEGTableID pointer is valid.

If this method fails nothing will be written to *pJPEGTableID.

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NOT_INITIALIZED

This object has not yet had Initialize() called on it.

AAFRESULT_NULL_PARAM

pJPEGTableID arg is NULL.

Parameters:

pJPEGTableID [out] Address to store the nJPEG table code

HRESULT IAAFTIFFDescriptor::GetLeadingLines ( [out] aafInt32 * pLeadingLines )

Gets the leading lines of the TIFF image.

This method succeeds if all of the following are true:

the pLeadingLines pointer is valid.

If this method fails nothing will be written to *pLeadingLines.

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NOT_INITIALIZED

This object has not yet had Initialize() called on it.

AAFRESULT_NULL_PARAM

pLeadingLines arg is NULL.

Parameters:

pLeadingLines [out] Address to store the number of leading lines

HRESULT IAAFTIFFDescriptor::GetSummary	(	[in] aafUInt32	size,
		[out, size_is(size)] aafDataValue_t	pSummary
	)

Gets a copy of the TIFF IFD file information without the media.

Succeeds if all of the following are true:

pSummary is a valid pointer.
The size of the buffer is large enough to hold the TIFF IFD file information.

If this method fails pSummary will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded.

AAFRESULT_NULL_PARAM

pSummary arg is NULL.

AAFRESULT_SMALLBUF

The buffer is too small to hold the WAVE file information.

Parameters:

size	[in] Size of preallocated buffer
pSummary	[out, size_is(size)] Preallocated buffer to hold the TIFF IFD file information

HRESULT IAAFTIFFDescriptor::GetSummaryBufferSize ( [out] aafUInt32 * pSize )

Returns the size of the buffer required for the GetSummary() method.

The value is placed into the location specified by pSize.

Succeeds if all of the following are true:

the pSize pointer is valid.

If this method fails nothing will be written to *pSize.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded.

AAFRESULT_NULL_PARAM

pSize arg is NULL.

Parameters:

pSize [out] required buffer size

HRESULT IAAFTIFFDescriptor::GetTrailingLines ( [out] aafInt32 * pTrailingLines )

Gets the trailing lines of the TIFF image.

This method succeeds if all of the following are true:

the pTrailingLines pointer is valid.

If this method fails nothing will be written to *pTrailingLines.

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NOT_INITIALIZED

This object has not yet had Initialize() called on it.

AAFRESULT_NULL_PARAM

pTrailingLines arg is NULL.

Parameters:

pTrailingLines [out] Address to store the number of trailing lines.

HRESULT IAAFTIFFDescriptor::SetIsContiguous ( [in] aafBoolean_t IsContiguous )

Set to TRUE if essence data is stored in contiguous bytes.

Always succeeds.

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

Parameters:

IsContiguous [in] is data stores in contiguous bytes

HRESULT IAAFTIFFDescriptor::SetIsUniform ( [in] aafBoolean_t IsUniform )

Set to TRUE if essence data has the same number of rows per strip throughout.

Always succeeds.

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

Parameters:

IsUniform [in] Sets the IsUniform flag value

HRESULT IAAFTIFFDescriptor::SetJPEGTableID ( [in] aafJPEGTableID_t JPEGTableID )

Sets the JPEG table code for the TIFF image file.

This method always succeeds .

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

Parameters:

JPEGTableID [in] Registered JPEG table code or JT_NULL.

HRESULT IAAFTIFFDescriptor::SetLeadingLines ( [in] aafInt32 LeadingLines )

Sets the number of leading lines in the TIFF image file.

This method succeeds if all of the following are true:

LeadingLines is equal or greater than 0(zero).

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NOT_INITIALIZED

This object has not yet had Initialize() called on it.

Parameters:

LeadingLines [in] Number of leading lines to be thrown away Optional

HRESULT IAAFTIFFDescriptor::SetSummary	(	[in] aafUInt32	size,
		[in, size_is(size)] aafDataValue_t	pSummary
	)

Sets the TIFF IFD file information.

Succeeds if all of the following are true:

pSummary is a valid pointer

If this method fails the summary property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded.

AAFRESULT_NULL_PARAM

pSummary arg is NULL.

Parameters:

size	[in] Size of preallocated buffer
pSummary	[in, size_is(size)] buffer containing value

HRESULT IAAFTIFFDescriptor::SetTrailingLines ( [in] aafInt32 TrailingLines )

Sets the number of trailing lines in the TIFF image file.

This method succeeds if all of the following are true:

TrailingLines is equal or greater than 0(zero).

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NOT_INITIALIZED

This object has not yet had Initialize() called on it.

Parameters:

TrailingLines [in] Number of trailing lines to be thrown away Optional.

Public Member Functions

Detailed Description

Member Function Documentation