Wasabi ExpressPlay SDK for Embedded Systems  1.23.0
Data Structures | Macros | Typedefs | Enumerations | Functions
WsbRightsEnabler.h File Reference

Wasabi Rights Enabler API. More...

#include "WsbTypes.h"
#include "ShiData.h"
#include "WsbMediaFile.h"

Go to the source code of this file.

Data Structures

struct  WSB_RightsEnabler_Event
 Structure used as the base for all event structures. More...
 
struct  WSB_RightsEnabler_GotoURLEvent
 Event data for reporting that the Rights Enabler has been directed to a service for obtaining needed rights. More...
 
struct  WSB_RightsEnabler_LicenseEvent
 Event data for reporting a license that was found and evaluated. More...
 
struct  WSB_RightsEnabler_TransactionEvent
 Event data for reporting that a service transaction has been initiated in an attempt to obtain rights. More...
 
struct  WSB_RightsEnabler_EventListener
 This struct pairs a listener instance value with a function pointer for receiving events. More...
 

Macros

#define WSB_RIGHTSENABLER_OPTION_FLAG_DISABLE_SLA   0x00000001
 Flags for options. More...
 
#define WSB_RIGHTSENABLER_OPTION_FLAG_DISABLE_LINK_RENEWAL   0x00000002
 
#define WSB_RIGHTSENABLER_OPTION_FLAG_DISABLE_STORING_LICENSE_IN_FILE   0x00000004
 

Typedefs

typedef struct WSB_RightsEnabler WSB_RightsEnabler
 A WSB_RightsEnabler object can be used to do everything possible to obtain a valid license for content. More...
 

Enumerations

enum  WSB_RightsEnabler_EventType {
  WSB_RIGHTSENABLER_EVENT_TYPE_GOTO_URL,
  WSB_RIGHTSENABLER_EVENT_TYPE_TRANSACTION,
  WSB_RIGHTSENABLER_EVENT_TYPE_LICENSE
}
 Identifiers for event types. More...
 
enum  WSB_RightsEnabler_TransactionType {
  WSB_RIGHTSENABLER_TRANSACTION_SLA,
  WSB_RIGHTSENABLER_TRANSACTION_RENEW_LINK
}
 Identifiers for transactions. More...
 
enum  WSB_RightsEnabler_ContinuationType {
  WSB_RIGHTSENABLER_HALT_SEARCH,
  WSB_RIGHTSENABLER_CONTINUE_SEARCH
}
 Constants used by listener to direct Rights Enabler on whether or not to continue to search for licenses. More...
 

Functions

WSB_EXPORT WSB_Result WSB_RightsEnabler_Create (WSB_RightsEnabler_EventListener listener, WSB_RightsEnabler **rights_enabler)
 Creates an instance of a WSB_RightsEnabler object. More...
 
WSB_EXPORT WSB_Result WSB_RightsEnabler_SetOptions (WSB_RightsEnabler *rights_enabler, WSB_UInt32 option_flags)
 Sets the options flags (WSB_RIGHTSENABLER_OPTION_FLAG*). More...
 
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)
 Tries all available avenues to obtain a working license for the content with the specified content IDs. More...
 
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)
 Tries all available avenues to obtain a working license for the content with the specified content ID. More...
 
WSB_EXPORT WSB_Result WSB_RightsEnabler_Destroy (WSB_RightsEnabler *rights_enabler)
 Releases an instance of a WSB_RightsEnabler object. More...
 

Detailed Description

Wasabi Rights Enabler API.

Macro Definition Documentation

◆ WSB_RIGHTSENABLER_OPTION_FLAG_DISABLE_LINK_RENEWAL

#define WSB_RIGHTSENABLER_OPTION_FLAG_DISABLE_LINK_RENEWAL   0x00000002

◆ WSB_RIGHTSENABLER_OPTION_FLAG_DISABLE_SLA

#define WSB_RIGHTSENABLER_OPTION_FLAG_DISABLE_SLA   0x00000001

Flags for options.

◆ WSB_RIGHTSENABLER_OPTION_FLAG_DISABLE_STORING_LICENSE_IN_FILE

#define WSB_RIGHTSENABLER_OPTION_FLAG_DISABLE_STORING_LICENSE_IN_FILE   0x00000004

Typedef Documentation

◆ WSB_RightsEnabler

A WSB_RightsEnabler object can be used to do everything possible to obtain a valid license for content.

Enumeration Type Documentation

◆ WSB_RightsEnabler_ContinuationType

Constants used by listener to direct Rights Enabler on whether or not to continue to search for licenses.

Enumerator
WSB_RIGHTSENABLER_HALT_SEARCH 
WSB_RIGHTSENABLER_CONTINUE_SEARCH 

◆ WSB_RightsEnabler_EventType

Identifiers for event types.

See also
WSB_RightsEnabler_Event
Enumerator
WSB_RIGHTSENABLER_EVENT_TYPE_GOTO_URL 
WSB_RIGHTSENABLER_EVENT_TYPE_TRANSACTION 
WSB_RIGHTSENABLER_EVENT_TYPE_LICENSE 

◆ WSB_RightsEnabler_TransactionType

Identifiers for transactions.

See also
WSB_RightsEnabler_TransactionEvent
Enumerator
WSB_RIGHTSENABLER_TRANSACTION_SLA 
WSB_RIGHTSENABLER_TRANSACTION_RENEW_LINK