Struct AVContentKeySession

Source

#[repr(C)]
pub struct AVContentKeySession { /* private fields */ }

Available on crate feature AVContentKeySession only.

Expand description

Apple’s documentation

Implementations§

Source §

pub unsafe fn contentKeySessionWithKeySystem( key_system: &AVContentKeySystem, ) -> Retained<Self>

Creates a new instance of AVContentKeySession to manage a collection of media content keys.

Parameter keySystem: A valid key system for retrieving keys.

Returns: A new AVContentKeySession.

This method returns an AVContentKeySession instance that is capable of managing collection of media content keys corresponding to the input keySystem. An NSInvalidArgumentException will be raised if the value of keySystem is unsupported.

Source

pub unsafe fn contentKeySessionWithKeySystem_storageDirectoryAtURL( key_system: &AVContentKeySystem, storage_url: &NSURL, ) -> Retained<Self>

Creates a new instance of AVContentKeySession to manage a collection of media content keys.

Parameter keySystem: A valid key system for retrieving keys.

Parameter storageURL: URL to a writable directory that the session will use to facilitate expired session reports after abnormal session termination.

Returns: A new AVContentKeySession.

This method returns an AVContentKeySession instance that is capable of managing collection of media content keys corresponding to the input keySystem. An NSInvalidArgumentException will be raised if the value of keySystem is unsupported.

Source

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn AVContentKeySessionDelegate>>>

The receiver’s delegate.

The value of this property is an object conforming to the AVContentKeySessionDelegate protocol. The delegate is set using the setDelegate:queue: method.

Source

pub unsafe fn storageURL(&self) -> Option<Retained<NSURL>>

The storage URL provided when the AVContentKeySession was created. May be nil.

URL to a writable directory; may be nil. The session will use this to facilitate expired session reports after abnormal session termination.

Source

pub unsafe fn keySystem(&self) -> Retained<AVContentKeySystem>

The key system used for retrieving keys

Source

pub unsafe fn expire(&self)

Tells the receiver to treat the session as having been intentionally and normally expired.

When an instance of AVContentKeySession receives an expire message, all of its associated objects conforming to the AVContentKeyRecipient protocol will become inoperable. Send this message only after you have finished operating on the media data.

Source

pub unsafe fn contentProtectionSessionIdentifier( &self, ) -> Option<Retained<NSData>>

An opaque identifier for the current content protection session.

May be nil. Will call the delegate’s contentKeySessionContentProtectionSessionIdentifierDidChange: when the identifier changes. The protection session ID is a unique string identifier generated by the AVContentKeySession that can be used by the application to identify content key session objects.

Source

pub unsafe fn processContentKeyRequestWithIdentifier_initializationData_options( &self, identifier: Option<&AnyObject>, initialization_data: Option<&NSData>, options: Option<&NSDictionary<NSString, AnyObject>>, )

Informs the receiver that it should attempt to instantiate a content decryption key using the specified initialization data.

Parameter identifier: Container- and protocol-specific identifier to be used to obtain a key response. Either identifier or initializationData must be non-nil. Both can be non-nil, if the content protection protocol requires both.

Parameter initializationData: Container- and protocol-specific data to be used to obtain a key response. Either identifier or initializationData must be non-nil. Both can be non-nil, if the content protection protocol requires both.

Parameter options: Additional information necessary to obtain the key, or nil if none. See AVContentKeyRequest*Key below.

May be used to generate an AVContentKeyRequest from request initialization data already in hand, without awaiting such data during the processing of media data of an associated recipient.

Source

pub unsafe fn renewExpiringResponseDataForContentKeyRequest( &self, content_key_request: &AVContentKeyRequest, )

Informs the receiver that the already provided response data for an earlier AVContentKeyRequest will imminently expire.

In response the receiver will invoke your delegate with a new content key request entreating it to renew the expiring response data, via -contentKeySession:didProvideRenewingContentKeyRequest:.

Source

pub unsafe fn makeSecureTokenForExpirationDateOfPersistableContentKey_completionHandler( &self, persistable_content_key_data: &NSData, handler: &Block<dyn Fn(mut NSData, mut NSError)>, )

Available on crate feature block2 only.

Creates a secure server playback context (SPC) that the client could send to the key server to obtain an expiration date for the provided persistable content key data.

Parameter persistableContentKeyData: Persistable content key data that was previously created using -[AVContentKeyRequest persistableContentKeyFromKeyVendorResponse:options:error:] or obtained via AVContentKeySessionDelegate callback -contentKeySession:didUpdatePersistableContentKey:forContentKeyIdentifier:.

Parameter handler: Once the secure token is ready, this block will be called with the token or an error describing the failure.

Source

pub unsafe fn invalidatePersistableContentKey_options_completionHandler( &self, persistable_content_key_data: &NSData, options: Option<&NSDictionary<AVContentKeySessionServerPlaybackContextOption, AnyObject>>, handler: &Block<dyn Fn(mut NSData, mut NSError)>, )

