WsbRightsEnabler.h

Go to the documentation of this file.

/*****************************************************************
|
|   Wasabi - Rights Enabler API
|
|   $Id: WsbRightsEnabler.h 10793 2014-06-25 12:46:08Z jebaseelir $
|   Original author: Adam Miller
|
|   This software is provided to you pursuant to your agreement 
|   with Intertrust Technologies Corporation ("Intertrust"). 
|   This software may be used only in accordance with the terms 
|   of the agreement.
|      
|   Copyright (c) 2009-2014 by Intertrust. All rights reserved. 
|
****************************************************************/
#ifndef _WSB_RIGHTS_ENABLER_H_
#define _WSB_RIGHTS_ENABLER_H_

/*----------------------------------------------------------------------
|   includes
+---------------------------------------------------------------------*/
#include "WsbTypes.h"
#include "ShiData.h"
#include "WsbMediaFile.h"

/*----------------------------------------------------------------------
|   prototypes
+---------------------------------------------------------------------*/
typedef struct WSB_RightsEnabler WSB_RightsEnabler;

#if defined(__cplusplus)
extern "C" {
#endif

/*----------------------------------------------------------------------
|   constants
+---------------------------------------------------------------------*/
#define WSB_RIGHTSENABLER_OPTION_FLAG_DISABLE_SLA                     0x00000001
#define WSB_RIGHTSENABLER_OPTION_FLAG_DISABLE_LINK_RENEWAL            0x00000002
#define WSB_RIGHTSENABLER_OPTION_FLAG_DISABLE_STORING_LICENSE_IN_FILE 0x00000004

typedef enum {
    WSB_RIGHTSENABLER_EVENT_TYPE_GOTO_URL,
    WSB_RIGHTSENABLER_EVENT_TYPE_TRANSACTION,
    WSB_RIGHTSENABLER_EVENT_TYPE_LICENSE
} WSB_RightsEnabler_EventType;

typedef enum {
    WSB_RIGHTSENABLER_TRANSACTION_SLA,
    WSB_RIGHTSENABLER_TRANSACTION_RENEW_LINK
} WSB_RightsEnabler_TransactionType;

typedef enum {
    WSB_RIGHTSENABLER_HALT_SEARCH,
    WSB_RIGHTSENABLER_CONTINUE_SEARCH
} WSB_RightsEnabler_ContinuationType;

/*----------------------------------------------------------------------
|   types
+---------------------------------------------------------------------*/

typedef struct {
    WSB_RightsEnabler_EventType type;
} WSB_RightsEnabler_Event;

typedef struct {
    WSB_RightsEnabler_Event base;
    const char*             url;
} WSB_RightsEnabler_GotoURLEvent;

typedef struct {
    WSB_RightsEnabler_Event base;
    WSB_Result              processing_result;
    const void*             license_data;
    WSB_Size                license_data_size;
    WSB_Boolean             is_granted;
    SHI_ActionResult*       action_result;
} WSB_RightsEnabler_LicenseEvent;

typedef struct {
    WSB_RightsEnabler_Event           base;
    WSB_RightsEnabler_TransactionType transaction_type;
} WSB_RightsEnabler_TransactionEvent;

typedef struct {
    void* instance;
    WSB_RightsEnabler_ContinuationType
        (*handler)(void* instance, const WSB_RightsEnabler_Event* event);
} WSB_RightsEnabler_EventListener;

/*----------------------------------------------------------------------
|   functions
+---------------------------------------------------------------------*/

WSB_EXPORT WSB_Result 
WSB_RightsEnabler_Create(WSB_RightsEnabler_EventListener listener,
                         WSB_RightsEnabler**             rights_enabler);


WSB_EXPORT WSB_Result
WSB_RightsEnabler_SetOptions(WSB_RightsEnabler* rights_enabler,
                             WSB_UInt32         option_flags);

WSB_EXPORT WSB_Result 
WSB_RightsEnabler_EnableMediaFile(WSB_RightsEnabler* rights_enabler,
                                  WSB_MediaFile*     file,
                                  const char**       content_ids,
                                  WSB_Cardinal       content_ids_count,
                                  const void*        license_data,
                                  WSB_Size           license_data_size);

WSB_EXPORT WSB_Result
WSB_RightsEnabler_EnableContentId(WSB_RightsEnabler* rights_enabler,
                                  const char*        content_id,
                                  const char*        sla_url,
                                  const void*        license_data,
                                  WSB_Size           license_data_size);

WSB_EXPORT WSB_Result
WSB_RightsEnabler_Destroy(WSB_RightsEnabler* rights_enabler);

#if defined(__cplusplus)
}
#endif

#endif /* _WSB_RIGHTS_ENABLER_H_ */