One Logo Pool Ball
AVFoundation · IOS API REFERENCE

AVPlayerLayer

class · iOS 4.0+ · SDK 27.1

class AVPlayerLayer

Members (13)

init · iOS 4.0+

init

TypeScript
static init(player?: (AVPlayer) | null): AVPlayerLayer
Swift declaration
init(player: AVPlayer?)
method · iOS 16.0+ · Deprecated in iOS 27.0

displayedPixelBuffer

TypeScript
displayedPixelBuffer(): (_CoreVideo_CVBuffer) | null
Swift declaration
func displayedPixelBuffer() -> CVPixelBuffer?
method · iOS 26.4+

setCaptionPreviewProfileID

TypeScript
setCaptionPreviewProfileID(profileID: string, position: { x: number; y: number }, text?: (string) | null): void
Swift declaration
func setCaptionPreviewProfileID(_ profileID: String, position: CGPoint, text: String?)
method · iOS 26.4+

stopShowingCaptionPreview

TypeScript
stopShowingCaptionPreview(): void
Swift declaration
func stopShowingCaptionPreview()
get · iOS 9.0+

pixelBufferAttributes

TypeScript
get pixelBufferAttributes(): (Record<string, unknown>) | null
Swift declaration
var pixelBufferAttributes: [String : Any]? { get set }
set · iOS 9.0+

pixelBufferAttributes

TypeScript
set pixelBufferAttributes(value: (Record<string, unknown>) | null)
Swift declaration
var pixelBufferAttributes: [String : Any]? { get set }
get · iOS 4.0+

player

TypeScript
get player(): (AVPlayer) | null
Swift declaration
var player: AVPlayer? { get set }
set · iOS 4.0+

player

TypeScript
set player(value: (AVPlayer) | null)
Swift declaration
var player: AVPlayer? { get set }
get · iOS 4.0+

isReadyForDisplay

TypeScript
get isReadyForDisplay(): boolean
Swift declaration
var isReadyForDisplay: Bool { get }
get · iOS 4.0+

videoGravity

TypeScript
get videoGravity(): AVLayerVideoGravity
Swift declaration
var videoGravity: AVLayerVideoGravity { get set }
set · iOS 4.0+

videoGravity

TypeScript
set videoGravity(value: AVLayerVideoGravity)
Swift declaration
var videoGravity: AVLayerVideoGravity { get set }
get · iOS 7.0+

videoRect

TypeScript
get videoRect(): { x: number; y: number; width: number; height: number }
Swift declaration
var videoRect: CGRect { get }
method · iOS 26.0+

displayedReadOnlyPixelBuffer

TypeScript
displayedReadOnlyPixelBuffer(): (_CoreVideo_CVReadOnlyPixelBuffer) | null
Swift declaration
func displayedReadOnlyPixelBuffer() -> CVReadOnlyPixelBuffer?

Returns the pixel buffer which is currently being displayed. CVReadOnlyPixelBuffer can be nil if the current player's rate is non-zero, displayed pixel buffer is protected, no image is currently being displayed, or if the image is unavailable. - Returns: A CVReadOnlyPixelBuffer object.

Skipped declarations

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

AVPlayerLayer.init()

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

All AVFoundation types →