TuningFork_Settings

#include <tuningfork.h>

初始化设置。请将所有未使用的值置零。

摘要

公共属性

api_key
const char *
如果非空,此值将覆盖应用 tuningfork_settings.bin 文件中的 api_key 字段。
endpoint_uri_override
const char *
一个以 null 终止的 UTF-8 字符串,其中包含 Tuning Fork 将连接的用于参数、上传和调试请求的端点。
fidelity_params_callback
回调。如果已设置,则会调用此回调,并传入下载的保真度参数。
max_num_metrics
任何给定时间允许分配的每种指标的数量。
persistent_cache
用于上传数据持久化的缓存对象。
swappy_tracer_fn
Swappy_injectTracers 函数的地址。
swappy_version
uint32_t
swappy_tracer_fn 所属的 Swappy 版本。
training_fidelity_params
一个序列化的 protobuf,其中包含要上传进行训练的保真度参数。
verbose_logging_enabled
bool
如果为 false,敏感信息将从日志记录中移除。

公共属性

api_key

const char * TuningFork_Settings::api_key

如果非空,此值将覆盖应用 tuningfork_settings.bin 文件中的 api_key 字段。

如需了解详情,请参阅 tuningfork.proto。

endpoint_uri_override

const char * TuningFork_Settings::endpoint_uri_override

一个以 null 终止的 UTF-8 字符串,其中包含 Tuning Fork 将连接的用于参数、上传和调试请求的端点。

此值会覆盖 settings proto 中 base_uri 的值,仅用于调试目的。

fidelity_params_callback

TuningFork_FidelityParamsCallback TuningFork_Settings::fidelity_params_callback

回调。如果已设置,则会调用此回调,并传入下载的保真度参数。

如果为 null,则您需要自行调用 TuningFork_getFidelityParameters。

max_num_metrics

TuningFork_MetricLimits TuningFork_Settings::max_num_metrics

任何给定时间允许分配的每种指标的数量。

如果任何元素为零,将使用该指标类型的默认值。所有指标的内存都在初始化时预先分配。当给定类型的所有指标都已分配后,进一步请求的指标将不会被添加,并且数据会丢失。

persistent_cache

const TuningFork_Cache * TuningFork_Settings::persistent_cache

用于上传数据持久化的缓存对象。

如果为 null,数据将持久化到 /data/local/tmp/tuningfork

swappy_tracer_fn

SwappyTracerFn TuningFork_Settings::swappy_tracer_fn

Swappy_injectTracers 函数的地址。

如果为 null,则您需要自行调用 TuningFork_tick。如果已设置,则会自动记录 4 个 instrument key 的遥测数据。

swappy_version

uint32_t TuningFork_Settings::swappy_version

swappy_tracer_fn 所属的 Swappy 版本。

training_fidelity_params

const TuningFork_CProtobufSerialization * TuningFork_Settings::training_fidelity_params

一个序列化的 protobuf,其中包含要上传进行训练的保真度参数。

如果您不使用训练模式,请将其设置为 nullptr。在训练模式下,这些参数被视为游戏中使用的参数,用于帮助为不同设备建议参数更改。请注意,这些参数会覆盖启动时从 APK 加载的默认参数。

verbose_logging_enabled

bool TuningFork_Settings::verbose_logging_enabled

如果为 false,敏感信息将从日志记录中移除。

默认为 false。