An object used to create and track decryption keys for media data.
SDKs
- iOS 10.3+
- macOS 10.12.4+
- Mac Catalyst 13.0+
- tvOS 10.2+
Framework
- AVFoundation
Declaration
class AVContentKeySession : NSObject
ClassAVContent
AVContent
Topics
Creating New Content Key Sessions
init(keyCreates a content key session to manage a collection of content decryption keys.
init(keyCreates a content key session to manage a collection of content decryption keys; points to a directory that stores abnormal session termination reports.
var keyThe type of key system used to retrieve keys.
struct AVContentA key-delivery method for a content key session.
Initializing the Content Key Request Process
func setSets the receiver's delegate and indicates the dispatch queues used.
var delegate: AVContentThe delegate for the receiver.
protocol AVContentThe protocol you implement to handle content key requests.
var delegateThe dispatch queue that invokes delegate callbacks.
func addTells the receiver that the specified recipient should have access to the decryption keys loaded with the session.
var contentAn array of content key recipients.
protocol AVContentA protocol for requiring decryption keys for media data.
func processTells the receiver to start loading the content decryption key with the specified identifier and initialization data.
Updating Content Key Requests
func renewTells the receiver that previously provided response data for a content key request is about to expire.
func makeCreates a secure server playback context that the client sends to the key server to get an expiration date for the given persistable content key data.
var contentThe identifier for the current content protection session.
Ending a Content Key Request Process
func expire()Tells the receiver that the session expired as the result of normal, intentional processes.
func removeTells the receiver to remove the specified recipient.
protocol AVContentA protocol for requiring decryption keys for media data.
Handling Expired Session Reports
class func pendingReturns the expired session reports for content key sessions created with the specified app identifier.
class func removeRemoves expired session reports from storage.
var storageA URL that points to a writable storage directory.
Instance Methods
See Also
Content Key Decryption
class AVContentAn object that encapsulates information about a content decryption key request issued from a content key session object.
class AVContentAn object that encapsulates information about a response to a content decryption key request.
class AVPersistableAn object that encapsulates information about a persistable content decryption key request issued from a content key session.