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

A principal classe a ser instanciada para configurar e executar o Android Performance Tuner.

Resumo

Detalhes
Parâmetros do modelo
TFidelity
Classe da mensagem FidelityParams gerada pelo plug-in.
TAnnotation
Classe da mensagem de anotação gerada pelo plug-in.

Atributos públicos

onReceiveFidelityParameters
Action< TFidelity >
Ação chamada sempre que novos parâmetros de fidelidade são definidos.
onReceiveUploadLog
Action< UploadTelemetryRequest >
Ação chamada sempre que o registro é enviado.

Funções públicas

EnableLocalEndpoint()
Ativa o endpoint local.
FindFidelityParametersInApk(string filename)
Result< TFidelity >
Carrega parâmetros de fidelidade da pasta "assets/tuningfork/" do APK.
Flush()
Força o upload dos histogramas atuais.
FrameTick(InstrumentationKeys key)
Registra uma marcação de frame que será associada à chave de instrumentação e à anotação atual.
GetFidelityParameters(TFidelity defaultFidelity, uint initialTimeoutMs)
Result< TFidelity >
Chamada de bloqueio para receber parâmetros de fidelidade do servidor.
SetCurrentAnnotation(TAnnotation annotation)
Define a anotação atual.
SetFidelityParameters(TFidelity fidelityParams)
Define os parâmetros de fidelidade ativos no momento.
SetLoadingState(MessageUtil.LoadingState state)
Define o estado de carregamento.
Start()
Inicia o AndroidPerformanceTuner.
Stop()
Interrompe o Android Performance Tuner.
SwappyIsEnabled()
bool
Retorna informação sobre o Swappy estar ativado ou não.

Atributos públicos

onReceiveFidelityParameters

Action< TFidelity > onReceiveFidelityParameters

Ação chamada sempre que novos parâmetros de fidelidade são definidos.

onReceiveUploadLog

Action< UploadTelemetryRequest > onReceiveUploadLog

Ação chamada sempre que o registro é enviado.

Funções públicas

EnableLocalEndpoint

ErrorCode EnableLocalEndpoint()

Ativa o endpoint local.

Disponível apenas para builds de depuração. Consulte o README ou o guia de integração para ver mais informações sobre como ativar o endpoint local.

Detalhes
Retornos
ErrorCode.InvalidMode ao usar em um build que não seja de depuração.

FindFidelityParametersInApk

Result< TFidelity > FindFidelityParametersInApk(
  string filename
)

Carrega parâmetros de fidelidade da pasta "assets/tuningfork/" do APK.

Detalhes
Parâmetros
filename
nome do arquivo
Retornos
Os parâmetros de fidelidade, se carregado corretamente.

Flush

ErrorCode Flush()

Força o upload dos histogramas atuais.

Detalhes
Retornos
ErrorCode.Ok se o upload puder ser iniciado.
ErrorCode.PreviousUploadPending se houver um upload anterior bloqueando o atual.
ErrorCode.UploadToofrequent se menos de um minuto tiver passado desde o upload anterior.

FrameTick

ErrorCode FrameTick(
  InstrumentationKeys key
)

Registra uma marcação de frame que será associada à chave de instrumentação e à anotação atual.

O FrameTick é chamado automaticamente tanto no modo avançado quanto padrão.

Detalhes
Parâmetros
key
Chave de instrumento.
Retornos
ErrorCode.InvalidInstrumentKey se a chave de instrumento for inválida. ErrorCode.Ok se a operação for concluída corretamente.

GetFidelityParameters

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

Chamada de bloqueio para receber parâmetros de fidelidade do servidor.

Você não precisará chamar isso se transmitir um loyalty_params_callback como parte das configurações do TuneingFork_init. Após o download dos parâmetros de fidelidade, todas as informações de tempo são registradas como associadas a esses parâmetros. Se você chamar GetFidelityParameters posteriormente e o download de um novo conjunto de parâmetros for realizado, todos os dados que já foram coletados serão enviados ao back-end. A solicitação de parâmetro é enviada para: url_base + 'applications/' + package_name + '/apks/' + version_number + ':generateTuningParameters'

Detalhes
Parâmetros
defaultFidelity
serão considerados atuais se não for possível fazer o download de nenhum parâmetro
initialTimeoutMs
tempo de espera antes de retornar essa chamada quando não for possível estabelecer uma conexão
Retornos
ErrorCode.Timeout se o tempo limite acabar antes do download dos parâmetros. ErrorCode.Ok se a operação for concluída corretamente.

SetCurrentAnnotation

ErrorCode SetCurrentAnnotation(
  TAnnotation annotation
)

Define a anotação atual.

Usado somente para anotações personalizadas.

Detalhes
Parâmetros
annotation
anotação atual.
Retornos
ErrorCode.TiningforkNotInitialized se o plug-in não for inicializado. ErrorCode.InvalidMode se usado com o modo de anotação padrão. ErrorCode.InvalidAnnotation se a anotação for inconsistente com as configurações ou tiver um valor inválido definido. ErrorCode.Ok se a operação for concluída corretamente.

SetFidelityParameters

ErrorCode SetFidelityParameters(
  TFidelity fidelityParams
)

Define os parâmetros de fidelidade ativos no momento.

Essa função substitui todos os parâmetros transferidos por download no modo de experimento. Use quando o jogador mudar manualmente as configurações de qualidade do jogo, por exemplo. Isso limpa (ou seja, faz upload de) todos os dados associados a qualquer parâmetro anterior.

Detalhes
Parâmetros
fidelityParams
Novos parâmetros de fidelidade
Retornos
ErrorCode.OK se foi possível definir os parâmetros. ErrorCode.InvalidFidelity se a mensagem tiver valores inválidos. ErrorCode.TiningforkNotInitialized se o plug-in não for inicializado. ErrorCode.InvalidMode se usado com o modo de fidelidade padrão.

SetLoadingState

ErrorCode SetLoadingState(
  MessageUtil.LoadingState state
)

Define o estado de carregamento.

Use somente para anotações padrão. Defina MessageUtil.LoadingState.Loading quando o carregamento for iniciado.
Importante:

  • Defina MessageUtil.LoadingState.NotLoading quando o carregamento for concluído.
  • As informações sobre frame não serão registradas durante o carregamento.

Detalhes
Parâmetros
state
estado de carregamento
Retornos
ErrorCode.TiningforkNotInitialized se o plug-in não for inicializado. ErrorCode.InvalidMode se usado com o modo de anotação personalizada. ErrorCode.Ok se a operação for concluída corretamente.

Start

ErrorCode Start()

Inicia o AndroidPerformanceTuner.

Detalhes
Retornos
Código retornado pela biblioteca Android Performance Tuner.

Stop

ErrorCode Stop()

Interrompe o Android Performance Tuner.

Detalhes
Retornos
Código retornado pela biblioteca Android Performance Tuner.

SwappyIsEnabled

bool SwappyIsEnabled()

Retorna informação sobre o Swappy estar ativado ou não.

Para ativar o swappy no Editor, acesse Configurações do projeto -> Jogador -> Resolução e apresentação e ative o Ritmo de frame otimizado. É recomendado ativar o swappy para arquivar um frame rate melhor.

Detalhes
Retornos
"True" se o Swappy estiver ativado