Записывать события загрузки важно по двум причинам:
- Чтобы не искажать данные о времени формирования кадра во время загрузки.
- Анализировать время загрузки, чтобы выявлять, когда и где оно превышает допустимые значения.
С событием загрузки могут быть связаны следующие метаданные:
public class LoadingTimeMetadata
{
public enum LoadingState
{
Unknown = 0,
/// <summary>
/// The first time the game is run.
/// </summary>
FirstRun = 1,
/// <summary>
/// App is not backgrounded.
/// </summary>
ColdStart = 2,
/// <summary>
/// App is backgrounded.
/// </summary>
WarmStart = 3,
/// <summary>
/// App is backgrounded, least work needed.
/// </summary>
HotStart = 4,
/// <summary>
/// Asset loading between levels.
/// </summary>
InterLevel = 5
}
public LoadingState state;
public enum LoadingSource
{
UnknownSource = 0,
/// <summary>
/// Uncompressing data.
/// </summary>
Memory = 1,
/// <summary>
/// Reading assets from APK bundle.
/// </summary>
Apk = 2,
/// <summary>
/// Reading assets from device storage.
/// </summary>
DeviceStorage = 3,
/// <summary>
/// Reading assets from external storage, e.g. SD card.
/// </summary>
ExternalStorage = 4,
/// <summary>
/// Loading assets from the network.
/// </summary>
Network = 5,
/// <summary>
/// Shader compilation.
/// </summary>
ShaderCompilation = 6,
/// <summary>
/// Time spent between process starting and onCreate.
/// </summary>
PreActivity = 7,
/// <summary>
/// Total time spent between process starting and first render frame.
/// </summary>
FirstTouchToFirstFrame = 8,
/// <summary>
/// Time from start to end of a group of events.
/// </summary>
TotalUserWaitForGroup = 9
}
public LoadingSource source;
/// <summary>
/// 0 = no compression, 100 = max compression
/// </summary>
public int compression_level;
public enum NetworkConnectivity
{
Unknown = 0,
Wifi = 1,
CellularNetwork = 2
}
public NetworkConnectivity network_connectivity;
/// <summary>
/// Bandwidth in bits per second.
/// </summary>
public ulong network_transfer_speed_bps;
/// <summary>
/// Latency in nanoseconds.
/// </summary>
public ulong network_latency_ns;
}
В полях, которые не имеют отношения к вашим потребностям, можно указать ноль.
С событием загрузки также может быть связана аннотация. Вы можете определить их так же, как и аннотации времени формирования кадра, используя одно или несколько полей в сообщении Annotation.
Result<ulong> StartRecordingLoadingTime(LoadingTimeMetadata eventMetadata,
TAnnotation annotation);
Эта функция начинает запись события времени загрузки, связанного с заданными метаданными и аннотацией, и заполняет Result<ulong>.value, который будет использоваться в функции StopRecordingLoadingTime().
ErrorCode StopRecordingLoadingTime(ulong handle);
Эта функция останавливает запись события, ранее запущенного с помощью StartRecordingLoadingTime(). Событие загружается при следующей очистке сеанса.
Загрузка функций группы
В игре можно регистрировать несколько событий загрузки для одного периода загрузки, который видит пользователь. Примеры: загрузка файлов, загрузка сцен, декомпрессия и компиляция шейдеров.
Важно сообщить Android Performance Tuner, что события загрузки являются частью такой группы, чтобы он мог предоставить более точные данные. Для этого заключите события загрузки в скобки с помощью следующих функций начала и окончания.
Result<ulong> StartLoadingGroup(LoadingTimeMetadata eventMetadata, TAnnotation
annotation);
Эта функция запускает группу загрузки, связанную с заданными метаданными и аннотацией, и заполняет Result<ulong>.value, который будет использоваться в функции StopLoadingGroup(). Метаданные и аннотация в настоящее время не используются серверной частью Google Play, и только для аннотации можно задать значение null. Все последующие события загрузки помечаются уникальным идентификатором группы.
ErrorCode StopLoadingGroup(ulong handle);
Эта функция останавливает загрузку группы, ранее запущенной с помощью StartLoadingGroup().
У последующих событий загрузки не будет идентификатора группы, пока снова не будет вызван метод StartLoadingGroup().
Примеры
Ниже приведены примеры того, как добавить в игру функции времени загрузки.
События загрузки файлов
В примере кода ниже показано, как регистрировать события загрузки файлов в игре.
public RawImage image;
IEnumerator LoadImageFromStreamingAssets(string imageName)
{
string imagePath = "file://" + Path.Combine(Application.streamingAssetsPath, imageName);
using (var r = UnityWebRequestTexture.GetTexture(imagePath))
{
LoadingTimeMetadata fileLoadingMetadata = new LoadingTimeMetadata()
{
state = LoadingTimeMetadata.LoadingState.InterLevel,
source = LoadingTimeMetadata.LoadingSource.DeviceStorage,
// Fields are zero by default but they could be set as follows
compression_level = 0,
network_connectivity = 0,
network_transfer_speed_bps = 0,
network_latency_ns = 0
};
Annotation annotation = new Annotation()
{
Scene = Scene.MagicalForest
};
// Start recording loading time.
Result<ulong> result = performanceTuner.StartRecordingLoadingTime(fileLoadingMetadata, annotation);
yield return r.SendWebRequest();
// Stop recording loading time.
performanceTuner.StopRecordingLoadingTime(result.value);
if (r.isNetworkError || r.isHttpError)
{
Debug.Log(r.error);
}
else
{
Texture2D tex = DownloadHandlerTexture.GetContent(r);
image.texture = tex;
}
}
}
События загрузки сцены
В следующем примере кода показано, как регистрировать события загрузки сцены в игре.
IEnumerator LoadScene(int sceneIndex)
{
LoadingTimeMetadata metadata = new LoadingTimeMetadata()
{state = LoadingTimeMetadata.LoadingState.InterLevel};
Annotation annotation = new Annotation() {Scene = (Scene) (sceneIndex + 1)};
Result<ulong> result = performanceTuner.StartRecordingLoadingTime(metadata, annotation);
AsyncOperation asyncSceneLoad = SceneManager.LoadSceneAsync(sceneIndex, LoadSceneMode.Single);
while (!asyncSceneLoad.isDone)
{
yield return null;
}
performanceTuner.StopRecordingLoadingTime(result.value);
}
Загрузка функций группы
В примере кода ниже показано, как добавить в игру функции группы загрузки.
IEnumerator LoadImages()
{
LoadingTimeMetadata groupMetadata = new LoadingTimeMetadata()
{
state = LoadingTimeMetadata.LoadingState.InterLevel,
source = LoadingTimeMetadata.LoadingSource.DeviceStorage,
};
Result<ulong> result = performanceTuner.StartLoadingGroup(groupMetadata, null);
yield return StartCoroutine(LoadImageFromStreamingAssets("image1.jpeg"));
yield return StartCoroutine(LoadImageFromStreamingAssets("image2.jpeg"));
yield return StartCoroutine(LoadImageFromStreamingAssets("image3.jpeg"));
yield return StartCoroutine(LoadImageFromStreamingAssets("image4.jpeg"));
var stopErrorCode = performanceTuner.StopLoadingGroup(0);
}