The IAAFTapeDescriptor interface is implemented by objects which describe audio tape or videotape media. More...

Public Member Functions
HRESULT	Initialize ()
	Initializes a newly allocated, empty IAAFTapeDescriptor-supporting object.
HRESULT	SetTapeManufacturer ([in, string] aafCharacter_constptr pTapeManufacturer)
	Sets the Tape Manufacturer string property.
HRESULT	GetTapeManufacturer ([out, string, size_is(bufSize)] aafCharacter *pTapeManufacturer,[in] aafUInt32 bufSize)
	Gets the Tape Manufacturer string property.
HRESULT	GetTapeManufacturerBufLen ([out] aafUInt32 *pBufSize)
	Returns size of buffer (in bytes) required for GetTapeManufacturer().
HRESULT	SetTapeModel ([in, string] aafCharacter_constptr pTapeModel)
	Sets the Tape Model string property.
HRESULT	GetTapeModel ([out, string, size_is(bufSize)] aafCharacter *pTapeModel,[in] aafUInt32 bufSize)
	Gets the Tape Model string property.
HRESULT	GetTapeModelBufLen ([out] aafUInt32 *pBufSize)
	Returns size of buffer (in bytes) required for GetTapeModel().
HRESULT	SetTapeFormFactor ([in] aafTapeCaseType_t formFactor)
	Sets the form factor [case size] of the tape.
HRESULT	GetTapeFormFactor ([out] aafTapeCaseType_t *formFactor)
	Gets the form factor [case size] of the tape.
HRESULT	SetSignalType ([in] aafVideoSignalType_t videoSignal)
	Sets the signal standard recorded on the tape.
HRESULT	GetSignalType ([out] aafVideoSignalType_t *pVideoSignal)
	Gets the signal standard recorded on the tape.
HRESULT	SetTapeFormat ([in] aafTapeFormatType_t tapeFormat)
	Sets the recording method of the tape.
HRESULT	GetTapeFormat ([out] aafTapeFormatType_t *pTapeFormat)
	Gets the recording method of the tape.
HRESULT	SetTapeLength ([in] aafUInt32 tapeLength)
	Sets the length of the tape in minutes.
HRESULT	GetTapeLength ([out] aafUInt32 *pTapeLength)
	Gets the length of the tape in minutes.

Detailed Description

The IAAFTapeDescriptor interface is implemented by objects which describe audio tape or videotape media.

A TapeDescriptor 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 IAAFTapeDescriptor also implement the following interfaces:

IAAFEssenceDescriptor

IAAFObject

Definition at line 27209 of file AAF.idl.

Member Function Documentation

HRESULT IAAFTapeDescriptor::GetSignalType ( [out] aafVideoSignalType_t * pVideoSignal )

Gets the signal standard recorded on the tape.

This method succeeds if all of the following are true:

the pVideoSignal pointer is valid.

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

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

pVideoSignal arg is NULL.

Parameters:

pVideoSignal [out] ex: kNTSCSignal

HRESULT IAAFTapeDescriptor::GetTapeFormat ( [out] aafTapeFormatType_t * pTapeFormat )

Gets the recording method of the tape.

Succeeds if all of the following are true:

the pTapeFormat pointer is valid.

This method succeeds if all of the following are true:

the pTapeFormat 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

pTapeFormat arg is NULL.

Parameters:

pTapeFormat [out] ex: kBetacamFormat, kBetacamSPFormat

HRESULT IAAFTapeDescriptor::GetTapeFormFactor ( [out] aafTapeCaseType_t * formFactor )

Gets the form factor [case size] of the tape.

This method succeeds if all of the following are true:

the pFormFactor 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

pFormFactor arg is NULL.

Parameters:

formFactor [out] ex: kVHSVideoTape, kDATCartridge

HRESULT IAAFTapeDescriptor::GetTapeLength ( [out] aafUInt32 * pTapeLength )

Gets the length of the tape in minutes.

This method succeeds if all of the following are true:

the pTapeLength pointer is valid.

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

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

pTapeLength arg is NULL.

Parameters:

pTapeLength [out] The length of the tape in minutes.

HRESULT IAAFTapeDescriptor::GetTapeManufacturer	(	[out, string, size_is(bufSize)] aafCharacter *	pTapeManufacturer,
		[in] aafUInt32	bufSize
	)

Gets the Tape Manufacturer string property.

Writes the TapeManufacturer property, with a trailing null character, into the pTapeManufacturer buffer. The buffer is allocated by the caller. The size of the buffer is given by bufSize. If the TapeManufacturer property has not yet been set, a zero-length string will be written (that is, only the trailing null character).

