DRMInterface.h

Go to the documentation of this file.

#ifndef DRMINTERFACE_H
#define DRMINTERFACE_H

#include <Foundation/Foundation.h>



@class DRMLicense;
@class DRMMetadata;
@class DRMLicenseDomain;
@class DRMPlaybackTimeWindow;
@class DRMSession;

#pragma mark Declarations
typedef void (^DRMOperationError)(NSUInteger majorCode, NSUInteger minorCode, NSError* platformError);
typedef void (^DRMOperationComplete)();
typedef void (^DRMLicenseAcquired)(DRMLicense* license);
typedef void (^DRMPlaylistUpdated)(NSURL * playlist, DRMMetadata * metadata);
typedef void (^DRMAuthenticationComplete)(NSData* authenticationToken);

typedef enum
{
        UNKNOWN = 0,
        ANONYMOUS = 1,
        USERNAME_AND_PASSWORD = 2
} DRMAuthenticationMethod;

typedef enum
{
        FORCE_REFRESH = 0,
        LOCAL_ONLY = 1, 
        ALLOW_SERVER = 2,  
} DRMAcquireLicenseSettings;

#pragma mark -





@interface DRMManager : NSObject
        @property(nonatomic, readwrite, getter=getMaxOperationTime, setter=setMaxOperationTime:) NSUInteger maxOperationTime;

        +(DRMManager*) sharedManager;

        -(void) setAuthenticationToken:(DRMMetadata*)metadata authenticationDomain:(NSString*)authenticationDomain token:(NSData*)token error:(DRMOperationError)error complete:(DRMOperationComplete)complete;
        
        -(void) authenticate:(DRMMetadata*)metadata url:(NSString*)serverURL authenticationDomain:(NSString*)authenticationDomain username:(NSString*)username password:(NSString*)password error:(DRMOperationError)error complete:(DRMAuthenticationComplete)complete;

        -(void) acquirePreviewLicense:(DRMMetadata*)contentData error:(DRMOperationError)error acquired:(DRMLicenseAcquired)acquired;

        -(void) acquireLicense:(DRMMetadata*)contentData setting:(DRMAcquireLicenseSettings)setting error:(DRMOperationError)error acquired:(DRMLicenseAcquired)acquired;

        -(void) storeLicenseBytes:(NSData*)licenseBytes error:(DRMOperationError)error complete:(DRMOperationComplete)complete;


        -(void) resetDRM:(DRMOperationError)error complete:(DRMOperationComplete)complete;

        -(void) joinLicenseDomain:(DRMLicenseDomain*)licenseDomain forceRefresh:(BOOL)forceRefresh error:(DRMOperationError)error complete:(DRMOperationComplete)complete;
        -(void) leaveLicenseDomain:(DRMLicenseDomain*)licenseDomain error:(DRMOperationError)error complete:(DRMOperationComplete)complete;
        
    -(DRMSession*) createDRMSession:(DRMMetadata*)metadata playlist: (NSURL*) playlist error:(DRMOperationError)error complete:(DRMOperationComplete)complete;

        -(BOOL) isSupportedPlaylist:(NSURL*)url;

        -(void) getUpdatedPlaylist:(NSURL*)url error:(DRMOperationError)error updated:(DRMPlaylistUpdated)updated;
@end // DRMManager


@interface DRMMetadata : NSObject
        @property(nonatomic, readonly, retain, getter=getServerUrl) NSString* serverUrl;
        @property(nonatomic, readonly, retain, getter=getLicenseId) NSString* licenseId;
        @property(nonatomic, readonly, retain, getter=getPolicies) NSArray* policies; 

- (id) initFromNSData:(NSData*)rawData error:(DRMOperationError)error;
@end // DRMMetadata




@interface DRMPolicy : NSObject

        @property(nonatomic, readonly, retain, getter=getDisplayName) NSString* displayName;
        @property(nonatomic, readonly, getter=getAuthenticationMethod) DRMAuthenticationMethod authenticationMethod;
        @property(nonatomic, readonly, retain, getter=getAuthenticationDomain) NSString* authenticationDomain;
        @property(nonatomic, readonly, retain, getter=getLicenseDomain) DRMLicenseDomain* licenseDomain;
@end // DRMPolicy



@interface DRMLicenseDomain : NSObject
        @property(nonatomic, readonly, getter=getAuthenticationMethod) DRMAuthenticationMethod authenticationMethod;
        @property(nonatomic, readonly, retain, getter=getAuthenticationDomain) NSString* authenticationDomain;
        @property(nonatomic, readonly, retain, getter=getServerUrl) NSString* serverUrl;
@end // DRMLicenseDomain



 @interface DRMLicense : NSObject
        @property(nonatomic, readonly, retain, getter=getCustomProperties) NSDictionary* customProperties;

        @property(nonatomic, readonly, retain, getter=getLicenseStartDate) NSDate* licenseStartDate;

        @property(nonatomic, readonly, retain, getter=getLicenseEndDate) NSDate* licenseEndDate;

        @property(nonatomic, readonly, retain, getter=getOfflineStorageStartDate) NSDate* offlineStorageStartDate;

        @property(nonatomic, readonly, retain, getter=getOfflineStorageEndDate) NSDate* offlineStorageEndDate;

        @property(nonatomic, readonly, retain, getter=getPlaybackTimeWindow) DRMPlaybackTimeWindow* playbackTimeWindow;

        //- (id) initFromNSData:(NSData*)rawData;
        
        - (NSData*) toNSData;
@end // DRMLicense

@interface DRMPlaybackTimeWindow : NSObject

        @property(nonatomic, readonly, getter=getPlaybackPeriodInSeconds) NSUInteger playbackPeriodInSeconds;

        @property(nonatomic, readonly, retain, getter=getPlaybackStartDate) NSDate * playbackStartDate;

        @property(nonatomic, readonly, retain, getter=getPlaybackEndDate) NSDate * playbackEndDate;
@end // DRMPlaybackTimeWindow



@interface DRMSession : NSObject
        
@end // DRMPlaybackTimeWindow


#endif // DRMINTERFACE_H