WsbActionResultInfo.h

Go to the documentation of this file.

/*****************************************************************
|
|   Wasabi - Action Result Info API
|
|   $Id: WsbActionResultInfo.h 12695 2016-10-28 22:10:37Z hwa $
|   Original author: Eric Swenson
|
|   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_ACTION_RESULT_INFO_H_
#define _WSB_ACTION_RESULT_INFO_H_

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

/*----------------------------------------------------------------------
|   result codes
+---------------------------------------------------------------------*/
#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)

/*----------------------------------------------------------------------
|   constants
+---------------------------------------------------------------------*/
// target portion for security class of secure content path in output control
#define WSB_ARI_TARGET_PORTION_ALL   0
#define WSB_ARI_TARGET_PORTION_AUDIO 1
#define WSB_ARI_TARGET_PORTION_VIDEO 2

/*----------------------------------------------------------------------
|   interfaces
+---------------------------------------------------------------------*/
#if defined(__cplusplus)
extern "C" {
#endif

WSB_EXPORT WSB_Result
WSB_ExplainActionResultFailure(SHI_ActionResult* action_result,
                               SHI_Engine*       engine,
                               WSB_MediaFile*    media_file,
                               SHI_Data**        goto_url);

typedef struct WSB_ActionResultInfo WSB_ActionResultInfo;

WSB_EXPORT WSB_Result
WSB_ActionResultInfo_Create(SHI_ActionResult*      action_result,
                            WSB_ActionResultInfo** info);

WSB_EXPORT WSB_Boolean
WSB_ActionResultInfo_IsGranted(WSB_ActionResultInfo* info);

WSB_EXPORT WSB_Boolean
WSB_ActionResultInfo_IsPermanent(WSB_ActionResultInfo* info);

WSB_EXPORT WSB_Boolean
WSB_ActionResultInfo_MustAccept(WSB_ActionResultInfo* info);

WSB_EXPORT WSB_Boolean
WSB_ActionResultInfo_HasObligations(WSB_ActionResultInfo* info);

WSB_EXPORT WSB_Boolean
WSB_ActionResultInfo_HasMandatoryObligations(WSB_ActionResultInfo* info);

WSB_EXPORT WSB_Boolean
WSB_ActionResultInfo_HasCallbacks(WSB_ActionResultInfo* info);

WSB_EXPORT WSB_Boolean
WSB_ActionResultInfo_HasMandatoryCallbacks(WSB_ActionResultInfo* info);

WSB_EXPORT WSB_Cardinal
WSB_ActionResultInfo_GetConstraintCount(WSB_ActionResultInfo* info,
                                        WSB_Boolean           mandatory_only);
                                        
WSB_EXPORT WSB_Result
WSB_ActionResultInfo_GetConstraintByIndex(WSB_ActionResultInfo*        info,
                                          WSB_Boolean                  mandatory_only,
                                          WSB_Ordinal                  indx,
                                          WSB_ActionResultConstraint** constraint);

WSB_EXPORT WSB_Result
WSB_ActionResultInfo_CheckSecurityClasses(WSB_ActionResultInfo* info,
                                          const WSB_Int32       sec_classes[],
                                          WSB_UInt32            num_sec_classes,
                                          const char*           content_id,
                                          WSB_Int32             target_portion);

WSB_EXPORT WSB_Result
WSB_ActionResultInfo_CheckHdcpSrm(WSB_ActionResultInfo* info);

WSB_EXPORT WSB_Result
WSB_ActionResultInfo_Destroy(WSB_ActionResultInfo* store);

#if defined(__cplusplus)
}
#endif

#endif /* _WSB_ACTION_RESULT_INFO_H_ */