Function

CMSampleBufferGetSampleTimingInfo

Retrieves a CMSampleTimingInfo struct describing a specified sample in a CMSampleBuffer.

Declaration

OSStatus CMSampleBufferGetSampleTimingInfo(CMSampleBufferRef sbuf, CMItemIndex sampleIndex, CMSampleTimingInfo *timingInfoOut);

Parameters

sbuf

The CMSampleBuffer being interrogated.

sampleIndex

Sample index (0 is the first sample in sbuf).

timingInfoOut

On output, points to a single CMSampleTimingInfo struct to receive the timing info.

Return Value

A result code. See Result Codes.

Discussion

A sample-specific CMSampleTimingInfo struct will be returned (i.e. with a sample-specific presentationTimeStamp and decodeTimeStamp), even if a single CMSampleTimingInfo struct was used during creation to describe all the samples in the buffer. The timing info struct must be allocated by the caller. If the sample index is not in the range 0...numSamples-1, CMSampleBuffer will be returned. If there is no timingInfo in this CMSampleBuffer, CMSampleBuffer will be returned.

See Also

Inspecting Sample Buffers

CMSampleBufferGetDataBuffer

Returns a CMSampleBuffer's CMBlockBuffer of media data.

CMSampleBufferGetDecodeTimeStamp

Returns the numerically earliest decode timestamp of all the samples in a CMSampleBuffer.

CMSampleBufferGetDuration

Returns the total duration of a CMSampleBuffer.

CMSampleBufferGetFormatDescription

Returns the format description of the samples in a CMSampleBuffer.

CMSampleBufferGetImageBuffer

Returns a sample buffer's CVImageBuffer of media data.

CMSampleBufferGetNumSamples

Returns the number of media samples in a CMSampleBuffer.

CMSampleBufferGetOutputDecodeTimeStamp

Returns the output decode timestamp of the CMSampleBuffer.

CMSampleBufferGetOutputDuration

Returns the output duration of a CMSampleBuffer.

CMSampleBufferGetOutputPresentationTimeStamp

Returns the output presentation timestamp of the CMSampleBuffer.

CMSampleBufferGetOutputSampleTimingInfoArray

Retrieves an array of output CMSampleTimingInfo structs, one for each sample in a CMSampleBuffer.

CMSampleBufferGetPresentationTimeStamp

Returns the numerically earliest presentation timestamp of all the samples in a CMSampleBuffer.

CMSampleBufferGetSampleAttachmentsArray

Returns a reference to a CMSampleBuffer's immutable array of mutable sample attachments dictionaries (one dictionary per sample in the CMSampleBuffer).

CMSampleBufferGetSampleSize

Returns the size in bytes of a specified sample in a CMSampleBuffer.

CMSampleBufferGetSampleSizeArray

Retrieves an array of sample sizes, one for each sample in a CMSampleBuffer.

CMSampleBufferGetSampleTimingInfoArray

Retrieves an array of CMSampleTimingInfo structs, one for each sample in a CMSampleBuffer.

CMSampleBufferGetTotalSampleSize

Returns the total size in bytes of sample data in a CMSampleBuffer.

CMSampleBufferHasDataFailed

Indicates if the sample buffer's data loading request has failed.

CMSampleBufferDataIsReady

Determines if the sample buffer's data is ready.

CMSampleBufferIsValid

Queries whether a sample buffer is still valid.

CMSampleBufferGetTypeID

Returns the CFTypeID of CMSampleBuffer objects.