Wasabi ExpressPlay SDK for Embedded Systems  1.10
Macros | Typedefs | Functions
WsbActionResultInfo.h File Reference

Wasabi Action Result Info API. More...

#include "ShiData.h"
#include "WsbTypes.h"
#include "ShiAction.h"
#include "WsbActionResultConstraint.h"
#include "WsbMediaFile.h"
#include "ShiEngine.h"

Go to the source code of this file.

Macros

#define WSB_ERROR_ARI_HAS_CALLBACKS   (WSB_ERROR_BASE_ARI - 0)
 
#define WSB_ERROR_ARI_INVALID_OBLIGATION   (WSB_ERROR_BASE_ARI - 1)
 
#define WSB_ERROR_ARI_INVALID_CALLBACK   (WSB_ERROR_BASE_ARI - 2)
 
#define WSB_ERROR_ARI_UNSUPPORTED_OBLIGATION   (WSB_ERROR_BASE_ARI - 3)
 

Typedefs

typedef struct WSB_ActionResultInfo WSB_ActionResultInfo
 A WSB_ActionResultInfo object represents information about a SHI_ActionResult. More...
 

Functions

WSB_EXPORT WSB_Result WSB_ExplainActionResultFailure (SHI_ActionResult *action_result, SHI_Engine *engine, WSB_MediaFile *media_file, SHI_Data **goto_url)
 Explains the action result failure (action is not granted) with a meaningful error code and an optional goto URL which semantics is error code dependent (rights issuer URL or link renewal URL (for a WSB_ERROR_DRM_SUBSCRIPTION_EXPIRED case)). More...
 
WSB_EXPORT WSB_Result WSB_ActionResultInfo_Create (SHI_ActionResult *action_result, WSB_ActionResultInfo **info)
 Creates an instance of a WSB_ActionResultInfo object, which analyzes the passed-in SHI_ActionResult object and allows queries on the information contained within that object. More...
 
WSB_EXPORT WSB_Boolean WSB_ActionResultInfo_IsGranted (WSB_ActionResultInfo *info)
 Returns whether the SHI_ActionResult grants access to the associated content keys. More...
 
WSB_EXPORT WSB_Boolean WSB_ActionResultInfo_IsPermanent (WSB_ActionResultInfo *info)
 Returns whether the SHI_ActionResult grants permanent rights to access the content. More...
 
WSB_EXPORT WSB_Boolean WSB_ActionResultInfo_MustAccept (WSB_ActionResultInfo *info)
 Returns whether the caller must explicitly accept the constraints (obligations and/or callbacks) specified by the SHI_ActionResult. More...
 
WSB_EXPORT WSB_Boolean WSB_ActionResultInfo_HasObligations (WSB_ActionResultInfo *info)
 Returns WSB_TRUE if the SHI_ActionResult specifies obligations. More...
 
WSB_EXPORT WSB_Boolean WSB_ActionResultInfo_HasMandatoryObligations (WSB_ActionResultInfo *info)
 Returns WSB_TRUE if the SHI_ActionResult specifies mandatory obligations. More...
 
WSB_EXPORT WSB_Boolean WSB_ActionResultInfo_HasCallbacks (WSB_ActionResultInfo *info)
 Returns WSB_TRUE if the SHI_ActionResult specifies callbacks. More...
 
WSB_EXPORT WSB_Boolean WSB_ActionResultInfo_HasMandatoryCallbacks (WSB_ActionResultInfo *info)
 Returns WSB_TRUE if the SHI_ActionResult specifies mandatory callbacks. More...
 
WSB_EXPORT WSB_Cardinal WSB_ActionResultInfo_GetConstraintCount (WSB_ActionResultInfo *info, WSB_Boolean mandatory_only)
 Returns the count of constraints, which includes obligations and callbacks. More...
 
WSB_EXPORT WSB_Result WSB_ActionResultInfo_GetConstraintByIndex (WSB_ActionResultInfo *info, WSB_Boolean mandatory_only, WSB_Ordinal indx, WSB_ActionResultConstraint **constraint)
 Returns a constraint, specified by index, from all constraints reflected in the SHI_ActionResult object. More...
 
WSB_EXPORT WSB_Result WSB_ActionResultInfo_Destroy (WSB_ActionResultInfo *store)
 Destroys the WSB_ActionResultInfo object. More...
 

Detailed Description

Wasabi Action Result Info API.

Macro Definition Documentation

#define WSB_ERROR_ARI_HAS_CALLBACKS   (WSB_ERROR_BASE_ARI - 0)
#define WSB_ERROR_ARI_INVALID_CALLBACK   (WSB_ERROR_BASE_ARI - 2)
#define WSB_ERROR_ARI_INVALID_OBLIGATION   (WSB_ERROR_BASE_ARI - 1)
#define WSB_ERROR_ARI_UNSUPPORTED_OBLIGATION   (WSB_ERROR_BASE_ARI - 3)