IAAFMPEGVideoDescriptor Interface Reference

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

List of all members.

Public Member Functions
HRESULT	Initialize ()
	Initializes a newly allocated, empty IAAFMPEGVideoDescriptor-supporting object.
HRESULT	SetSingleSequence ([in] aafBoolean_t singleSequence)
	Sets the SingleSequence property.
HRESULT	GetSingleSequence ([out] aafBoolean_t *pSingleSequence)
	Gets the SingleSequence property.
HRESULT	SetConstantBPictureCount ([in] aafBoolean_t constantBPictureCount)
	Sets the ConstantBPictureCount property.
HRESULT	GetConstantBPictureCount ([out] aafBoolean_t *pConstantBPictureCount)
	Gets the ConstantBPictureCount property.
HRESULT	SetCodedContentScanning ([in] aafContentScanningType_t codedContentScanning)
	Sets the CodedContentScanning property.
HRESULT	GetCodedContentScanning ([out] aafContentScanningType_t *pContentScanning)
	Gets the CodedContentScanning property.
HRESULT	SetLowDelay ([in] aafBoolean_t lowDelay)
	Sets the LowDelay property.
HRESULT	GetLowDelay ([out] aafBoolean_t *pLowDelay)
	Gets the LowDelay property.
HRESULT	SetClosedGOP ([in] aafBoolean_t closedGOP)
	Sets the ClosedGOP property.
HRESULT	GetClosedGOP ([out] aafBoolean_t *pClosedGOP)
	Gets the ClosedGOP property.
HRESULT	SetIdenticalGOP ([in] aafBoolean_t identicalGOP)
	Sets the IdenticalGOP property.
HRESULT	GetIdenticalGOP ([out] aafBoolean_t *pIdenticalGOP)
	Gets the IdenticalGOP property.
HRESULT	SetMaxGOP ([in] aafUInt16 maxGOP)
	Sets the MaxGOP property.
HRESULT	GetMaxGOP ([out] aafUInt16 *pMaxGOP)
	Gets the MaxGOP property.
HRESULT	SetMaxBPictureCount ([in] aafUInt16 maxBPictureCount)
	Sets the MaxBPictureCount property.
HRESULT	GetMaxBPictureCount ([out] aafUInt16 *pMaxBPictureCount)
	Gets the MaxBPictureCount property.
HRESULT	SetBitRate ([in] aafUInt32 bitRate)
	Sets the BitRate property.
HRESULT	GetBitRate ([out] aafUInt32 *pBitRate)
	Gets the BitRate property.
HRESULT	SetProfileAndLevel ([in] aafUInt8 profileAndLevel)
	Sets the ProfileAndLevel property.
HRESULT	GetProfileAndLevel ([out] aafUInt8 *pProfileAndLevel)
	Gets the ProfileAndLevele property.

---

Detailed Description

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 IAAFMPEGVideoDescriptor also implement the following interfaces:

• IAAFCDCIDescriptor
• IAAFCDCIDescriptor2
• IAAFDigitalImageDescriptor
• IAAFDigitalImageDescriptor2
• IAAFFileDescriptor
• IAAFFileDescriptor2
• IAAFEssenceDescriptor
• IAAFObject

Definition at line 15329 of file AAF.idl.

---

Member Function Documentation

HRESULT IAAFMPEGVideoDescriptor::GetBitRate

(

[out] aafUInt32 *

pBitRate

)

Gets the BitRate property.

Succeeds if all of the following are true:

• pBitRate is a valid pointer
• the property is present.

If this method fails, pBitRate will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

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

AAFRESULT_NULL_PARAM

• pBitRate is NULL.

AAFRESULT_PROP_NOT_PRESENT

• the property is not present.

Parameters:

pBitRate

[out] value of the BitRate property

HRESULT IAAFMPEGVideoDescriptor::GetClosedGOP

(

[out] aafBoolean_t *

pClosedGOP

)

Gets the ClosedGOP property.

Succeeds if all of the following are true:

• pClosedGOP is a valid pointer
• the property is present.

If this method fails, pClosedGOP will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

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

AAFRESULT_NULL_PARAM

