IAAFFileDescriptor is DEPRECATED, please use IAAFFileDescriptor2. More...

Public Member Functions
HRESULT	SetLength ([in] aafLength_t length)
	Sets the length of the essence in samples [not edit units].
HRESULT	GetLength ([out] aafLength_t *pLength)
	Gets the length of the essence in samples [not edit units].
HRESULT	SetCodecDef ([in] IAAFCodecDef *codecDef)
	Set to the exact codec which was used as a hint.
HRESULT	GetCodecDef ([out] IAAFCodecDef **pCodecDef)
	Get to the exact codec which was used as a hint.
HRESULT	SetSampleRate ([in] aafRational_constref rate)
	Sets sample rate of the essence as opposed to the edit rate.
HRESULT	GetSampleRate ([out] aafRational_t *pRate)
	Gets sample rate of the essence as opposed to the edit rate.
HRESULT	SetContainerFormat ([in] IAAFContainerDef *format)
	Identifies the file format.
HRESULT	GetContainerFormat ([out] IAAFContainerDef **pFormat)
	Identifies the file format.

Detailed Description

IAAFFileDescriptor is DEPRECATED, please use IAAFFileDescriptor2.

The IAAFFileDescriptor interface is implemented by objects which describe the format of the content data associated with a File Source mob or the media associated with 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.

AAFRESULT_NOT_INITIALIZED

This object has not yet had Initialize() called on it through this object's primary interface. Note that IAAFFileDescriptor is a primary interface for an abstract class, so it is not appropriate for the Initialize() method to exist in this interface. The Initialize() method is available through the concrete object's primary interface. Objects that implement IAAFFileDescriptor also implement the following interfaces:

IAAFFileDescriptor2

Definition at line 9728 of file AAF.idl.

Member Function Documentation

HRESULT IAAFFileDescriptor::GetCodecDef ( [out] IAAFCodecDef ** pCodecDef )

Get to the exact codec which was used as a hint.

Succeeds if all of the following are true:

the pCodecDef pointer is valid.
the CodecDefinition identifying the codec is present in the dictionary.

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

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

pCodecDef arg is NULL.

AAFRESULT_OBJECT_NOT_FOUND

the CodecDefinition identifying the codec is not in the dictionary.

Parameters:

pCodecDef [out] Which codec was used

HRESULT IAAFFileDescriptor::GetContainerFormat ( [out] IAAFContainerDef ** pFormat )

Identifies the file format.

Succeeds if all of the following are true:

the pFormat pointer is valid.
the ContainerDefinition identifying the file format is present in the dictionary.

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

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

pFormat arg is NULL.

AAFRESULT_OBJECT_NOT_FOUND

the ContainerDefinition identifying the file format is not in the dictionary.

Parameters:

pFormat [out] Optional

HRESULT IAAFFileDescriptor::GetLength ( [out] aafLength_t * pLength )

Gets the length of the essence in samples [not edit units].

Succeeds if all of the following are true:

the pLength pointer is valid.

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

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

pLength arg is NULL.

Parameters:

pLength [out] returns length of the essence in samples

HRESULT IAAFFileDescriptor::GetSampleRate ( [out] aafRational_t * pRate )

Gets sample rate of the essence as opposed to the edit rate.

and writes it into the *pRate argument.

Succeeds if all of the following are true:

the pRate pointer is valid.

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

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

pRate arg is NULL.

Parameters:

pRate [out] sample rate of the essence

HRESULT IAAFFileDescriptor::SetCodecDef ( [in] IAAFCodecDef * codecDef )

Set to the exact codec which was used as a hint.

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:

codecDef [in] Which codec was used

HRESULT IAAFFileDescriptor::SetContainerFormat ( [in] IAAFContainerDef * format )

Identifies the file format.

The container format is an optional property.

If this method fails the container format property will not be changed.

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:

format [in] file format

HRESULT IAAFFileDescriptor::SetLength ( [in] aafLength_t length )

Sets the length of the essence in samples [not edit units].

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:

length [in] length of the essence in samples

HRESULT IAAFFileDescriptor::SetSampleRate ( [in] aafRational_constref rate )

Sets sample rate of the essence as opposed to the edit rate.

If this method fails the sample rate property will not be changed.

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:

rate	[in] sample rate of the essence

Public Member Functions

Detailed Description

Member Function Documentation