Function scs_sdk_rs::scs_telemetry_init

source ·

pub unsafe extern "C" fn scs_telemetry_init(
    version: scs_u32_t,
    params: *const scs_telemetry_init_params_t
) -> scs_result_t

Expand description

@brief Initializes telemetry support.

This function must be provided by the library if it wants to support telemetry API.

The engine will call this function with API versions it supports starting from the latest until the function returns SCS_RESULT_ok or error other than SCS_RESULT_unsupported or it runs out of supported versions.

At the time this function is called, the telemetry is in the paused state.

@param version Version of the API to initialize. @param params Structure with additional initialization data specific to the specified API version. @return SCS_RESULT_ok if version is supported and library was initialized. Error code otherwise.