Package apple.avfoundation

Class AVContentKeySession

  • All Implemented Interfaces:
    NSObject
    public class AVContentKeySession
extends NSObject

    • Constructor Detail

      • AVContentKeySession

        protected AVContentKeySession​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • addContentKeyRecipient

        public void addContentKeyRecipient​(AVContentKeyRecipient recipient)
        addContentKeyRecipient: 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.

      • allocWithZone

        public static java.lang.Object allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(java.lang.String key)

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(java.lang.Object aTarget,
                                                                         org.moe.natj.objc.SEL aSelector,
                                                                         java.lang.Object anArgument)

      • classFallbacksForKeyedArchiver

        public static NSArray<java.lang.String> classFallbacksForKeyedArchiver()

      • classForKeyedUnarchiver

        public static org.moe.natj.objc.Class classForKeyedUnarchiver()

      • contentKeyRecipients

        public NSArray<?> contentKeyRecipients()
        [@property] contentKeyRecipients The array of recipients of content keys currently associated with the AVContentKeySession.

      • contentKeySessionWithKeySystem

        public static AVContentKeySession contentKeySessionWithKeySystem​(java.lang.String keySystem)
        contentKeySessionWithKeySystem: Creates a new instance of AVContentKeySession to manage a collection of media content keys. 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.
        Parameters:
        keySystem - A valid key system for retrieving keys.
        Returns:
        A new AVContentKeySession.

      • contentKeySessionWithKeySystemStorageDirectoryAtURL

        public static AVContentKeySession contentKeySessionWithKeySystemStorageDirectoryAtURL​(java.lang.String keySystem,
                                                                                      NSURL storageURL)
        contentKeySessionWithKeySystem:storageDirectoryAtURL: Creates a new instance of AVContentKeySession to manage a collection of media content keys. 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.
        Parameters:
        keySystem - A valid key system for retrieving keys.
        storageURL - URL to a writable directory that the session will use to facilitate expired session reports after abnormal session termination.
        Returns:
        A new AVContentKeySession.

      • contentProtectionSessionIdentifier

        public NSData contentProtectionSessionIdentifier()
        [@property] contentProtectionSessionIdentifier 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.

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • delegate

        public AVContentKeySessionDelegate delegate()
        [@property] delegate 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.

      • delegateQueue

        public NSObject delegateQueue()
        [@property] delegateQueue The dispatch queue on which all delegate methods will be invoked whenever processes requiring content keys are executed asynchronously. The value of this property is a dispatch_queue_t. The queue is set using the setDelegate:queue: method.

      • description_static

        public static java.lang.String description_static()

      • expire

        public void expire()
        expire 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.

      • hash_static

        public static long hash_static()

      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)

      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)

      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)

      • keyPathsForValuesAffectingValueForKey

        public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(java.lang.String key)

      • keySystem

        public java.lang.String keySystem()
        [@property] keySystem The key system used for retrieving keys

      • makeSecureTokenForExpirationDateOfPersistableContentKeyCompletionHandler

        public void makeSecureTokenForExpirationDateOfPersistableContentKeyCompletionHandler​(NSData persistableContentKeyData,
                                                                                     AVContentKeySession.Block_makeSecureTokenForExpirationDateOfPersistableContentKeyCompletionHandler handler)
        makeSecureTokenForExpirationDateOfPersistableContentKey:completionHandler: 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.
        Parameters:
        persistableContentKeyData - Persistable content key data that was previously created using -[AVContentKeyRequest persistableContentKeyFromKeyVendorResponse:options:error:] or obtained via AVContentKeySessionDelegate callback -contentKeySession:didUpdatePersistableContentKey:forContentKeyIdentifier:.
        handler - Once the secure token is ready, this block will be called with the token or an error describing the failure.

      • new_objc

        public static java.lang.Object new_objc()

      • pendingExpiredSessionReportsWithAppIdentifierStorageDirectoryAtURL

        public static NSArray<? extends NSData> pendingExpiredSessionReportsWithAppIdentifierStorageDirectoryAtURL​(NSData appIdentifier,
                                                                                                           NSURL storageURL)
        pendingExpiredSessionReportsWithAppIdentifier:storageDirectoryAtURL: Provides "expired session reports" for prior AVContentKeySessions created with the specified app identifier that have expired either normally or abnormally. Note that no reports for sessions still in progress will be included.
        Parameters:
        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.
        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.

      • processContentKeyRequestWithIdentifierInitializationDataOptions

        public void processContentKeyRequestWithIdentifierInitializationDataOptions​(java.lang.Object identifier,
                                                                            NSData initializationData,
                                                                            NSDictionary<java.lang.String,​?> options)
        processContentKeyRequestWithIdentifier:initializationData:options: Informs the receiver that it should attempt to instantiate a content decryption key using the specified initialization data. 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.
        Parameters:
        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.
        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.
        options - Additional information necessary to obtain the key, or nil if none. See AVContentKeyRequest*Key below.

      • removeContentKeyRecipient

        public void removeContentKeyRecipient​(AVContentKeyRecipient recipient)
        removeContentKeyRecipient: 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.

      • removePendingExpiredSessionReportsWithAppIdentifierStorageDirectoryAtURL

        public static void removePendingExpiredSessionReportsWithAppIdentifierStorageDirectoryAtURL​(NSArray<? extends NSData> expiredSessionReports,
                                                                                            NSData appIdentifier,
                                                                                            NSURL storageURL)
        removePendingExpiredSessionReports:withAppIdentifier:storageDirectoryAtURL: 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:. 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.
        Parameters:
        expiredSessionReports - An array of expired session reports to be discarded.
        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.
        storageURL - URL to a writable folder.

      • renewExpiringResponseDataForContentKeyRequest

        public void renewExpiringResponseDataForContentKeyRequest​(AVContentKeyRequest contentKeyRequest)
        renewExpiringResponseDataForContentKeyRequest: 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:.

      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)

      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)

      • setDelegateQueue

        public void setDelegateQueue​(AVContentKeySessionDelegate delegate,
                             NSObject delegateQueue)
        setDelegate:queue: Sets the receiver's delegate. A delegate is required to handle content key initialization.
        Parameters:
        delegate - An object conforming to the AVContentKeySessionDelegate protocol.
        delegateQueue - A dispatch queue on which delegate methods will be invoked whenever processes requiring content keys are executed asynchronously. Passing a value of nil for the delegateQueue parameter along with a non-nil value for the delegate parameter will result in an invalid argument exception.

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • storageURL

        public NSURL storageURL()
        [@property] storageURL 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.

      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()

      • version_static

        public static long version_static()

      • invalidateAllPersistableContentKeysForAppOptionsCompletionHandler

        public void invalidateAllPersistableContentKeysForAppOptionsCompletionHandler​(NSData appIdentifier,
                                                                              NSDictionary<java.lang.String,​?> options,
                                                                              AVContentKeySession.Block_invalidateAllPersistableContentKeysForAppOptionsCompletionHandler handler)
        invalidateAllPersistableContentKeysForApp:options:completionHandler: 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. Once invalidated, persistable content keys cannot be used to answer key requests during later playback sessions.
        Parameters:
        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.
        options - Additional information necessary to generate the server playback context, or nil if none. See AVContentKeySessionServerPlaybackContextOption for supported options.
        handler - Once the server playback context is ready, this block will be called with the data or an error describing the failure.

      • invalidatePersistableContentKeyOptionsCompletionHandler

        public void invalidatePersistableContentKeyOptionsCompletionHandler​(NSData persistableContentKeyData,
                                                                    NSDictionary<java.lang.String,​?> options,
                                                                    AVContentKeySession.Block_invalidatePersistableContentKeyOptionsCompletionHandler handler)
        invalidatePersistableContentKey:options:completionHandler: 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. Once invalidated, a persistable content key cannot be used to answer key requests during later playback sessions.
        Parameters:
        persistableContentKeyData - Persistable content key data that was previously created using -[AVContentKeyRequest persistableContentKeyFromKeyVendorResponse:options:error:] or obtained via AVContentKeySessionDelegate callback -contentKeySession:didUpdatePersistableContentKey:forContentKeyIdentifier:.
        options - Additional information necessary to generate the server playback context, or nil if none. See AVContentKeySessionServerPlaybackContextOption for supported options.
        handler - Once the server playback context is ready, this block will be called with the data or an error describing the failure.