SHI_ServiceSubscription Class

A media service subscription APIs module. More...

Typedefs
typedef struct SHI_ServiceSubscription	SHI_ServiceSubscription
	A SHI_ServiceSubscription object represents information about a service subscription. More...

Functions
SHI_PUBLIC_API void *	SHI_ServiceSubscription_GetInterface (SHI_ServiceSubscription *self, SHI_InterfaceId iface_id)
	Obtains a pointer to a SHI_ServiceSubscription object with a different interface. More...
SHI_PUBLIC_API SHI_Result	SHI_ServiceSubscription_Release (SHI_ServiceSubscription *self)
	Releases this service subscription object. More...
SHI_PUBLIC_API SHI_Result	SHI_ServiceSubscription_GetInfo (SHI_ServiceSubscription *self, SHI_ServiceSubscriptionInfo *info)
	Gets basic information about this service subscription. More...
SHI_PUBLIC_API SHI_Result	SHI_ServiceSubscription_GetDetails (SHI_ServiceSubscription *self, SHI_Attribute **details)
	Gets the details of this service subscription. More...

Detailed Description

A media service subscription APIs module.

Typedef Documentation

typedef struct SHI_ServiceSubscription SHI_ServiceSubscription

A SHI_ServiceSubscription object represents information about a service subscription.

Function Documentation

SHI_PUBLIC_API SHI_Result SHI_ServiceSubscription_GetDetails	(	SHI_ServiceSubscription *	self,
		SHI_Attribute **	details
	)

Gets the details of this service subscription.

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

Parameters

self	The SHI_ServiceSubscription whose details will be returned.
details	Address of a SHI_Attribute pointer that will be set to refer to a SHI_Attribute object containing the details.

SHI_PUBLIC_API SHI_Result SHI_ServiceSubscription_GetInfo	(	SHI_ServiceSubscription *	self,
		SHI_ServiceSubscriptionInfo *	info
	)

Gets basic information about this service subscription.

Parameters

self	The SHI_ServiceSubscription for which the information is obtained.
info	A pointer to a SHI_ServiceSubscriptionInfo structure in which the information will be returned.

SHI_PUBLIC_API void* SHI_ServiceSubscription_GetInterface	(	SHI_ServiceSubscription *	self,
		SHI_InterfaceId	iface_id
	)

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

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

Parameters

self	The SHI_ServiceSubscription whose interface will be returned.
iface_id	The ID of the interface that is requested.

Returns

A pointer to the requested interface, or NULL if the object does not implement it.

SHI_PUBLIC_API SHI_Result SHI_ServiceSubscription_Release

(

SHI_ServiceSubscription *

self

)

Releases this service subscription 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

self	The SHI_ServiceSubscription to release.