Available on crate feature block2 only.

Invalidates the persistable content key and creates a secure server playback context (SPC) that the client could send to the key server to verify the outcome of invalidation request.

Parameter persistableContentKeyData: Persistable content key data that was previously created using -[AVContentKeyRequest persistableContentKeyFromKeyVendorResponse:options:error:] or obtained via AVContentKeySessionDelegate callback -contentKeySession:didUpdatePersistableContentKey:forContentKeyIdentifier:.

Parameter options: Additional information necessary to generate the server playback context, or nil if none. See AVContentKeySessionServerPlaybackContextOption for supported options.

Parameter handler: Once the server playback context is ready, this block will be called with the data or an error describing the failure.

Once invalidated, a persistable content key cannot be used to answer key requests during later playback sessions.

Source

pub unsafe fn invalidateAllPersistableContentKeysForApp_options_completionHandler( &self, app_identifier: &NSData, options: Option<&NSDictionary<AVContentKeySessionServerPlaybackContextOption, AnyObject>>, handler: &Block<dyn Fn(mut NSData, mut NSError)>, )

Available on crate feature block2 only.

Invalidates all persistable content keys associated with the application and creates a secure server playback context (SPC) that the client could send to the key server to verify the outcome of invalidation request.

Parameter appIdentifier: An opaque identifier for the application. The contents of this identifier depend on the particular protocol in use by the entity that controls the use of the media data.

Parameter options: Additional information necessary to generate the server playback context, or nil if none. See AVContentKeySessionServerPlaybackContextOption for supported options.

Parameter handler: Once the server playback context is ready, this block will be called with the data or an error describing the failure.

Once invalidated, persistable content keys cannot be used to answer key requests during later playback sessions.

Source §

impl AVContentKeySession

AVContentKeyRecipients.

Source

pub unsafe fn addContentKeyRecipient( &self, recipient: &ProtocolObject<dyn AVContentKeyRecipient>, )

Informs the receiver that the specified recipient will be used for the session.

It is an error to add recipient to sessions that have received an expire message. It is also an error to add recipients after they have already begun to process media data (e.g. after an AVURLAsset has loaded the values of any of its keys). Such errors will result in NSInternalInconsistencyExceptions. Sending this message to an AVContentKeySession is atomic.

Source

pub unsafe fn removeContentKeyRecipient( &self, recipient: &ProtocolObject<dyn AVContentKeyRecipient>, )

Informs the receiver that the specified recipient will no longer be used.

After the specified recipient is removed from the receiver it will become inoperable. Remove the recipient only after you have finished operating on the media data associated with it. Sending this message to an AVContentKeySession is atomic.

Source

pub unsafe fn contentKeyRecipients( &self, ) -> Retained<NSArray<ProtocolObject<dyn AVContentKeyRecipient>>>

The array of recipients of content keys currently associated with the AVContentKeySession.

Source §

impl AVContentKeySession

AVContentKeySessionPendingExpiredSessionReports.

Source

pub unsafe fn pendingExpiredSessionReportsWithAppIdentifier_storageDirectoryAtURL( app_identifier: &NSData, storage_url: &NSURL, ) -> Retained<NSArray<NSData>>

Provides “expired session reports” for prior AVContentKeySessions created with the specified app identifier that have expired either normally or abnormally.

Parameter appIdentifier: An opaque identifier for the application. The contents of this identifier depend on the particular protocol in use by the entity that controls the use of the media data.

Parameter storageURL: URL to a directory previously used with one or more instances of AVContentKeySession for the storage of expired session reports.

Returns: An NSArray containing instances of NSData, each containing a pending expired session report as a property-list serialization of an NSDictionary object. The contents of expired session reports depend on the particular protocol in use by the entity that controls the use of the media data.

Note that no reports for sessions still in progress will be included.

Source

pub unsafe fn removePendingExpiredSessionReports_withAppIdentifier_storageDirectoryAtURL( expired_session_reports: &NSArray<NSData>, app_identifier: &NSData, storage_url: &NSURL, )

Removes expired session reports for prior AVContentKeySessions from storage. Once they have been removed, they will no longer be available via subsequent invocations of +pendingExpiredSessionReportsWithAppIdentifier:.

Parameter expiredSessionReports: An array of expired session reports to be discarded.

Parameter appIdentifier: An opaque identifier for the application. The contents of this identifier depend on the particular protocol in use by the entity that controls the use of the media data.

Parameter storageURL: URL to a writable folder.

This method is most suitable for use only after the specified expired session reports have been sent to the entity that controls the use of the media data and the entity has acknowledged their receipt.

Methods from Deref<Target = NSObject>§

Source

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

§Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

Source

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T
where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

§Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

Source

pub fn downcast_ref<T>(&self) -> Option<&T>
where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

§Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

§Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

§Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

§Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}