Struct AVPersistableContentKeyRequest

Source

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

Available on crate feature AVContentKeySession only.

Expand description

Subclasses of this type that are used from Swift must fulfill the requirements of a Sendable type.

Implementations§

Source §

impl AVPersistableContentKeyRequest

Source

pub unsafe fn persistableContentKeyFromKeyVendorResponse_options_error( &self, key_vendor_response: &NSData, options: Option<&NSDictionary<NSString, AnyObject>>, ) -> Result<Retained<NSData>, Retained<NSError>>

Obtains a persistable content key from a context.

Parameter keyVendorResponse: The response returned from the key vendor as a result of a request generated from makeStreamingContentKeyRequestDataForApp:contentIdentifier:options:completionHandler:.

Parameter options: Additional information necessary to obtain the persistable content key, or nil if none.

Parameter outError: If obtaining the persistable content key fails, will be set to an instance of NSError describing the failure.

Returns: The persistable content key data that may be stored offline to answer future loading requests of the same content key.

The data returned from this method may be used to immediately satisfy an AVPersistableContentKeyRequest, as well as any subsequent requests for the same key url using processContentKeyResponse: method. When you receive an AVContentKeyRequest via -contentKeySession:didProvideContentKeyRequest: and you want to use existing persistent content key from storage, you must invoke -respondByRequestingPersistableContentKeyRequest on that AVContentKeyRequest in order to signal that you want to process an AVPersistableContentKeyRequest instead. If the underlying protocol supports persistable content keys, in response your delegate will receive an AVPersistableContentKeyRequest via -contentKeySession:didProvidePersistableContentKeyRequest:. You can set the persistent key from storage on the AVPersistableContentKeyRequest using processContentKeyResponse:.

Source §

impl AVPersistableContentKeyRequest

Methods declared on superclass NSObject.

Source

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

Source

pub unsafe fn new() -> Retained<Self>

Methods from Deref<Target = AVContentKeyRequest>§

Source

pub unsafe fn status(&self) -> AVContentKeyRequestStatus

This describes the state of the AVContentKeyRequest, value is one of AVContentKeyRequestStatus.

Source

pub unsafe fn error(&self) -> Option<Retained<NSError>>

If the receiver’s status is AVContentKeyRequestStatusFailed, this describes the error that caused the failure.

The value of this property is an NSError that describes what caused the content key request to fail. If the receiver’s status is not AVContentKeyRequestStatusFailed, the value of this property is nil.

Source

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

Available on crate feature block2 only.

Obtains a content key request data for a specific combination of application and content.

Parameter appIdentifier: An opaque identifier for the application. The value of this identifier depends on the particular system used to provide the content key.

Parameter contentIdentifier: An optional opaque identifier for the content. The value of this identifier depends on the particular system used to provide the content key.

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

Parameter handler: Once the streaming content key request is prepared, this block will be called with the request data or an error describing the failure.

If option AVContentKeyRequestProtocolVersionsKey is not specified the default protocol version of 1 is assumed.

Source

pub unsafe fn processContentKeyResponse( &self, key_response: &AVContentKeyResponse, )

Informs the receiver to process the specified content key response.

Parameter keyResponse: An instance of AVContentKeyResponse carrying a response to a content key request.

After you receive an AVContentKeyRequest via -contentKeySession:didProvideContentKeyRequest: and after you invoke -[AVContentKeyRequest makeStreamingContentKeyRequestDataForApp:contentIdentifier:options:completionHandler:] on that request, you must obtain a response to the request in accordance with the protocol in use by the entity that controls the use of the media data. This is the method you use to provide the content key response to make protected content available for processing. If obtaining the content key response fails, use -processContentKeyResponseError:.

Source

pub unsafe fn processContentKeyResponseError(&self, error: &NSError)

Informs the receiver that obtaining a content key response has failed, resulting in failure handling.

Parameter error: An instance of NSError that describes the specific failure that occurred.

Source

pub unsafe fn respondByRequestingPersistableContentKeyRequest(&self)

👎Deprecated

Informs the receiver to process a persistable content key request.

When you receive an AVContentKeyRequest via -contentKeySession:didProvideContentKeyRequest: and you want the resulting key response to produce a key that can persist across multiple playback sessions, you must invoke -respondByRequestingPersistableContentKeyRequest on that AVContentKeyRequest in order to signal that you want to process an AVPersistableContentKeyRequest instead. If the underlying protocol supports persistable content keys, in response your delegate will receive an AVPersistableContentKeyRequest via -contentKeySession:didProvidePersistableContentKeyRequest:. NSInternalInconsistencyException will be raised, if you are attempting to create and use a persistable key but your AVContentKeySession delegate does not respond to contentKeySession:didProvidePersistableContentKeyRequest:.

Source

pub unsafe fn respondByRequestingPersistableContentKeyRequestAndReturnError( &self, ) -> Result<(), Retained<NSError>>

Source

pub unsafe fn renewsExpiringResponseData(&self) -> bool

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`
    }
}