• pClosedGOP is NULL.

AAFRESULT_PROP_NOT_PRESENT

• the property is not present.

Parameters:

pClosedGOP

[out] value of the ClosedGOP property

HRESULT IAAFMPEGVideoDescriptor::GetCodedContentScanning

(

[out] aafContentScanningType_t *

pContentScanning

)

Gets the CodedContentScanning property.

This property is optional.

Succeeds if all of the following are true:

• pContentScanning is a valid pointer
• the property is present.

If this method fails, pSContentScanning not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

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

AAFRESULT_NULL_PARAM

• pContentScanning is NULL.

AAFRESULT_PROP_NOT_PRESENT

• the property is not present.

Parameters:

pContentScanning

[out] Coded content scanning value.

HRESULT IAAFMPEGVideoDescriptor::GetConstantBPictureCount

(

[out] aafBoolean_t *

pConstantBPictureCount

)

Gets the ConstantBPictureCount property.

Succeeds if all of the following are true:

• pConstantBPictureCount is a valid pointer
• the property is present.

If this method fails, pConstantBPictureCount will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

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

AAFRESULT_NULL_PARAM

• pSingleSequence is NULL.

AAFRESULT_PROP_NOT_PRESENT

• the property is not present.

Parameters:

pConstantBPictureCount

[out] value of the ConstantBPictureCount property

HRESULT IAAFMPEGVideoDescriptor::GetIdenticalGOP

(

[out] aafBoolean_t *

pIdenticalGOP

)

Gets the IdenticalGOP property.

Succeeds if all of the following are true:

• pIdenticalGOP is a valid pointer
• the property is present.

If this method fails, pIdenticalGOP will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

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

AAFRESULT_NULL_PARAM

• pIdenticalGOP is NULL.

AAFRESULT_PROP_NOT_PRESENT

• the property is not present.

Parameters:

pIdenticalGOP

[out] value of the IdenticalGOP property

HRESULT IAAFMPEGVideoDescriptor::GetLowDelay

(

[out] aafBoolean_t *

pLowDelay

)

Gets the LowDelay property.

Succeeds if all of the following are true:

• pLowDelay is a valid pointer
• the property is present.

If this method fails, pLowDelay will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

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

AAFRESULT_NULL_PARAM

• pLowDelay is NULL.

AAFRESULT_PROP_NOT_PRESENT

• the property is not present.

Parameters:

pLowDelay

[out] value of the LowDelay property

HRESULT IAAFMPEGVideoDescriptor::GetMaxBPictureCount

(

[out] aafUInt16 *

pMaxBPictureCount

)

Gets the MaxBPictureCount property.

Succeeds if all of the following are true:

• pMaxBPictureCount is a valid pointer
• the property is present.

If this method fails, pMaxBPictureCount will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

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

AAFRESULT_NULL_PARAM

• pMaxBPictureCount is NULL.

AAFRESULT_PROP_NOT_PRESENT

• the property is not present.

Parameters:

pMaxBPictureCount

[out] valud of the MaxBPictureCount property

HRESULT IAAFMPEGVideoDescriptor::GetMaxGOP

(

[out] aafUInt16 *

pMaxGOP

)

Gets the MaxGOP property.

Succeeds if all of the following are true:

• pMaxGOP is a valid pointer
• the property is present.

If this method fails, pMaxGOP will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

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

AAFRESULT_NULL_PARAM

• pMaxGOP is NULL.

AAFRESULT_PROP_NOT_PRESENT

• the property is not present.

Parameters:

pMaxGOP

[out] value of the MaxGOP property

HRESULT IAAFMPEGVideoDescriptor::GetProfileAndLevel

(

[out] aafUInt8 *

pProfileAndLevel

)

Gets the ProfileAndLevele property.

Succeeds if all of the following are true:

• pProfileAndLevel is a valid pointer
• the property is present.

If this method fails, pProfileAndLevel will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

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

AAFRESULT_NULL_PARAM

• pProfileAndLevel is NULL.

AAFRESULT_PROP_NOT_PRESENT

• the property is not present.

Parameters:

pProfileAndLevel

[out] value of the ProfileAndLevel property

