Wasabi ExpressPlay SDK for Embedded Systems  1.23.0
Typedefs | Functions
SHI_ActionResult Class

A Wasabi Action processing results module. More...

Typedefs

typedef struct SHI_ActionResult SHI_ActionResult
 A SHI_ActionResult object represents the result returned by several different SHI_Action methods. More...
 

Functions

SHI_PUBLIC_API void * SHI_ActionResult_GetInterface (SHI_ActionResult *self, SHI_InterfaceId iface_id)
 Obtains a pointer to a SHI_ActionResult object with a different interface. More...
 
SHI_PUBLIC_API SHI_Result SHI_ActionResult_Release (SHI_ActionResult *self)
 Releases this action result object. More...
 
SHI_PUBLIC_API SHI_Result SHI_ActionResult_GetObligations (SHI_ActionResult *self, SHI_List **obligations)
 Returns a list of obligations for this action result object. More...
 
SHI_PUBLIC_API SHI_Result SHI_ActionResult_GetCallbacks (SHI_ActionResult *self, SHI_List **callbacks)
 Returns a list of callbacks for this action result object. More...
 
SHI_PUBLIC_API SHI_Result SHI_ActionResult_GetInfo (SHI_ActionResult *self, SHI_ActionResultInfo *info)
 Returns information about this action result object. More...
 
SHI_PUBLIC_API SHI_Result SHI_ActionResult_GetDetails (SHI_ActionResult *self, SHI_Attribute **details)
 Returns details for this action result object. More...
 
SHI_PUBLIC_API SHI_Result SHI_ActionResult_Accept (SHI_ActionResult *self)
 Accepts the action result. More...
 
SHI_PUBLIC_API SHI_Boolean SHI_ActionResult_IsFromMs3 (SHI_ActionResult *self)
 Returns boolean status on whether this action result object is associated with Marlin MS3. More...
 

Detailed Description

A Wasabi Action processing results module.

Typedef Documentation

◆ SHI_ActionResult

A SHI_ActionResult object represents the result returned by several different SHI_Action methods.

Function Documentation

◆ SHI_ActionResult_Accept()

SHI_PUBLIC_API SHI_Result SHI_ActionResult_Accept ( SHI_ActionResult self)

Accepts the action result.

This function must be called if the SHI_ACTION_RESULT_MUST_ACCEPT flag is present in the SHI_ActionResultInfo data structure gotten from the SHI_ActionResult_GetInfo call. If this flag is present, the SHI_License_GetContentKey method will fail till this function has been called.

If the application does not understand or is not able to perform the critical obligations or callbacks of the action result, it MUST NOT call this method and MUST fail the whole action.

Parameters
selfThe SHI_ActionResult that will be accepted by the application.

◆ SHI_ActionResult_GetCallbacks()

SHI_PUBLIC_API SHI_Result SHI_ActionResult_GetCallbacks ( SHI_ActionResult self,
SHI_List **  callbacks 
)

Returns a list of callbacks for this action result object.

Callbacks are functions that the application is required to call when certain conditions occur. The SHI_List object returned must be released before this action result is released.

Parameters
selfThe SHI_ActionResult whose callbacks will be returned.
callbacksAddress of a SHI_List pointer that will be set to refer to a SHI_List object containing the list of callbacks. The list contains SHI_Data items that each have values of type SHI_DATA_TYPE_POINTER pointing to a SHI_ActionCallback struct. Each SHI_Data item has a value with the type_id field set to SHI_DATA_POINTER_TYPE_ID_CALLBACK.

◆ SHI_ActionResult_GetDetails()

SHI_PUBLIC_API SHI_Result SHI_ActionResult_GetDetails ( SHI_ActionResult self,
SHI_Attribute **  details 
)

Returns details for this action result object.

The SHI_Attribute object returned must be released before this action result is released.

Parameters
selfThe SHI_ActionResult whose details will be returned.
detailsAddress of a SHI_Attribute pointer that will be set to refer to a SHI_Attribute object containing a tree of attributes representing the details of this action result.

◆ SHI_ActionResult_GetInfo()

SHI_PUBLIC_API SHI_Result SHI_ActionResult_GetInfo ( SHI_ActionResult self,
SHI_ActionResultInfo info 
)

Returns information about this action result object.

The information returned in the SHI_ActionResultInfo struct includes, among other things, an indication of whether the action requested has been granted or denied.

Parameters
selfThe SHI_ActionResult whose information will be returned.
infoA pointer to a SHI_ActionResultInfo struct in which information about this action result will be returned.

◆ SHI_ActionResult_GetInterface()

SHI_PUBLIC_API void* SHI_ActionResult_GetInterface ( SHI_ActionResult self,
SHI_InterfaceId  iface_id 
)

Obtains a pointer to a SHI_ActionResult object with a different interface.

This method returns NULL if the object does not implement the requested interface.

Parameters
selfThe SHI_ActionResult whose interface will be returned.
iface_idThe ID of the interface that is requested.
Returns
A pointer to the requested interface, or NULL if the object does not implement it.

◆ SHI_ActionResult_GetObligations()

SHI_PUBLIC_API SHI_Result SHI_ActionResult_GetObligations ( SHI_ActionResult self,
SHI_List **  obligations 
)

Returns a list of obligations for this action result object.

Obligations represent things that the application is required to perform or obey. The SHI_List object returned must be released before this action result is released.

Parameters
selfThe SHI_ActionResult whose obligations will be returned.
obligationsAddress of a SHI_List pointer that will be set to refer to a SHI_List object containing the list of obligations. The list contains SHI_Data items that each have values of type SHI_DATA_TYPE_POINTER pointing to a SHI_ActionObligation struct. Each SHI_Data item has a value with the type_id field set to SHI_DATA_POINTER_TYPE_ID_OBLIGATION.

◆ SHI_ActionResult_IsFromMs3()

SHI_PUBLIC_API SHI_Boolean SHI_ActionResult_IsFromMs3 ( SHI_ActionResult self)

Returns boolean status on whether this action result object is associated with Marlin MS3.

If not, this action result is associated with Marlin Broadband.

Parameters
selfThe SHI_ActionResult for which the check is performed.

◆ SHI_ActionResult_Release()

SHI_PUBLIC_API SHI_Result SHI_ActionResult_Release ( SHI_ActionResult self)

Releases this action result object.

The object can no longer be used after this method returns. All objects obtained from method calls to this object must be released before this object is released.

Parameters
selfThe SHI_ActionResult to release.