WSB_Ms3Sas Class

Marlin MS3 SAS object management. More...

Typedefs
typedef struct WSB_Ms3Sas	WSB_Ms3Sas
	A WSB_Ms3Sas object provides an interface to manipulate an MS3 SAS. More...

Functions
WSB_EXPORT WSB_Result	WSB_Ms3Sas_GetActionResult (WSB_Ms3Sas *sas, SHI_ActionResult **action_result)
	Creates a SHI_ActionResult representing the rights expressed in an MS3 SAS. More...
WSB_EXPORT WSB_Result	WSB_Ms3Sas_AcceptActionResult (WSB_Ms3Sas *sas)
	Accepts the SHI_ActionResult associated with an MS3 SAS. More...
WSB_EXPORT WSB_Result	WSB_Ms3Sas_GetContentKey (WSB_Ms3Sas *sas, const char *content_id, SHI_ContentKeyFormat format, const void *format_parameters, SHI_Data **data)
	Retrieves a content key from an MS3 SAS. More...
WSB_EXPORT WSB_Boolean	WSB_Ms3Sas_HasContentId (WSB_Ms3Sas *sas, const char *content_id)
	Checks that a given content id is indeed present in the MS3 SAS. More...
WSB_EXPORT WSB_Result	WSB_Ms3Sas_ToString (WSB_Ms3Sas *sas, SHI_Data **data)
	Returns a string representation of the contents of the MS3 SAS. More...
WSB_EXPORT WSB_Result	WSB_Ms3Sas_Destroy (WSB_Ms3Sas *sas)
	Destroys a WSB_Ms3Sas object. More...

Detailed Description

Marlin MS3 SAS object management.

Typedef Documentation

typedef struct WSB_Ms3Sas WSB_Ms3Sas

A WSB_Ms3Sas object provides an interface to manipulate an MS3 SAS.

Function Documentation

WSB_EXPORT WSB_Result WSB_Ms3Sas_AcceptActionResult

(

WSB_Ms3Sas *

sas

)

Accepts the SHI_ActionResult associated with an MS3 SAS.

A caller invokes this method to accept the obligations and callbacks associated with the rights expressed in the MS3 SAS.

Parameters

sas	A WSB_Ms3Sas object.

WSB_EXPORT WSB_Result WSB_Ms3Sas_Destroy

(

WSB_Ms3Sas *

sas

)

Destroys a WSB_Ms3Sas object.

Parameters

sas	The WSB_Ms3Sas object to be destroyed.

WSB_EXPORT WSB_Result WSB_Ms3Sas_GetActionResult	(	WSB_Ms3Sas *	sas,
		SHI_ActionResult **	action_result
	)

Creates a SHI_ActionResult representing the rights expressed in an MS3 SAS.

Parameters

sas	A WSB_Ms3Sas object.
action_result	The address of a SHI_ActionResult pointer that will be set to refer to the SHI_ActionResult object created.

WSB_EXPORT WSB_Result WSB_Ms3Sas_GetContentKey	(	WSB_Ms3Sas *	sas,
		const char *	content_id,
		SHI_ContentKeyFormat	format,
		const void *	format_parameters,
		SHI_Data **	data
	)

Retrieves a content key from an MS3 SAS.

If the SAS requires the action result to have been accepted, and this has not been done, an error is returned. Similarly, if the specified content id is not known for this SAS, an error is returned. Otherwise, the content key is returned in the specified format.

Parameters

sas	A WSB_Ms3Sas object.
content_id	The content ID of the content (track) whose content key is desired.
format	The desired format of the content key.
format_parameters	Any parameters required of the content key format.
data	The address of a SHI_Data pointer that will be set to refer to the SHI_Data created by this function. The SHI_Data contains the key.

WSB_EXPORT WSB_Boolean WSB_Ms3Sas_HasContentId	(	WSB_Ms3Sas *	sas,
		const char *	content_id
	)

Checks that a given content id is indeed present in the MS3 SAS.

Parameters

sas	A WSB_Ms3Sas object.
content_id	The content ID of the content.

Returns

WSB_TRUE if the content id is present, WSB_FALSE otherwise.

WSB_EXPORT WSB_Result WSB_Ms3Sas_ToString	(	WSB_Ms3Sas *	sas,
		SHI_Data **	data
	)

Returns a string representation of the contents of the MS3 SAS.

Parameters

sas	A WSB_Ms3Sas object.
data	The address of a SHI_Data pointer that will be returned by this function. The SHI_Data object will be of type SHI_DATA_TYPE_STRING, and its contents will be a string representation of the rights expressed in the SAS.