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

A media service subscriber APIs module. More...

Typedefs

typedef struct SHI_ServiceUser SHI_ServiceUser
 A SHI_ServiceUser object represents information about a service user. More...
 

Functions

SHI_PUBLIC_API void * SHI_ServiceUser_GetInterface (SHI_ServiceUser *self, SHI_InterfaceId iface_id)
 Obtains a pointer to a SHI_ServiceUser object with a different interface. More...
 
SHI_PUBLIC_API SHI_Result SHI_ServiceUser_Release (SHI_ServiceUser *self)
 Releases this service user object. More...
 
SHI_PUBLIC_API SHI_Result SHI_ServiceUser_GetInfo (SHI_ServiceUser *self, SHI_ServiceUserInfo *info)
 Gets basic information about this service user. More...
 
SHI_PUBLIC_API SHI_Result SHI_ServiceUser_GetDetails (SHI_ServiceUser *self, SHI_Attribute **details)
 Gets the details of this service user. More...
 

Detailed Description

A media service subscriber APIs module.

Typedef Documentation

◆ SHI_ServiceUser

A SHI_ServiceUser object represents information about a service user.

Function Documentation

◆ SHI_ServiceUser_GetDetails()

SHI_PUBLIC_API SHI_Result SHI_ServiceUser_GetDetails ( SHI_ServiceUser self,
SHI_Attribute **  details 
)

Gets the details of this service user.

These details are returned as a tree of SHI_Attribute objects that represent detailed information about the service user. If no details are available for this service user, this method returns SHI_ERROR_NOT_AVAILABLE.

Parameters
selfThe SHI_ServiceUser 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_ServiceUser_GetInfo()

SHI_PUBLIC_API SHI_Result SHI_ServiceUser_GetInfo ( SHI_ServiceUser self,
SHI_ServiceUserInfo info 
)

Gets basic information about this service user.

Parameters
selfThe SHI_ServiceUser for which the information is obtained.
infoA pointer to a SHI_ServiceUserInfo structure in which the information will be returned.

◆ SHI_ServiceUser_GetInterface()

SHI_PUBLIC_API void* SHI_ServiceUser_GetInterface ( SHI_ServiceUser self,
SHI_InterfaceId  iface_id 
)

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

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

Parameters
selfThe SHI_ServiceUser 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_ServiceUser_Release()

SHI_PUBLIC_API SHI_Result SHI_ServiceUser_Release ( SHI_ServiceUser self)

Releases this service user 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_ServiceUser to release.