Main Page | Class List | File List | Class Members | File Members

IAAFFilmDescriptor Interface Reference

Detailed Description

The IAAFFilmDescriptor interface is implemented by objects which describe film essence.

A FilmDescriptor 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 IAAFFilmDescriptor also implement the following interfaces:

Definition at line 7814 of file AAF.idl.

Public Member Functions

HRESULT SetFilmManufacturer ([in, string] aafCharacter_constptr pFilmManufacturer)

Sets the Film Manufacturer string property.

HRESULT GetFilmManufacturer ([out, string, size_is(bufSize)] aafCharacter *pFilmManufacturer,[in] aafUInt32 bufSize)

Gets the Film Manufacturer string property.

HRESULT GetFilmManufacturerBufLen ([out] aafUInt32 *pBufSize)

Returns size of buffer (in bytes) required for GetFilmManufacturer().

HRESULT SetFilmModel ([in, string] aafCharacter_constptr pFilmModel)

Sets the Film Model string property.

HRESULT GetFilmModel ([out, string, size_is(bufSize)] aafCharacter *pFilmModel,[in] aafUInt32 bufSize)

Gets the Film Model string property.

HRESULT GetFilmModelBufLen ([out] aafUInt32 *pBufSize)

Returns size of buffer (in bytes) required for GetFilmModel().

HRESULT GetFilmFormat ([out] aafFilmType_t *pFilmFormat)

Gets the film format.

HRESULT GetFrameRate ([out] aafUInt32 *pRate)

Get the frame rate of the film.

HRESULT GetPerfPerFrame ([out] aafUInt8 *pPerfPerFrame)

Get the number of perforations per frame.

HRESULT GetFilmAspectRatio ([out] aafRational_t *pAspectRatio)

Get the image aspect ratio.

HRESULT SetFilmFormat ([in] aafFilmType_t filmFormat)

Sets the film format of the film.

HRESULT SetFrameRate ([in] aafUInt32 rate)

Set the frame rate of the film.

HRESULT SetPerfPerFrame ([in] aafUInt8 perfPerFrame)

Set the number of perforations per frame.

HRESULT SetFilmAspectRatio ([in] aafRational_t aspectRatio)

Set the image aspect ratio.

Member Function Documentation

HRESULT IAAFFilmDescriptor::GetFilmAspectRatio ( [out] aafRational_t * pAspectRatio )

Get the image aspect ratio.
This method succeeds if all of the following are true:

the pAspectRatio pointer is valid.

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

pAspectRatio arg is NULL.

Parameters:

pAspectRatio [out] Film Aspect Ratio

HRESULT IAAFFilmDescriptor::GetFilmFormat ( [out] aafFilmType_t * pFilmFormat )

Gets the film format.
Valid values include:

kFt35MM
kFt16MM
kFt8MM
kFt65MM

This method succeeds if all of the following are true:

the pFilmFormat pointer is valid.

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

pFilmFormat arg is NULL.

Parameters:

pFilmFormat [out] pointer to the filmFormat

HRESULT IAAFFilmDescriptor::GetFilmManufacturer ( [out, string, size_is(bufSize)] aafCharacter * pFilmManufacturer,

[in] aafUInt32 bufSize

)

Gets the Film Manufacturer string property.
Writes the FilmManufacturer property, with a trailing null character, into the pFilmManufacturer buffer. The buffer is allocated by the caller. The size of the buffer is given by bufSize. If the FilmManufacturer property has not yet been set, a zero-length string will be written (that is, only the trailing null character).
Caller may call GetFilmManufacturerBufLen() to determine the required buffer size.
If this method fails nothing will be written to pFilmManufacturer.
Succeeds if:

The pFilmManufacturer pointer is valid.
bufSize indicates that the buffer is large enough to hold FilmManufacturer.

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

pFilmManufacturer arg is NULL.

AAFRESULT_SMALL_BUF

bufSize indicates that the allocated buffer is not large enough to hold FilmManufacturer.

Parameters:

pFilmManufacturer [out, string, size_is(bufSize)] buffer into which FilmManufacturer is to be written

bufSize [in] size of *pFilmManufacturer buffer in bytes

HRESULT IAAFFilmDescriptor::GetFilmManufacturerBufLen ( [out] aafUInt32 * pBufSize )

Returns size of buffer (in bytes) required for GetFilmManufacturer().
Succeeds if:

The pBufSize pointer is valid.

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

pBufSize arg is NULL.

Parameters:

pBufSize [out] size of required buffer, in bytes

HRESULT IAAFFilmDescriptor::GetFilmModel ( [out, string, size_is(bufSize)] aafCharacter * pFilmModel,

[in] aafUInt32 bufSize

)

Gets the Film Model string property.
Writes the FilmModel property, with a trailing null character, into the pFilmModel buffer. The buffer is allocated by the caller. The size of the buffer is given by bufSize. If the FilmModel property has not yet been set, a zero-length string will be written (that is, only the trailing null character).
Caller may call GetFilmModelBufLen() to determine the required buffer size.
If this method fails nothing will be written to pFilmModel.
Succeeds if:

The pFilmModel pointer is valid.
bufSize indicates that the buffer is large enough to hold FilmModel.

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

pFilmModel arg is NULL.

AAFRESULT_SMALL_BUF

bufSize indicates that the allocated buffer is not large enough to hold FilmModel.

Parameters:

pFilmModel [out, string, size_is(bufSize)] buffer into which FilmModel is to be written

