AVFoundation · IOS API REFERENCE

AVContentKeySession

class · iOS 10.3+ · SDK 27.1

class AVContentKeySession

Members (21)

init · iOS 11.0+

init

TypeScript

static initKeySystem(keySystem: AVContentKeySystem): AVContentKeySession

Swift declaration

convenience init(keySystem: AVContentKeySystem)

init · iOS 10.3+

init

TypeScript

static initKeySystemStorageDirectoryAt(keySystem: AVContentKeySystem, storageURL: string): AVContentKeySession

Swift declaration

convenience init(keySystem: AVContentKeySystem, storageDirectoryAt storageURL: URL)

static

pendingExpiredSessionReports

TypeScript

static pendingExpiredSessionReports(appIdentifier: ArrayBuffer, storageURL: string): Array<ArrayBuffer>

Swift declaration

class func pendingExpiredSessionReports(withAppIdentifier appIdentifier: Data, storageDirectoryAt storageURL: URL) -> [Data]

static

removePendingExpiredSessionReports

TypeScript

static removePendingExpiredSessionReports(expiredSessionReports: Array<ArrayBuffer>, appIdentifier: ArrayBuffer, storageURL: string): void

Swift declaration

class func removePendingExpiredSessionReports(_ expiredSessionReports: [Data], withAppIdentifier appIdentifier: Data, storageDirectoryAt storageURL: URL)

method

addContentKeyRecipient

TypeScript

addContentKeyRecipient(recipient: SDKHandle): void

Swift declaration

func addContentKeyRecipient(_ recipient: any AVContentKeyRecipient)

method · iOS 10.3+

expire

TypeScript

expire(): void

Swift declaration

func expire()

method · iOS 12.2+

invalidateAllPersistableContentKeys

TypeScript

invalidateAllPersistableContentKeys(appIdentifier: ArrayBuffer, options: (NativeMap<AVContentKeySessionServerPlaybackContextOption, unknown>) | null, handler: ((arg0: (ArrayBuffer) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func invalidateAllPersistableContentKeys(forApp appIdentifier: Data, options: [AVContentKeySessionServerPlaybackContextOption : Any]? = nil) async throws -> Data

method · iOS 12.2+

invalidatePersistableContentKey

TypeScript

invalidatePersistableContentKey(persistableContentKeyData: ArrayBuffer, options: (NativeMap<AVContentKeySessionServerPlaybackContextOption, unknown>) | null, handler: ((arg0: (ArrayBuffer) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func invalidatePersistableContentKey(_ persistableContentKeyData: Data, options: [AVContentKeySessionServerPlaybackContextOption : Any]? = nil) async throws -> Data

method · iOS 11.0+

makeSecureTokenForExpirationDate

TypeScript

makeSecureTokenForExpirationDate(persistableContentKeyData: ArrayBuffer, handler: ((arg0: (ArrayBuffer) | null, arg1: (NativeError) | null) => void)): void

Swift declaration

func makeSecureTokenForExpirationDate(ofPersistableContentKey persistableContentKeyData: Data) async throws -> Data

method · iOS 10.3+

processContentKeyRequest

TypeScript

processContentKeyRequest(identifier?: (SDKHandle) | null, initializationData?: (ArrayBuffer) | null, options?: (Record<string, SDKHandle>) | null): void

Swift declaration

func processContentKeyRequest(withIdentifier identifier: (any Sendable)?, initializationData: Data?, options: [String : any Sendable]? = nil)

method

removeContentKeyRecipient

TypeScript

removeContentKeyRecipient(recipient: SDKHandle): void

Swift declaration

func removeContentKeyRecipient(_ recipient: any AVContentKeyRecipient)

method · iOS 10.3+

renewExpiringResponseData

TypeScript

renewExpiringResponseData(contentKeyRequest: AVContentKeyRequest): void

Swift declaration

func renewExpiringResponseData(for contentKeyRequest: AVContentKeyRequest)

method · iOS 10.3+

setDelegate

TypeScript

setDelegate(delegate?: (Implements<AVContentKeySessionDelegate> | SDKHandle) | null, delegateQueue?: (_Dispatch_DispatchQueue) | null): void

Swift declaration

func setDelegate(_ delegate: (any AVContentKeySessionDelegate)?, queue delegateQueue: dispatch_queue_t?)

get

contentKeyRecipients

TypeScript

get contentKeyRecipients(): Array<SDKHandle>

Swift declaration

var contentKeyRecipients: [any AVContentKeyRecipient] { get }

get · iOS 10.3+

contentProtectionSessionIdentifier

TypeScript

get contentProtectionSessionIdentifier(): (ArrayBuffer) | null

Swift declaration

var contentProtectionSessionIdentifier: Data? { get }

get · iOS 10.3+

delegate

TypeScript

get delegate(): (SDKHandle) | null

Swift declaration

weak var delegate: (any AVContentKeySessionDelegate)? { get }

get · iOS 10.3+

delegateQueue

TypeScript

get delegateQueue(): (_Dispatch_DispatchQueue) | null

Swift declaration

var delegateQueue: dispatch_queue_t? { get }

get · iOS 10.3+

keySystem

TypeScript

get keySystem(): AVContentKeySystem

Swift declaration

var keySystem: AVContentKeySystem { get }

get · iOS 10.3+

storageURL

TypeScript

get storageURL(): (string) | null

Swift declaration

var storageURL: URL? { get }

get · iOS 27.0+

supportsAdvisoryKeys

TypeScript

get supportsAdvisoryKeys(): boolean

Swift declaration

var supportsAdvisoryKeys: Bool { get set }

set · iOS 27.0+

supportsAdvisoryKeys

TypeScript

set supportsAdvisoryKeys(value: boolean)

Swift declaration

var supportsAdvisoryKeys: Bool { get set }

Skipped declarations

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

AVContentKeySession.init()

inherited init: cannot prove legal (class declares 3 custom initializers)

All AVFoundation types →