Caller may call GetTapeManufacturerBufLen() to determine the required buffer size.

If this method fails nothing will be written to pTapeManufacturer.

Succeeds if:

The pTapeManufacturer pointer is valid.
bufSize indicates that the buffer is large enough to hold TapeManufacturer.

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

pTapeManufacturer arg is NULL.

AAFRESULT_SMALL_BUF

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

Parameters:

pTapeManufacturer	[out, string, size_is(bufSize)] buffer into which TapeManufacturer is to be written
bufSize	[in] size of *pTapeManufacturer buffer in bytes

HRESULT IAAFTapeDescriptor::GetTapeManufacturerBufLen ( [out] aafUInt32 * pBufSize )

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

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 IAAFTapeDescriptor::GetTapeModel	(	[out, string, size_is(bufSize)] aafCharacter *	pTapeModel,
		[in] aafUInt32	bufSize
	)

Gets the Tape Model string property.

Writes the TapeModel property, with a trailing null character, into the pTapeModel buffer. The buffer is allocated by the caller. The size of the buffer is given by bufSize. If the TapeModel property has not yet been set, a zero-length string will be written (that is, only the trailing null character).

Caller may call GetTapeModelBufLen() to determine the required buffer size.

If this method fails nothing will be written to pTapeModel.

Succeeds if:

The pTapeModel pointer is valid.
bufSize indicates that the buffer is large enough to hold TapeModel.

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

pTapeModel arg is NULL.

AAFRESULT_SMALL_BUF

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

Parameters:

pTapeModel	[out, string, size_is(bufSize)] buffer into which TapeModel is to be written
bufSize	[in] size of *pTapeModel buffer in bytes

HRESULT IAAFTapeDescriptor::GetTapeModelBufLen ( [out] aafUInt32 * pBufSize )

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

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 IAAFTapeDescriptor::Initialize ( )

Initializes a newly allocated, empty IAAFTapeDescriptor-supporting object.

This method must be called after allocation, and before any other method can be called.

Succeeds if:

Initialize() has not yet been called on this object.

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_ALREADY_INITIALIZED

Initialize() has already been called on this object.

HRESULT IAAFTapeDescriptor::SetSignalType ( [in] aafVideoSignalType_t videoSignal )

Sets the signal standard recorded on the tape.

This method succeeds if all of the following are true: videoSignal represents a valid video signal type.

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

videoSignal is invalid.

Parameters:

videoSignal [in] ex: kNTSCSignal

HRESULT IAAFTapeDescriptor::SetTapeFormat ( [in] aafTapeFormatType_t tapeFormat )

Sets the recording method of the tape.

This method succeeds if all of the following are true:

tapeFormat represents a valid tape format type.

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

tapeFormat is invalid.

Parameters:

tapeFormat [in] ex: kBetacamFormat, kBetacamSPFormat

HRESULT IAAFTapeDescriptor::SetTapeFormFactor ( [in] aafTapeCaseType_t formFactor )

Sets the form factor [case size] of the tape.

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

formFactor is invalid.

Parameters:

formFactor [in] ex: kVHSVideoTape, kDATCartridge

HRESULT IAAFTapeDescriptor::SetTapeLength ( [in] aafUInt32 tapeLength )

Sets the length of the tape in minutes.

This method succeeds if all of the following are true:

tapeLength is a positive number.

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_LENGTH

tapeLength is negative.

Parameters:

tapeLength [in] The length of the tape in minutes.

HRESULT IAAFTapeDescriptor::SetTapeManufacturer ( [in, string] aafCharacter_constptr pTapeManufacturer )

Sets the Tape Manufacturer string property.

Set the TapeManufacturer property to the value specified in pTapeManufacturer. A copy is made of the data so the caller retains ownership of the *pTapeManufacturer 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 pTapeManufacturer pointer is valid.

If this method fails the TapeManufacturer 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

pTapeManufacturer arg is NULL.

Parameters:

pTapeManufacturer [in, string] buffer from which TapeManufacturer is to be read

HRESULT IAAFTapeDescriptor::SetTapeModel ( [in, string] aafCharacter_constptr pTapeModel )

Sets the Tape Model string property.

Set the TapeModel property to the value specified in pTapeModel. A copy is made of the data so the caller retains ownership of the *pTapeModel 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 pTapeModel pointer is valid.

If this method fails the TapeModel 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

pTapeModel arg is NULL.

Parameters:

pTapeModel [in, string] buffer from which TapeModel is to be read

Public Member Functions

Detailed Description

Member Function Documentation