CoreMedia · IOS API REFERENCE

CMSampleBuffer.Error

struct · iOS 13.0+ · SDK 27.1

struct Error

CMFormatDescription Errors

Members (17)

get · iOS 13.0+

alreadyHasDataBuffer

TypeScript

static get alreadyHasDataBuffer(): _Foundation_NSError

Swift declaration

static let alreadyHasDataBuffer: NSError

Attempt was made to set a `dataBuffer` on a `CMSampleBuffer` that already has one.

get · iOS 13.0+

invalidMediaTypeForOperation

TypeScript

static get invalidMediaTypeForOperation(): _Foundation_NSError

Swift declaration

static let invalidMediaTypeForOperation: NSError

The media type specified by a format description is not valid for the given operation (eg. a `CMSampleBuffer` with a non-audio format description passed to `withUnsafeAudioStreamPacketDescriptions()`).

get · iOS 13.0+

invalidMediaFormat

TypeScript

static get invalidMediaFormat(): _Foundation_NSError

Swift declaration

static let invalidMediaFormat: NSError

The format of the given media does not match the given format description (eg. a format description paired with a `CVImageBuffer` that fails `matchesImageBuffer()`).

get · iOS 13.0+

dataFailed

TypeScript

static get dataFailed(): _Foundation_NSError

Swift declaration

static let dataFailed: NSError

The sample buffer's data loading operation failed (generic error).

get · iOS 13.0+

invalidated

TypeScript

static get invalidated(): _Foundation_NSError

Swift declaration

static let invalidated: NSError

The sample buffer was invalidated.

get · iOS 13.0+

dataCanceled

TypeScript

static get dataCanceled(): _Foundation_NSError

Swift declaration

static let dataCanceled: NSError

The sample buffer's data loading operation was canceled.

get · iOS 13.0+

arrayTooSmall

TypeScript

static get arrayTooSmall(): _Foundation_NSError

Swift declaration

static let arrayTooSmall: NSError

Output array was not large enough for the array being requested.

get · iOS 13.0+

bufferNotReady

TypeScript

static get bufferNotReady(): _Foundation_NSError

Swift declaration

static let bufferNotReady: NSError

Buffer could not be made ready.

get · iOS 13.0+

cannotSubdivide

TypeScript

static get cannotSubdivide(): _Foundation_NSError

Swift declaration

static let cannotSubdivide: NSError

Sample buffer does not contain sample sizes. This can happen when the samples in the buffer are non-contiguous (eg. non-interleaved audio, where the channel values for a single sample are scattered through the buffer).

get · iOS 13.0+

allocationFailed

TypeScript

static get allocationFailed(): _Foundation_NSError

Swift declaration

static let allocationFailed: NSError

An allocation failed.

get · iOS 13.0+

invalidEntryCount

TypeScript

static get invalidEntryCount(): _Foundation_NSError

Swift declaration

static let invalidEntryCount: NSError

Timing info or size array entry count was not `0`, `1`, or `numSamples`.

get · iOS 13.0+

invalidSampleData

TypeScript

static get invalidSampleData(): _Foundation_NSError

Swift declaration

static let invalidSampleData: NSError

Buffer contains bad data. Only returned by CMSampleBuffer` functions that inspect its sample data.

get · iOS 13.0+

sampleIndexOutOfRange

TypeScript

static get sampleIndexOutOfRange(): _Foundation_NSError

Swift declaration

static let sampleIndexOutOfRange: NSError

Sample index was not between `0` and `numSamples - 1`, inclusive.

get · iOS 13.0+

bufferHasNoSampleSizes

TypeScript

static get bufferHasNoSampleSizes(): _Foundation_NSError

Swift declaration

static let bufferHasNoSampleSizes: NSError

Attempt to get sample size information when there was none.

get · iOS 13.0+

sampleTimingInfoInvalid

TypeScript

static get sampleTimingInfoInvalid(): _Foundation_NSError

Swift declaration

static let sampleTimingInfoInvalid: NSError

Buffer unexpectedly contains a non-numeric sample timing info.

get · iOS 13.0+

requiredParameterMissing

TypeScript

static get requiredParameterMissing(): _Foundation_NSError

Swift declaration

static let requiredParameterMissing: NSError

`nil` or `0` was passed for a required parameter.

get · iOS 13.0+

bufferHasNoSampleTimingInfo

TypeScript

static get bufferHasNoSampleTimingInfo(): _Foundation_NSError

Swift declaration

static let bufferHasNoSampleTimingInfo: NSError

Attempt to get sample timing information when there was none.

Skipped declarations

No declarations were skipped in this snapshot.

All CoreMedia types →