Common APIs

hlmlInit() -> None

Operation:

This API should always be called first before any other API can be called.

Raises:

  • HLMLError_Unknown on any unexpected error.

  • HLMLError_AlreadyInitialized if function was already called.

hlml_init_with_flags(flags=0) -> None

Operation:

This API should always be called first before any other API can be called.

Parameters:

Parameter

Description

flags

Initialization mode – should be set to 0.

Raises:

  • HLMLError_Unknown on any unexpected error.

  • HLMLError_AlreadyInitialized if function was already called.

hlml_shutdown() -> None

Operation:

This API should always be called last after completing all calls to other APIs. The API cleans up all allocated resources.

hlml_device_get_count() -> int

Operation:

Retrieves the number of AIP devices in the system.

Return Value:

Number of accessible AIPs

Raises:

  • HLMLError_Uninitialized if the library has not been successfully initialized.

  • HLMLError_InvalidArgument if device_count is NULL.

  • HLMLError_Unknown on any unexpected error.