ShiLicense.h File Reference

Licenses. More...

#include "ShiResults.h"
#include "ShiTypes.h"
#include "ShiList.h"
#include "ShiData.h"
#include "ShiAction.h"
#include "ShiAttributes.h"
#include "ShiLicenseInfo.h"
#include "ShiCrypto.h"

Go to the source code of this file.

Macros
#define	SHI_ERROR_LICENSE_IDS_ALREADY_SET   (SHI_ERROR_BASE_API_LICENSE - 0)
#define	SHI_ERROR_LICENSE_ID_NOT_FOUND   (SHI_ERROR_BASE_API_LICENSE - 1)
#define	SHI_ERROR_LICENSE_INVALID_DATA   (SHI_ERROR_BASE_API_LICENSE - 2)
#define	SHI_ERROR_LICENSE_ACTION_PENDING   (SHI_ERROR_BASE_API_LICENSE - 3)
#define	SHI_ERROR_LICENSE_MUST_PERFORM   (SHI_ERROR_BASE_API_LICENSE - 4)
#define	SHI_ERROR_LICENSE_INCOMPLETE_DATA   (SHI_ERROR_BASE_API_LICENSE - 5)
#define	SHI_ERROR_LICENSE_NO_SUCH_ACTION   (SHI_ERROR_BASE_API_LICENSE - 6)
#define	SHI_ERROR_LICENSE_ACCEPT_FAILED   (SHI_ERROR_BASE_API_LICENSE - 7)
#define	SHI_ERROR_LICENSE_CALLBACK_NOT_FOUND   (SHI_ERROR_BASE_API_LICENSE - 8)
#define	SHI_ERROR_LICENSE_CALLBACK_FAILED   (SHI_ERROR_BASE_API_LICENSE - 9)
#define	SHI_ERROR_LICENSE_MUST_ACCEPT   (SHI_ERROR_BASE_API_LICENSE - 10)
#define	SHI_ERROR_LICENSE_PARSE_FAILURE   (SHI_ERROR_BASE_API_LICENSE - 11)

Typedefs
typedef struct SHI_License	SHI_License
	A SHI_License object represents the license information for a piece of content. More...

Enumerations
enum	SHI_ContentKeyFormat {   SHI_CONTENT_KEY_FORMAT_CLEARTEXT,   SHI_CONTENT_KEY_FORMAT_SKB_STANDARD,   SHI_CONTENT_KEY_FORMAT_SKB_CUSTOM }
	Format indenfifier for content keys. More...

Functions
SHI_PUBLIC_API void *	SHI_License_GetInterface (SHI_License *self, SHI_InterfaceId iface_id)
	Obtains a pointer to a SHI_License object with a different interface. More...
SHI_PUBLIC_API SHI_Result	SHI_License_Destroy (SHI_License *self)
	Destroys this license object. More...
SHI_PUBLIC_API SHI_Result	SHI_License_Describe (SHI_License *self, SHI_LicenseInfo **description)
	Gets a description for this license. More...
SHI_PUBLIC_API SHI_Result	SHI_License_ProcessLicenseData (SHI_License *self, const void *data, SHI_Size size)
	Registers a license data element that contains Octopus data for this license. More...
SHI_PUBLIC_API SHI_Result	SHI_License_SetContentIds (SHI_License *self, const char *const *ids, SHI_Cardinal id_count)
	Specifies a set of content IDs for this license. More...
SHI_PUBLIC_API SHI_Result	SHI_License_GetContentKey (SHI_License *self, const char *content_id, SHI_ContentKeyFormat format, const void *format_parameters, SHI_Data **data)
	Gets the content key for a specific content ID. More...
SHI_PUBLIC_API SHI_Result	SHI_License_CreateAction (SHI_License *self, const char *name, const void *parameters, SHI_Action **action)
	Creates a SHI_Action object for this license. More...
SHI_PUBLIC_API SHI_Result	SHI_License_CreateActionEx (SHI_License *self, const char *name, const void *parameters, SHI_Size parameters_size, SHI_Action **action)
	This function is similar to SHI_License_CreateAction, but can be used for arbitrary actions, even those for which this programming interface does not define any data structure to represent the parameters. More...

Detailed Description

Licenses.

Macro Definition Documentation

SHI_ERROR_LICENSE_ACCEPT_FAILED

#define SHI_ERROR_LICENSE_ACCEPT_FAILED   (SHI_ERROR_BASE_API_LICENSE - 7)

SHI_ERROR_LICENSE_ACTION_PENDING

#define SHI_ERROR_LICENSE_ACTION_PENDING   (SHI_ERROR_BASE_API_LICENSE - 3)

SHI_ERROR_LICENSE_CALLBACK_FAILED

#define SHI_ERROR_LICENSE_CALLBACK_FAILED   (SHI_ERROR_BASE_API_LICENSE - 9)

SHI_ERROR_LICENSE_CALLBACK_NOT_FOUND

#define SHI_ERROR_LICENSE_CALLBACK_NOT_FOUND   (SHI_ERROR_BASE_API_LICENSE - 8)

SHI_ERROR_LICENSE_ID_NOT_FOUND

#define SHI_ERROR_LICENSE_ID_NOT_FOUND   (SHI_ERROR_BASE_API_LICENSE - 1)

SHI_ERROR_LICENSE_IDS_ALREADY_SET

#define SHI_ERROR_LICENSE_IDS_ALREADY_SET   (SHI_ERROR_BASE_API_LICENSE - 0)

SHI_ERROR_LICENSE_INCOMPLETE_DATA

#define SHI_ERROR_LICENSE_INCOMPLETE_DATA   (SHI_ERROR_BASE_API_LICENSE - 5)

SHI_ERROR_LICENSE_INVALID_DATA

#define SHI_ERROR_LICENSE_INVALID_DATA   (SHI_ERROR_BASE_API_LICENSE - 2)

SHI_ERROR_LICENSE_MUST_ACCEPT

#define SHI_ERROR_LICENSE_MUST_ACCEPT   (SHI_ERROR_BASE_API_LICENSE - 10)

SHI_ERROR_LICENSE_MUST_PERFORM

#define SHI_ERROR_LICENSE_MUST_PERFORM   (SHI_ERROR_BASE_API_LICENSE - 4)

SHI_ERROR_LICENSE_NO_SUCH_ACTION

#define SHI_ERROR_LICENSE_NO_SUCH_ACTION   (SHI_ERROR_BASE_API_LICENSE - 6)

SHI_ERROR_LICENSE_PARSE_FAILURE

#define SHI_ERROR_LICENSE_PARSE_FAILURE   (SHI_ERROR_BASE_API_LICENSE - 11)