One Logo Pool Ball
AVFoundation · IOS API REFERENCE

AVVideoOutputSpecification

class · iOS 17.2+ · SDK 27.1

class AVVideoOutputSpecification

Members (8)

get · iOS 18.0+

defaultOutputSettings

TypeScript
get defaultOutputSettings(): (Record<string, SDKHandle>) | null
Swift declaration
var defaultOutputSettings: [String : any Sendable]? { get set }
set · iOS 18.0+

defaultOutputSettings

TypeScript
set defaultOutputSettings(value: (Record<string, SDKHandle>) | null)
Swift declaration
var defaultOutputSettings: [String : any Sendable]? { get set }
get · iOS 17.2+ · Deprecated in iOS 27.0

defaultPixelBufferAttributes

TypeScript
get defaultPixelBufferAttributes(): (Record<string, unknown>) | null
Swift declaration
var defaultPixelBufferAttributes: [String : Any]? { get set }
set · iOS 17.2+ · Deprecated in iOS 27.0

defaultPixelBufferAttributes

TypeScript
set defaultPixelBufferAttributes(value: (Record<string, unknown>) | null)
Swift declaration
var defaultPixelBufferAttributes: [String : Any]? { get set }
method · iOS 17.2+ · Deprecated in iOS 27.0

setOutputPixelBufferAttributes

TypeScript
setOutputPixelBufferAttributes(pixelBufferAttributes: (Record<string, unknown>) | null, tagCollection: Array<_CoreMedia_CMTag>): void
Swift declaration
func setOutputPixelBufferAttributes(_ pixelBufferAttributes: [String : Any]?, for tagCollection: [CMTag])

Specifies a mapping between a tag collection and a set of pixel buffer attributes. - Parameters: - pixelBufferAttributes: The client requirements for CVPixelBuffers related to the tags in tagCollection, expressed using the constants in <CoreVideo/CVPixelBuffer.h>. - tagCollection: A single tag collection for which these pixel buffer attributes should map to. - Note: Pixel buffer attributes are translated into output settings, therefore, the rules of `setOutputSettings` apply to this method as well. Namely, if you set pixel buffer attributes for a tag collection and then output settings for that same tag collection, your pixel buffer attributes will be overridden and vice-versa.

method · iOS 18.0+

setOutputSettings

TypeScript
setOutputSettings(outputSettings: (Record<string, SDKHandle>) | null, tagCollection: Array<_CoreMedia_CMTag>): void
Swift declaration
func setOutputSettings(_ outputSettings: [String : any Sendable]?, for tagCollection: [CMTag])

Specifies a mapping between a tag collection and a set of output settings. - Parameters: - outputSettings: The client requirements for output CVPixelBuffers related to the tags in tagCollection, expressed using the constants in AVVideoSettings.h. For uncompressed video output, start with kCVPixelBuffer* keys in <CoreVideo/CVPixelBuffer.h>. In addition to the keys in CVPixelBuffer.h, uncompressed video settings dictionaries may also contain the key `AVVideoAllowWideColorKey`. - tagCollection: A single tag collection for which these pixel buffer attributes should map to. - Note: If this method is called twice on the same tag collection, the first requested output settings will be overridden.

init · iOS 17.2+

init

TypeScript
static init(tagCollections: Array<Array<_CoreMedia_CMTag>>): AVVideoOutputSpecification
Swift declaration
convenience init(tagCollections: [[CMTag]])

Creates an instance of AVVideoOutputSpecification initialized with the specified tag collections. - Parameter tagCollections: Expects a non-empty array of CMTagCollections. Tag collections are given priority based on their position in the array, where position i take priority over position i+1. - Note: This method will produce a fatal error if the input tagCollection has a count of 0.

get · iOS 17.2+

preferredTagCollections

TypeScript
get preferredTagCollections(): Array<Array<_CoreMedia_CMTag>>
Swift declaration
var preferredTagCollections: [[CMTag]] { get }

Tag collections held by AVTaggedVideoOutputSpecification.

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

AVVideoOutputSpecification.init()

inherited init: cannot prove legal (class declares 1 custom initializer)

All AVFoundation types →