कॉन्टेंट लोड होने में लगने वाले समय को रिकॉर्ड करने वाले फ़ंक्शन जोड़ें

जब आपका गेम लोड होने के इवेंट परफ़ॉर्म कर रहा हो, तब उस समय को रिकॉर्ड करना ज़रूरी है दो वजहें:

  1. लोड करते समय फ़्रेम टाइम के डेटा को प्रदूषण से बचाने के लिए.
  2. लोड होने में लगने वाले समय का विश्लेषण करने के लिए, ताकि यह देखा जा सके कि लोड होने में लगने वाला समय कब और कहां से ज़्यादा है स्वीकार किए जाते हैं.

लोड होने वाले किसी इवेंट में, इन चीज़ों से जुड़ा मेटाडेटा हो सकता है:

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() फ़ंक्शन. फ़िलहाल, मेटाडेटा और एनोटेशन को का इस्तेमाल 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);
}