Objects which support IAAFTimecodeStream specify a stream of timecode data. More...

Public Member Functions
HRESULT	GetPositionTimecode ([in] aafPosition_t position,[out] aafTimecode_t *timecode)
	Get the timecode fields at the given position.
HRESULT	SetPositionTimecode ([in] aafPosition_t position,[in] aafTimecode_t timecode)
	Set the timecode fields for a given frame.
HRESULT	GetUserDataLength ([out] aafInt32 *length)
	Gets the length of the user data for one frame.
HRESULT	GetUserDataAtPosition ([in] aafPosition_t position,[in] aafInt32 buflen,[out] aafDataBuffer_t buffer)
	Gets the user data [userbits] for a particular frame.
HRESULT	SetUserDataAtPosition ([in] aafPosition_t position,[in] aafInt32 buflen,[in] aafDataBuffer_t buffer)
	Gets the user data [userbits] for a particular frame.
HRESULT	SetSampleRate ([in] aafRational_t sampleRate)
	Sets the sample rate of the timecode data.
HRESULT	GetSampleRate ([out] aafRational_t *pSampleRate)
	Gets the sample rate of the timecode data.
HRESULT	SetSourceType ([in] aafTimecodeSourceType_t sourceType)
	Sets the type (LTC or VITC) of the timecode data.
HRESULT	GetSourceType ([out] aafTimecodeSourceType_t *pSourceType)
	Gets the type (LTC or VITC) of the timecode data.
HRESULT	GetSampleSize ([out] aafUInt32 *pSampleSize)
	Gets the size (in samples) of one sample of the timecode data.
HRESULT	GetSource ([in] aafUInt32 valueSize,[out, size_is(valueSize), length_is(bytesRead)] aafDataBuffer_t pValue,[out] aafUInt32 bytesRead)
	Writes the entire timecode data value into the pValue buffer.
HRESULT	GetSourceBufLen ([out] aafUInt32 *pLen)
	Returns the length of buffer required for the GetValue() method.
HRESULT	SetSource ([in] aafUInt32 valueSize,[in, size_is(valueSize)] aafDataBuffer_t pValue)
	The data value is set from a buffer of size valueSize.

Detailed Description

Objects which support IAAFTimecodeStream specify a stream of timecode 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.

AAFRESULT_NOT_INITIALIZED

This object has not yet had Initialize() called on it through this object's primary interface. Note that IAAFSearchSource is not a primary interface for a concrete 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 IAAFTimecodeStream also implement the following interfaces:

Definition at line 28021 of file AAF.idl.

Member Function Documentation

HRESULT IAAFTimecodeStream::GetPositionTimecode	(	[in] aafPosition_t	position,
		[out] aafTimecode_t *	timecode
	)

Get the timecode fields at the given position.

Parameters:

position	[in] Zero based offset to set the timecode at
timecode	[out] Timecode [startFrame drop fps]

HRESULT IAAFTimecodeStream::GetSampleRate ( [out] aafRational_t * pSampleRate )

Gets the sample rate of the timecode data.

Parameters:

pSampleRate [out] The sample rate of the timecode data

HRESULT IAAFTimecodeStream::GetSampleSize ( [out] aafUInt32 * pSampleSize )

Gets the size (in samples) of one sample of the timecode data.

Parameters:

pSampleSize [out] The size (in bytes) of one sample of the timecode data

HRESULT IAAFTimecodeStream::GetSource	(	[in] aafUInt32	valueSize,
		[out, size_is(valueSize), length_is(*bytesRead)] aafDataBuffer_t	pValue,
		[out] aafUInt32 *	bytesRead
	)

Writes the entire timecode data value into the pValue buffer.

The buffer is allocated by the caller, and the size of the buffer is given by valueSize.

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

Succeeds if all of the following are true:

the pValue pointer is valid.
valueSize indicates the buffer is large enough to hold the name.

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

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

pValue arg is NULL.

AAFRESULT_SMALLBUF

valueSize indicates the buffer is too small to hold the value.

Parameters:

valueSize	[in] Size of preallocated buffer
pValue	[out, size_is(valueSize),length_is(*bytesRead)] Preallocated buffer to hold value
bytesRead	[out] Number of actual bytes read

HRESULT IAAFTimecodeStream::GetSourceBufLen ( [out] aafUInt32 * pLen )

Returns the length of buffer required for the GetValue() method.

The value is placed into the location specified by pLen.

Succeeds if all of the following are true:

the pLen pointer is valid.

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

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

pLen arg is NULL.

Parameters:

pLen	[out] Pointer to an variable used to return the length

HRESULT IAAFTimecodeStream::GetSourceType ( [out] aafTimecodeSourceType_t * pSourceType )

Gets the type (LTC or VITC) of the timecode data.

Parameters:

pSourceType [out] The type (LTC or VITC) of the timecode data

HRESULT IAAFTimecodeStream::GetUserDataAtPosition	(	[in] aafPosition_t	position,
		[in] aafInt32	buflen,
		[out] aafDataBuffer_t	buffer
	)

Gets the user data [userbits] for a particular frame.

Parameters:

position	[in] Zero-based offset
buflen	[in] Length of the buffer
buffer	[out] Passed in and filled with user data

HRESULT IAAFTimecodeStream::GetUserDataLength ( [out] aafInt32 * length )

Gets the length of the user data for one frame.

Parameters:

length [out] Fixed length of the user data [userbits] in bytes

HRESULT IAAFTimecodeStream::SetPositionTimecode	(	[in] aafPosition_t	position,
		[in] aafTimecode_t	timecode
	)

Set the timecode fields for a given frame.

The frame index must be within the length of the object.

Parameters:

position	[in] Zero-based offset to set the timecode at
timecode	[in] Timecode [startFrame drop fps]

HRESULT IAAFTimecodeStream::SetSampleRate ( [in] aafRational_t sampleRate )

Sets the sample rate of the timecode data.

Parameters:

sampleRate [in] The sample rate of the timecode data

HRESULT IAAFTimecodeStream::SetSource	(	[in] aafUInt32	valueSize,
		[in, size_is(valueSize)] aafDataBuffer_t	pValue
	)

The data value is set from a buffer of size valueSize.

Succeeds if all of the following are true:

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

pValue is null.

Parameters:

valueSize	[in] Size of preallocated buffer
pValue	[in, size_is(valueSize)] buffer containing value

HRESULT IAAFTimecodeStream::SetSourceType ( [in] aafTimecodeSourceType_t sourceType )

Sets the type (LTC or VITC) of the timecode data.

Parameters:

sourceType [in] The type (LTC or VITC) of the timecode data

HRESULT IAAFTimecodeStream::SetUserDataAtPosition	(	[in] aafPosition_t	position,
		[in] aafInt32	buflen,
		[in] aafDataBuffer_t	buffer
	)

Gets the user data [userbits] for a particular frame.

Parameters:

position	[in] Zero-based offset to set the userbits at
buflen	[in] Length of the buffer
buffer	[in] user data for the given frame

Public Member Functions

Detailed Description

Member Function Documentation