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

Android Performance Tuner をセットアップおよび実行するためにインスタンス化するメインクラス。

概要

詳細
テンプレート パラメータ
TFidelity
プラグインが生成した FidelityParams メッセージ クラス。
TAnnotation
プラグインが生成した Annotation メッセージ クラス。

パブリック属性

onReceiveFidelityParameters
Action< TFidelity >
新しい忠実度パラメータが設定されるたびに呼び出される Action。
onReceiveUploadLog
Action< UploadTelemetryRequest >
ログがアップロードされるたびに呼び出される Action。

パブリック関数

EnableLocalEndpoint()
ローカル エンドポイントを有効にします。
FindFidelityParametersInApk(string filename)
Result< TFidelity >
APK の "assets/tuningfork/" フォルダから忠実度パラメータを読み込みます。
Flush()
現在のヒストグラムを強制的にアップロードします。
FrameTick(InstrumentationKeys key)
インストルメンテーション キーと現在のアノテーションに関連付けられるフレーム ティックを記録します。
GetFidelityParameters(TFidelity defaultFidelity, uint initialTimeoutMs)
Result< TFidelity >
サーバーから忠実度パラメータを取得するブロッキング呼び出し。
SetCurrentAnnotation(TAnnotation annotation)
現在のアノテーションを設定します。
SetFidelityParameters(TFidelity fidelityParams)
現在アクティブな忠実度パラメータを設定します。
SetLoadingState(MessageUtil.LoadingState state)
読み込み状態を設定します。
Start()
AndroidPerformanceTuner を起動します。
Stop()
Android Performance Tuner を停止します。
SwappyIsEnabled()
bool
Swappy が有効かどうかを返します。

パブリック属性

onReceiveFidelityParameters

Action< TFidelity > onReceiveFidelityParameters

新しい忠実度パラメータが設定されるたびに呼び出される Action。

onReceiveUploadLog

Action< UploadTelemetryRequest > onReceiveUploadLog

ログがアップロードされるたびに呼び出される Action。

パブリック関数

EnableLocalEndpoint

ErrorCode EnableLocalEndpoint()

ローカル エンドポイントを有効にします。

デバッグビルドでのみ使用できます。ローカルのエンドポイントを有効にする方法については、README または統合ガイドをご覧ください。

詳細
戻り値
ErrorCode.InvalidMode(デバッグ以外のビルドで使用している場合)

FindFidelityParametersInApk

Result< TFidelity > FindFidelityParametersInApk(
  string filename
)

APK の "assets/tuningfork/" フォルダから忠実度パラメータを読み込みます。

詳細
パラメータ
filename
ファイル名
戻り値
忠実度パラメータ(読み込みが成功した場合)

Flush

ErrorCode Flush()

現在のヒストグラムを強制的にアップロードします。

詳細
戻り値
ErrorCode.Ok(アップロードを開始できた場合)
ErrorCode.PreviousUploadPending(前回のアップロードにブロックされている場合)
ErrorCode.UploadTooFrequent(前回のアップロードから 1 分未満の場合)

FrameTick

ErrorCode FrameTick(
  InstrumentationKeys key
)

インストルメンテーション キーと現在のアノテーションに関連付けられるフレーム ティックを記録します。

FrameTick は、詳細モードとデフォルト モードの両方で自動的に呼び出されます。

詳細
パラメータ
key
インストゥルメント キー。
戻り値
ErrorCode.InvalidInstrumentKey(インストゥルメント キーが無効な場合)ErrorCode.Ok(成功した場合)

GetFidelityParameters

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

サーバーから忠実度パラメータを取得するブロッキング呼び出し。

TuningFork_init への設定の中で fidelity_params_callback を渡していた場合、これを呼び出す必要はありません。忠実度パラメータをダウンロードすると、タイミング情報はそれらのパラメータと関連付けられているものとして記録されます。その後で GetFidelityParameters を呼び出し、新しいパラメータ セットがダウンロードされると、すでに収集されているデータがすべてバックエンドに送信されます。パラメータ リクエストは次の URL に送信されます: url_base + 'applications/' + package_name + '/apks/' + version_number + ':generateTuningParameters'

詳細
パラメータ
defaultFidelity
どのパラメータもダウンロードできなかった場合、これが最新だとみなされます
initialTimeoutMs
接続できない場合に、この呼び出しから戻るまでの待機時間
戻り値
ErrorCode.Timeout(パラメータをダウンロードする前にタイムアウトした場合)ErrorCode.Ok(成功した場合)

SetCurrentAnnotation

ErrorCode SetCurrentAnnotation(
  TAnnotation annotation
)

現在のアノテーションを設定します。

カスタム アノテーションにのみ使用します。

詳細
パラメータ
annotation
現在のアノテーション。
戻り値
ErrorCode.TuningforkNotInitialized(プラグインが初期化されていない場合)ErrorCode.InvalidMode(デフォルトのアノテーション モードで使用している場合)ErrorCode.InvalidAnnotation(アノテーションが設定と一致していない場合、または不正な値のセットが含まれている場合)ErrorCode.Ok(成功した場合)

SetFidelityParameters

ErrorCode SetFidelityParameters(
  TFidelity fidelityParams
)

現在アクティブな忠実度パラメータを設定します。

テストモードでは、ダウンロードされたパラメータをこの関数がオーバーライドします。たとえば、プレーヤーが手動でゲームの品質設定を変更した場合に使用します。これにより、以前のパラメータに関連付けられたデータがフラッシュ(つまりアップロード)されます。

詳細
パラメータ
fidelityParams
新しい忠実度パラメータ
戻り値
ErrorCode.Ok(パラメータを設定できた場合)ErrorCode.InvalidFidelity(メッセージに無効な値がある場合)ErrorCode.TuningforkNotInitialized(プラグインが初期化されていない場合)ErrorCode.InvalidMode(デフォルトの忠実度モードを使用している場合)

SetLoadingState

ErrorCode SetLoadingState(
  MessageUtil.LoadingState state
)

読み込み状態を設定します。

デフォルトのアノテーションでのみ使用します。読み込みの開始時に MessageUtil.LoadingState.Loading を設定します。
重要:

  • 読み込みの終了時には必ず MessageUtil.LoadingState.NotLoading を設定してください。
  • 読み込み中にフレーム情報は記録されません。

詳細
パラメータ
state
読み込み状態
戻り値
ErrorCode.TuningforkNotInitialized(プラグインが初期化されていない場合)ErrorCode.InvalidMode(カスタムのアノテーション モードで使用している場合)ErrorCode.Ok(成功した場合)

Start

ErrorCode Start()

AndroidPerformanceTuner を起動します。

詳細
戻り値
Android Performance Tuner ライブラリから返されるコード。

Stop

ErrorCode Stop()

Android Performance Tuner を停止します。

詳細
戻り値
Android Performance Tuner ライブラリから返されるコード。

SwappyIsEnabled

bool SwappyIsEnabled()

Swappy が有効かどうかを返します。

Swappy を Editor で有効にするには、[Project Settings] -> [Player] -> [Resolution and Presentation] に移動して、[Optimized Frame Pacing] を有効にします。良好なフレームレートを得るために、Swappy を有効にすることをおすすめします。

詳細
戻り値
true(Swappy が有効になっている場合)