IAAFPlainEssenceData Interface Reference

This is a default inerface for a class used to provide access to file encoding-independent stream data. More...

List of all members.

Public Member Functions
HRESULT	Initialize ([in] IAAFSourceMob *pFileMob)
	Associates a weak reference to the given file mob with the essence data.
HRESULT	Write ([in] aafUInt32 bytes,[out, size_is(bytes)] aafDataBuffer_t buffer,[out, ref] aafUInt32 *bytesWritten)
	Write pre-interleaved data to a essence stream.
HRESULT	Read ([in] aafUInt32 bytes,[out, size_is(bytes), length_is(*bytesRead)] aafDataBuffer_t buffer,[out, ref] aafUInt32 *bytesRead)
	Read pre-interleaved data from a essence stream.
HRESULT	SetPosition ([in] aafPosition_t offset)
	Seek to absolute position within the essence data.
HRESULT	GetPosition ([out] aafPosition_t *pOffset)
	Get the absolute position within the essence data.
HRESULT	GetSize ([out] aafLength_t *pSize)
	Return the total size of the essence data.
HRESULT	WriteSampleIndex ([in] aafUInt32 bytes,[out, size_is(bytes)] aafDataBuffer_t buffer,[out, ref] aafUInt32 *bytesWritten)
	Write pre-interleaved data to a sample index stream.
HRESULT	ReadSampleIndex ([in] aafUInt32 bytes,[out, size_is(bytes), length_is(*bytesRead)] aafDataBuffer_t buffer,[out, ref] aafUInt32 *bytesRead)
	Read pre-interleaved data from a sample index stream.
HRESULT	SetSampleIndexPosition ([in] aafPosition_t offset)
	Seek to absolute position within the sample index data.
HRESULT	GetSampleIndexPosition ([out] aafPosition_t *pOffset)
	Get the absolute position within the sample index data.
HRESULT	GetSampleIndexSize ([out] aafLength_t *pSize)
	Return the total size of the sample index data.
HRESULT	SetFileMob ([in] IAAFSourceMob *pFileMob)
	Associates a weak reference to the given file mob with the essence data.
HRESULT	GetFileMob ([in] IAAFSourceMob **ppFileMob)
	Associates a weak reference to the given file mob with the essence data.
HRESULT	GetFileMobID ([out] aafMobID_t *pFileMobID)
	Return the mob id used to find the file mob associated with this essence.

---

Detailed Description

This is a default inerface for a class used to provide access to file encoding-independent stream data.

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

• IAAFKLVEssenceDataParameters

Definition at line 19627 of file AAF.idl.

---

Member Function Documentation

HRESULT IAAFPlainEssenceData::GetFileMob

(

[in] IAAFSourceMob **

ppFileMob

)

Associates a weak reference to the given file mob with the essence data.

Succeeds if all of the following are true:

• the ppFileMob pointer is valid and a weak reference to the associated file mob can be resolved.

If this method fails no state will 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

• ppFileMob is null.

Parameters:

ppFileMob

[in] reference to a file mob

HRESULT IAAFPlainEssenceData::GetFileMobID

(

[out] aafMobID_t *

pFileMobID

)

Return the mob id used to find the file mob associated with this essence.

The file mob must exist in the same file as this essence data.

Parameters:

pFileMobID

[out] the file mob id associated with essence

HRESULT IAAFPlainEssenceData::GetPosition

(

[out] aafPosition_t *

pOffset

)

Get the absolute position within the essence data.

Parameters:

pOffset

[out] offset from beginning of essence

HRESULT IAAFPlainEssenceData::GetSampleIndexPosition

(

[out] aafPosition_t *

pOffset

)

Get the absolute position within the sample index data.

Parameters:

pOffset

[out] offset from beginning of sample index

HRESULT IAAFPlainEssenceData::GetSampleIndexSize

(

[out] aafLength_t *

pSize

)

Return the total size of the sample index data.

Parameters:

pSize

[out] size of sample index data

HRESULT IAAFPlainEssenceData::GetSize

(

[out] aafLength_t *

pSize

)

Return the total size of the essence data.

Parameters:

pSize

[out] size of essence data

HRESULT IAAFPlainEssenceData::Initialize

(

[in] IAAFSourceMob *

pFileMob

)

Associates a weak reference to the given file mob with the essence data.

Succeeds if all of the following are true:

• the pFileMob pointer is valid and points to a file mob (contains a file descriptor).

If this method fails no state will 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

• pFileMob is null.

Parameters:

pFileMob

[in] reference to a file mob

HRESULT IAAFPlainEssenceData::Read	(	[in] aafUInt32	bytes,
		[out, size_is(bytes), length_is(*bytesRead)] aafDataBuffer_t	buffer,
		[out, ref] aafUInt32 *	bytesRead
	)

Read pre-interleaved data from a essence stream.

Parameters:

bytes	[in] read this many bytes
buffer	[out, size_is(bytes), length_is(*bytesRead)] here is the buffer
bytesRead	[out,ref]

HRESULT IAAFPlainEssenceData::ReadSampleIndex	(	[in] aafUInt32	bytes,
		[out, size_is(bytes), length_is(*bytesRead)] aafDataBuffer_t	buffer,
		[out, ref] aafUInt32 *	bytesRead
	)

Read pre-interleaved data from a sample index stream.

Parameters:

bytes	[in] read this many bytes from the sample index stream
buffer	[out, size_is(bytes), length_is(*bytesRead)] here is the buffer
bytesRead	[out,ref]

HRESULT IAAFPlainEssenceData::SetFileMob

(

[in] IAAFSourceMob *

pFileMob

)

Associates a weak reference to the given file mob with the essence data.

Succeeds if all of the following are true:

• the pFileMob pointer is valid and points to a file mob (contains a file descriptor).

If this method fails no state will 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

• pFileMob is null.

Parameters:

pFileMob

[in] reference to a file mob

HRESULT IAAFPlainEssenceData::SetPosition

(

[in] aafPosition_t

offset

)

Seek to absolute position within the essence data.

Parameters:

offset

[in] offset from beginning of essence

HRESULT IAAFPlainEssenceData::SetSampleIndexPosition

(

[in] aafPosition_t

offset

)

Seek to absolute position within the sample index data.

Parameters:

offset

[in] offset from beginning of sample index

HRESULT IAAFPlainEssenceData::Write	(	[in] aafUInt32	bytes,
		[out, size_is(bytes)] aafDataBuffer_t	buffer,
		[out, ref] aafUInt32 *	bytesWritten
	)

Write pre-interleaved data to a essence stream.

Parameters:

bytes	[in] write this many bytes
buffer	[out, size_is(bytes)] here is the buffer
bytesWritten	[out,ref]

HRESULT IAAFPlainEssenceData::WriteSampleIndex	(	[in] aafUInt32	bytes,
		[out, size_is(bytes)] aafDataBuffer_t	buffer,
		[out, ref] aafUInt32 *	bytesWritten
	)

Write pre-interleaved data to a sample index stream.

Parameters:

bytes	[in] write this many bytes to the sample index stream
buffer	[out, size_is(bytes)] here is the buffer
bytesWritten	[out,ref]