bufSize [in] size of *pFilmModel buffer in bytes

HRESULT IAAFFilmDescriptor::GetFilmModelBufLen ( [out] aafUInt32 * pBufSize )

Returns size of buffer (in bytes) required for GetFilmModel().
Succeeds if:

The pBufSize pointer is valid.

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

pBufSize arg is NULL.

Parameters:

pBufSize [out] size of required buffer, in bytes

HRESULT IAAFFilmDescriptor::GetFrameRate ( [out] aafUInt32 * pRate )

Get the frame rate of the film.
This method succeeds if all of the following are true:

the pRate pointer is valid.

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

pRate parameter is NULL.

Parameters:

pRate [out] Frame Rate

HRESULT IAAFFilmDescriptor::GetPerfPerFrame ( [out] aafUInt8 * pPerfPerFrame )

Get the number of perforations per frame.
This method succeeds if all of the following are true:

the pPerfPerFrame pointer is valid.

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

pPerfPerFrame parameter is NULL.

Parameters:

pPerfPerFrame [out] Perforations per frame

HRESULT IAAFFilmDescriptor::SetFilmAspectRatio ( [in] aafRational_t aspectRatio )

Set the image aspect ratio.
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:

aspectRatio [in] Film Aspect Ratio

HRESULT IAAFFilmDescriptor::SetFilmFormat ( [in] aafFilmType_t filmFormat )

Sets the film format of the film.
Valid values include:

kFt35MM
kFt16MM
kFt8MM
kFt65MM

This method succeeds if all of the following are true:

formFactor represents a valid format.

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_BAD_TYPE

filmFormat is invalid.

Parameters:

filmFormat [in] Film Format

HRESULT IAAFFilmDescriptor::SetFilmManufacturer ( [in, string] aafCharacter_constptr pFilmManufacturer )

Sets the Film Manufacturer string property.
Set the FilmManufacturer property to the value specified in pFilmManufacturer. A copy is made of the data so the caller retains ownership of the *pFilmManufacturer buffer and is responsible for de-allocating it. There is no pre-set limit to the length of the name, other than available system memory or disk space.
Succeeds if all of the following are true:

the pFilmManufacturer pointer is valid.

If this method fails the FilmManufacturer 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.)

AAFRESULT_NULL_PARAM

pFilmManufacturer arg is NULL.

Parameters:

pFilmManufacturer [in, string] buffer from which FilmManufacturer is to be read

HRESULT IAAFFilmDescriptor::SetFilmModel ( [in, string] aafCharacter_constptr pFilmModel )

Sets the Film Model string property.
Set the FilmModel property to the value specified in pFilmModel. A copy is made of the data so the caller retains ownership of the *pFilmModel buffer and is responsible for de-allocating it. There is no pre-set limit to the length of the name, other than available system memory or disk space.
Succeeds if all of the following are true:

the pFilmModel pointer is valid.

If this method fails the FilmModel 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.)

AAFRESULT_NULL_PARAM

pFilmModel arg is NULL.

Parameters:

pFilmModel [in, string] buffer from which FilmModel is to be read

HRESULT IAAFFilmDescriptor::SetFrameRate ( [in] aafUInt32 rate )

Set the frame rate of the film.
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:

rate [in] Frame Rate

HRESULT IAAFFilmDescriptor::SetPerfPerFrame ( [in] aafUInt8 perfPerFrame )

Set the number of perforations per frame.
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:

perfPerFrame [in] Perforations per frame

Generated on Thu Feb 17 09:34:17 2005 for AAF COM API by

1.4.1


Public Member Functions
HRESULT	SetFilmManufacturer ([in, string] aafCharacter_constptr pFilmManufacturer)
	Sets the Film Manufacturer string property.
HRESULT	GetFilmManufacturer ([out, string, size_is(bufSize)] aafCharacter *pFilmManufacturer,[in] aafUInt32 bufSize)
	Gets the Film Manufacturer string property.
HRESULT	GetFilmManufacturerBufLen ([out] aafUInt32 *pBufSize)
	Returns size of buffer (in bytes) required for GetFilmManufacturer().
HRESULT	SetFilmModel ([in, string] aafCharacter_constptr pFilmModel)
	Sets the Film Model string property.
HRESULT	GetFilmModel ([out, string, size_is(bufSize)] aafCharacter *pFilmModel,[in] aafUInt32 bufSize)
	Gets the Film Model string property.
HRESULT	GetFilmModelBufLen ([out] aafUInt32 *pBufSize)
	Returns size of buffer (in bytes) required for GetFilmModel().
HRESULT	GetFilmFormat ([out] aafFilmType_t *pFilmFormat)
	Gets the film format.
HRESULT	GetFrameRate ([out] aafUInt32 *pRate)
	Get the frame rate of the film.
HRESULT	GetPerfPerFrame ([out] aafUInt8 *pPerfPerFrame)
	Get the number of perforations per frame.
HRESULT	GetFilmAspectRatio ([out] aafRational_t *pAspectRatio)
	Get the image aspect ratio.
HRESULT	SetFilmFormat ([in] aafFilmType_t filmFormat)
	Sets the film format of the film.
HRESULT	SetFrameRate ([in] aafUInt32 rate)
	Set the frame rate of the film.
HRESULT	SetPerfPerFrame ([in] aafUInt8 perfPerFrame)
	Set the number of perforations per frame.
HRESULT	SetFilmAspectRatio ([in] aafRational_t aspectRatio)
	Set the image aspect ratio.