CMSampleBuffer Class

Definition

Namespace:: CoreMedia

Assembly:: Microsoft.iOS.dll

Assembly:: Microsoft.MacCatalyst.dll

Assembly:: Microsoft.macOS.dll

Assembly:: Microsoft.tvOS.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A container of zero-or-more samples of a particular media type.

public class CMSampleBuffer : CoreFoundation.NativeObject, CoreMedia.ICMAttachmentBearer

type CMSampleBuffer = class
    inherit NativeObject
    interface ICMAttachmentBearer
    interface INativeObject

Inheritance: Object

DisposableObject

NativeObject
CMSampleBuffer

Implements: ICMAttachmentBearer INativeObject

Properties

Name	Description
DataIsReady
DecodeTimeStamp
Duration
Handle	(Inherited from DisposableObject)
IsValid
NumSamples
OutputDecodeTimeStamp
OutputDuration
OutputPresentationTimeStamp
Owns	(Inherited from DisposableObject)
PresentationTimeStamp
TaggedBufferGroup	Get this sample buffer's tagged buffer group.
TotalSampleSize

Methods

Name	Description
CallForEachSample(Func<CMSampleBuffer,Int32,CMSampleBufferError>)
ClearHandle()	(Inherited from DisposableObject)
CopyPCMDataIntoAudioBufferList(Int32, Int32, AudioBuffers)
CreateForImageBuffer(CVImageBuffer, Boolean, CMVideoFormatDescription, CMSampleTimingInfo, CMSampleBufferError)
CreateReady(CMBlockBuffer, CMFormatDescription, Int32, CMSampleTimingInfo[], UIntPtr[], CMSampleBufferError)
CreateReadyWithImageBuffer(CVImageBuffer, CMFormatDescription, CMSampleTimingInfo, CMSampleBufferError)
CreateReadyWithPacketDescriptions(CMBlockBuffer, CMFormatDescription, Int32, CMTime, AudioStreamPacketDescription[], CMSampleBufferError)
CreateWithNewTiming(CMSampleBuffer, CMSampleTimingInfo[], Int32)
CreateWithNewTiming(CMSampleBuffer, CMSampleTimingInfo[], IntPtr)
CreateWithNewTiming(CMSampleBuffer, CMSampleTimingInfo[])	Clones a sample buffer, using the provided timing information.
CreateWithPacketDescriptions(CMBlockBuffer, CMFormatDescription, Int32, CMTime, AudioStreamPacketDescription[], CMSampleBufferError)
Dispose()	(Inherited from DisposableObject)
Dispose(Boolean)	Releases the resources used by the CMSampleBuffer object.
Equals(Object)	(Inherited from DisposableObject)
GetAudioFormatDescription()
GetCheckedHandle()	(Inherited from DisposableObject)
GetDataBuffer()
GetHashCode()	(Inherited from DisposableObject)
GetImageBuffer()
GetSampleAttachments(Boolean)
GetSampleSize(IntPtr)
GetSampleTimingInfo()	Fetches the timing information for the sample buffer.
GetSampleTimingInfo(Int32)
GetSampleTimingInfo(IntPtr)
GetTypeID()	Type identifier for the CoreMedia.CMSampleBuffer type.
GetVideoFormatDescription()
InitializeHandle(NativeHandle)	(Inherited from DisposableObject)
Invalidate()
MakeDataReady()
Release()	(Inherited from NativeObject)
Retain()	(Inherited from NativeObject)
SetDataBuffer(CMBlockBuffer)
SetDataReady()
SetInvalidateCallback(Action<CMSampleBuffer>)
TrackDataReadiness(CMSampleBuffer)

Extension Methods

Name	Description
GetAttachment<T>(ICMAttachmentBearer, CMSampleBufferAttachmentKey, CMAttachmentMode)
GetAttachment<T>(ICMAttachmentBearer, String, CMAttachmentMode)	Returns the attachment that is identifed by `key` and writes the attachment propagation mode to `attachmentModeOut`.
GetAttachments(ICMAttachmentBearer, CMAttachmentMode)	Returns an array of all the bearer's attachments and the attachment propagation mode to `attachmentMode`.
GetAttachments<TKey,TValue>(ICMAttachmentBearer, CMAttachmentMode)
PropagateAttachments(ICMAttachmentBearer, ICMAttachmentBearer)	Propagates the attachments that belong to `source` and are allowed to propagate to `destination`.
RemoveAllAttachments(ICMAttachmentBearer)	Removes all of `target`'s attachment.'
RemoveAttachment(ICMAttachmentBearer, String)	Removes the attachment that is identifed by `key`.
SetAttachment(ICMAttachmentBearer, String, INativeObject, CMAttachmentMode)	Attaches `value` to the bearer with the specified `key` and `attachmentMode`.
SetAttachments(ICMAttachmentBearer, NSDictionary, CMAttachmentMode)	Attaches `theAttachments` to the bearer with the specified `attachmentMode`.
GetHandle(INativeObject)
GetNonNullHandle(INativeObject, String)

Applies to

Share via