Wasabi ExpressPlay SDK for Embedded Systems  1.23.0
Typedefs | Functions
SHI_LicenseInfo class

Marlin license information object. More...

Typedefs

typedef struct SHI_LicenseInfo SHI_LicenseInfo
 A SHI_LicenseInfo object represents the information for a license or for an action of a license (such as SHI_ACTION_PLAY). More...
 

Functions

SHI_PUBLIC_API void * SHI_LicenseInfo_GetInterface (SHI_LicenseInfo *self, SHI_InterfaceId iface_id)
 Obtains a pointer to a SHI_LicenseInfo object with a different interface. More...
 
SHI_PUBLIC_API SHI_Result SHI_LicenseInfo_Release (SHI_LicenseInfo *self)
 Releases this license description object. More...
 
SHI_PUBLIC_API SHI_Result SHI_LicenseInfo_GetDescription (SHI_LicenseInfo *self, SHI_LicenseDescriptionStyle style, SHI_Attribute **description)
 Returns a textual description of this license info. More...
 
SHI_PUBLIC_API SHI_Result SHI_LicenseInfo_GetDetails (SHI_LicenseInfo *self, SHI_Attribute **details)
 Gets the details of this license info. More...
 

Detailed Description

Marlin license information object.

Typedef Documentation

◆ SHI_LicenseInfo

A SHI_LicenseInfo object represents the information for a license or for an action of a license (such as SHI_ACTION_PLAY).

Function Documentation

◆ SHI_LicenseInfo_GetDescription()

SHI_PUBLIC_API SHI_Result SHI_LicenseInfo_GetDescription ( SHI_LicenseInfo self,
SHI_LicenseDescriptionStyle  style,
SHI_Attribute **  description 
)

Returns a textual description of this license info.

If the license info has no textual description, this method returns SHI_ERROR_NO_SUCH_ITEM.

Parameters
selfThe SHI_LicenseInfo whose description will be returned.
styleThe identifier for one of the several description styles that may be encoded in the license description. If the license info has a textual description, the style SHI_LICENSE_DESCRIPTION_STYLE_DEFAULT is always available. Other styles may or may not be available. If the requested style is not available, this method returns SHI_ERROR_NO_SUCH_ITEM.
descriptionAddress of a SHI_Attribute pointer that will be set to reference an attribute of type SHI_ATTRIBUTE_TYPE_RESOURCE representing a textual resource.

◆ SHI_LicenseInfo_GetDetails()

SHI_PUBLIC_API SHI_Result SHI_LicenseInfo_GetDetails ( SHI_LicenseInfo self,
SHI_Attribute **  details 
)

Gets the details of this license info.

These details are returned as a tree of SHI_Attribute objects that represent detailed DRM information encoded in the license. If no details are available for this license info, this method returns SHI_ERROR_NOT_AVAILABLE.

Parameters
selfThe SHI_LicenseInfo whose details will be returned.
detailsAddress of a SHI_Attribute pointer that will be set to refer to a SHI_Attribute object containing the details.

◆ SHI_LicenseInfo_GetInterface()

SHI_PUBLIC_API void* SHI_LicenseInfo_GetInterface ( SHI_LicenseInfo self,
SHI_InterfaceId  iface_id 
)

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

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

Parameters
selfThe SHI_LicenseInfo 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_LicenseInfo_Release()

SHI_PUBLIC_API SHI_Result SHI_LicenseInfo_Release ( SHI_LicenseInfo self)

Releases this license description object.

This 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_LicenseInfo to release.