Contents

CMSampleBufferGetAudioStreamPacketDescriptionsPtr(_:packetDescriptionsPointerOut:sizeOut:)

Returns a pointer to a constant array of audio stream packet descriptions.

Declaration

func CMSampleBufferGetAudioStreamPacketDescriptionsPtr(_ sbuf: CMSampleBuffer, packetDescriptionsPointerOut: UnsafeMutablePointer<UnsafePointer<AudioStreamPacketDescription>?>?, sizeOut packetDescriptionsSizeOut: UnsafeMutablePointer<Int>?) -> OSStatus

Parameters

  • sbuf:

    The CMSampleBuffer being modified.

  • packetDescriptionsPointerOut:

    On output, contains pointer to a constant array of AudioStreamPacketDescriptions. May be NULL.

  • packetDescriptionsSizeOut:

    Size in bytes of constant array of AudioStreamPacketDescriptions. May be NULL.

Return Value

A result code. See Sample Buffer Error Codes.

Discussion

Returns a pointer to (and size of) a constant array of AudioStreamPacketDescriptions for the variable bytes per packet or variable frames per packet audio data in the provided CMSampleBuffer. The pointer will remain valid as long as the buffer continues to be retained.

Constant bit rate, constant frames-per-packet audio yields a return value of noErr and no packet descriptions.

This API is specific to audio format sample buffers, and will return kCMSampleBufferError_InvalidMediaTypeForOperation if called with a non-audio sample buffer.

See Also

Modifying Sample Buffers