HRESULT IAAFMPEGVideoDescriptor::GetSingleSequence

(

[out] aafBoolean_t *

pSingleSequence

)

Gets the SingleSequence property.

Succeeds if all of the following are true:

• pSingleSequence is a valid pointer
• the property is present.

If this method fails, pSingleSequence will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

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

AAFRESULT_NULL_PARAM

• pSingleSequence is NULL.

AAFRESULT_PROP_NOT_PRESENT

• the property is not present.

Parameters:

pSingleSequence

[out] The value of the SingleSequence property

HRESULT IAAFMPEGVideoDescriptor::Initialize

(

)

Initializes a newly allocated, empty IAAFMPEGVideoDescriptor-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 IAAFMPEGVideoDescriptor::SetBitRate

(

[in] aafUInt32

bitRate

)

Sets the BitRate property.

This is an optional property.

If this method fails, the BitRate property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

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

Parameters:

bitRate

[in] value to assign to the BitRate property

HRESULT IAAFMPEGVideoDescriptor::SetClosedGOP

(

[in] aafBoolean_t

closedGOP

)

Sets the ClosedGOP property.

This property is optional.

If this method fails, the ClosedGOP property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

• succeeded.

Parameters:

closedGOP

[in] value to assign to the ClosedGOP property

HRESULT IAAFMPEGVideoDescriptor::SetCodedContentScanning

(

[in] aafContentScanningType_t

codedContentScanning

)

Sets the CodedContentScanning property.

This property is optional.

Succeeds if all of the following are true:

• codedContentDirection is a valid value.

If this method fails, the CodedContentScanning property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

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

AAFRESULT_AAFRESULT_INVALID_ENUM_VALUE

• codedContentDirection is not a valid value.

Parameters:

codedContentScanning

[in] Coded Content Scanning value.

HRESULT IAAFMPEGVideoDescriptor::SetConstantBPictureCount

(

[in] aafBoolean_t

constantBPictureCount

)

Sets the ConstantBPictureCount property.

This property is optional.

If this method fails, the ConstantBPictureCount property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

• succeeded.

Parameters:

constantBPictureCount

[in] value to assign to the ConstantBPictureCount property

HRESULT IAAFMPEGVideoDescriptor::SetIdenticalGOP

(

[in] aafBoolean_t

identicalGOP

)

Sets the IdenticalGOP property.

This is an optional property.

If this method fails, the IdenticalGOP property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

• succeeded.

Parameters:

identicalGOP

[in] value to assign to the IdenticalGOP property

HRESULT IAAFMPEGVideoDescriptor::SetLowDelay

(

[in] aafBoolean_t

lowDelay

)

Sets the LowDelay property.

This property is optional.

If this method fails, the LowDelay property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

• succeeded.

Parameters:

lowDelay

[in] value to assign to the LowDelay property

HRESULT IAAFMPEGVideoDescriptor::SetMaxBPictureCount

(

[in] aafUInt16

maxBPictureCount

)

Sets the MaxBPictureCount property.

This is an optional property.

If this method fails, the MaxBPictureCount property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

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

Parameters:

maxBPictureCount

[in] value to assign to the MaxBPictureCount property

HRESULT IAAFMPEGVideoDescriptor::SetMaxGOP

(

[in] aafUInt16

maxGOP

)

Sets the MaxGOP property.

This is an optional property.

If this method fails, the MaxGOP property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

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

Parameters:

maxGOP

[in] value to assign to the MaxGOP property

HRESULT IAAFMPEGVideoDescriptor::SetProfileAndLevel

(

[in] aafUInt8

profileAndLevel

)

Sets the ProfileAndLevel property.

This is an optional property.

If this method fails, the ProfileAndLevel property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

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

Parameters:

profileAndLevel

[in] value to assign to the ProfileAndLevel property

HRESULT IAAFMPEGVideoDescriptor::SetSingleSequence

(

[in] aafBoolean_t

singleSequence

)

Sets the SingleSequence property.

This property is optional.

If this method fails, the SingleSequence property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

• succeeded.

Parameters:

singleSequence

[in] value to assign to the SingleSequence property