Google.Android.PerformanceTuner.AndroidPerformanceTuner< TFidelity, TAnnotation >

Es la clase principal para crear una instancia de configuración y ejecución de Android Performance Tuner.

Resumen

Detalles
Parámetros de la plantilla
TFidelity
Es la clase de mensaje FidelityParams generada por el complemento.
TAnnotation
Es la clase de mensaje Annotation generada por el complemento.

Atributos públicos
onReceiveFidelityParameters
Action< TFidelity >
Es la acción a la que se llama cada vez que se establecen parámetros de fidelidad nuevos.
onReceiveUploadLog
Action< UploadTelemetryRequest >
Es la acción a la que se llama cada vez que se sube un registro.

Funciones públicas
EnableLocalEndpoint()
Habilita el extremo local.
FindFidelityParametersInApk(string filename)
Result< TFidelity >
Carga los parámetros de fidelidad desde la carpeta "assets/tuningfork/" del APK.
Flush()
Fuerza la carga de los histogramas actuales.
FrameTick(InstrumentationKeys key)
Graba una marca de fotograma que se asociará a la etiqueta de marca y a la anotación actual.
GetFidelityParameters(TFidelity defaultFidelity, uint initialTimeoutMs)
Result< TFidelity >
Es una llamada de bloqueo para obtener los parámetros de fidelidad del servidor.
SetCurrentAnnotation(TAnnotation annotation)
Establece la anotación actual.
SetFidelityParameters(TFidelity fidelityParams)
Establece los parámetros de fidelidad actualmente activos.
SetLoadingState(MessageUtil.LoadingState state)
Configura el estado de carga.
Start()
Inicia AndroidPerformanceTuner.
Stop()
Detiene Android Performance Tuner.
SwappyIsEnabled()
bool
Muestra si la opción de Swappy está habilitada o no.

Atributos públicos

onReceiveFidelityParameters

Action< TFidelity > onReceiveFidelityParameters

Es la acción a la que se llama cada vez que se establecen parámetros de fidelidad nuevos.

onReceiveUploadLog

Action< UploadTelemetryRequest > onReceiveUploadLog

Es la acción a la que se llama cada vez que se sube un registro.

Funciones públicas

EnableLocalEndpoint

ErrorCode EnableLocalEndpoint()

Habilita el extremo local.

Disponible solo para compilaciones de depuración. Consulta el archivo README o la guía de integración a fin de obtener más información para habilitar el extremo local.

Detalles
Resultado que se muestra
Se muestra ErrorCode.InvalidMode si se usa en una compilación no depurable.

FindFidelityParametersInApk

Result< TFidelity > FindFidelityParametersInApk(
  string filename
)

Carga los parámetros de fidelidad desde la carpeta "assets/tuningfork/" del APK.

Detalles
Parámetros
filename
nombre del archivo
Resultado que se muestra
Se muestran los parámetros de fidelidad si se cargaron correctamente.

Flush

ErrorCode Flush()

Fuerza la carga de los histogramas actuales.

Detalles
Resultado que se muestra
Se muestra ErrorCode.Ok si se inició la carga.
Se muestra ErrorCode.PreviousUploadPending si hay una carga anterior que bloquea esta.
ErrorCode.UploadTooFrequent si ha transcurrido menos de un minuto desde la carga anterior.

FrameTick

ErrorCode FrameTick(
  InstrumentationKeys key
)

Graba una marca de fotograma que se asociará a la etiqueta de marca y a la anotación actual.

Tanto para el modo avanzado como para el predeterminado, FrameTick se llama automáticamente.

Detalles
Parámetros
key
Una etiqueta de marca.
Resultado que se muestra
Se muestra ErrorCode.InvalidInstrumentKey si la etiqueta de marca no es válida. Se muestra ErrorCode.Ok si la operación fue exitosa.

GetFidelityParameters

Result< TFidelity > GetFidelityParameters(
  TFidelity defaultFidelity,
  uint initialTimeoutMs
)

Es una llamada de bloqueo para obtener los parámetros de fidelidad del servidor.

No es necesario que la llames si pasas un método fidelity_params_callback como parte de la configuración a TuningFork_init. Ten en cuenta que, una vez que se descarguen los parámetros de fidelidad, la información de latencia se grabará como la asociada con esos parámetros. Si luego llamas a GetFidelityParameters y se descarga un nuevo conjunto de parámetros, los datos que ya se hayan recopilado se enviarán al backend. La solicitud de parámetro se envía a url_base + "applications/" + package_name + "/apks/" + version_number + ":generateTuningParameters".

Detalles
Parámetros
defaultFidelity
Si no se pudieron descargar parámetros, se asume que estos son los actuales
initialTimeoutMs
Es el tiempo de espera antes de volver de esta llamada cuando no se puede establecer una conexión
Resultado que se muestra
Se muestra ErrorCode.Timeout si se agotó el tiempo de espera antes de que se descargaran los parámetros. Se muestra ErrorCode.Ok si la operación fue exitosa.

SetCurrentAnnotation

ErrorCode SetCurrentAnnotation(
  TAnnotation annotation
)

Establece la anotación actual.

Úsala solo para anotaciones personalizadas.

Detalles
Parámetros
annotation
anotación actual.
Resultado que se muestra
Se muestra ErrorCode.TuningforkNotInitialized si no se inicializa el complemento. Se muestra ErrorCode.InvalidMode si se usa con el modo de anotación predeterminado. Se muestra ErrorCode.InvalidAnnotation si la anotación no se condice con la configuración o si su valor establecido no es válido. Se muestra ErrorCode.Ok si la operación fue exitosa.

SetFidelityParameters

ErrorCode SetFidelityParameters(
  TFidelity fidelityParams
)

Establece los parámetros de fidelidad actualmente activos.

Esta función anula los parámetros que se descargaron si se está en el modo experimental. Úsala cuando, por ejemplo, el jugador haya cambiado manualmente la configuración de calidad del juego. Esto vacía (es decir, sube) todos los datos asociados con parámetros anteriores.

Detalles
Parámetros
fidelityParams
Son los nuevos parámetros de fidelidad.
Resultado que se muestra
Se muestra ErrorCode.Ok si se pudieron establecer los parámetros. Se muestra ErrorCode.InvalidFidelity si el mensaje tiene valores no válidos. Se muestra ErrorCode.TuningforkNotInitialized si no se inicializa el complemento. Se muestra ErrorCode.InvalidMode si se usa con el modo de fidelidad predeterminado.

SetLoadingState

ErrorCode SetLoadingState(
  MessageUtil.LoadingState state
)

Configura el estado de carga.

Úsala solo para anotaciones predeterminadas. Establece MessageUtil.LoadingState.Loading cuando se inicie la carga.
Importante:

  • No olvides establecer MessageUtil.LoadingState.NotLoading cuando finalice la carga.
  • No se grabará la información de los fotogramas durante la carga.

Detalles
Parámetros
state
estado de carga
Resultado que se muestra
Se muestra ErrorCode.TuningforkNotInitialized si no se inicializa el complemento. Se muestra ErrorCode.InvalidMode si se usa con el modo de anotación personalizada. Se muestra ErrorCode.Ok si la operación fue exitosa.

Inicio

ErrorCode Start()

Inicia AndroidPerformanceTuner.

Detalles
Resultado que se muestra
Código que muestra la biblioteca de Android Performance Tuner.

Detener

ErrorCode Stop()

Detiene Android Performance Tuner.

Detalles
Resultado que se muestra
Código que muestra la biblioteca de Android Performance Tuner.

SwappyIsEnabled

bool SwappyIsEnabled()

Muestra si la opción de Swappy está habilitada o no.

Para habilitar Swappy en Editor, ve a Project Settings -> Player -> Resolution and Presentation y activa Optimized Frame Pacing. Te recomendamos que actives Swappy a fin de alcanzar una mejor velocidad de fotogramas.

Detalles
Resultado que se muestra
Se muestra verdadero si Swappy está habilitado.