# MemorySnapshotMetadata

> Container for memory snapshot metadata.

## Definition

* **Type:** Class
* **Namespace:** [Unity.Profiling.Memory](/engine/6000.5/script-reference/unity/profiling/memory.md)
* **Assembly:** UnityEngine.CoreModule

```csharp
public class MemorySnapshotMetadata
```

## Remarks

Code that subscribes to the [MemoryProfiler.CreatingMetadata](/engine/6000.5/script-reference/unity/profiling/memory/memoryprofiler/creatingmetadata.md) event receives a MemorySnapshotMetadata object to populate with meta data for a memory snapshot that is about to be taken.

```csharp
using System;
using UnityEngine;
using Unity.Profiling.Memory;

public class MemoryProfilerExample : MonoBehaviour
{
    public string levelName = "Default Level Name";

    void Start()
    {
        MemoryProfiler.CreatingMetadata += CreateMetadata;
    }

    void CreateMetadata(MemorySnapshotMetadata metadata)
    {
        metadata.Description = $"This Memory Snapshot capture started at {DateTime.Now} in level {levelName}.";
    }

    void OnDestroy()
    {
        MemoryProfiler.CreatingMetadata -= CreateMetadata;
    }
}
```

**Note:** If the project has the [Memory Profiler package](https://docs.unity3d.com/Packages/com.unity.memoryprofiler@latest/) installed in the Editor, it is recommended to implement a concrete implementation of [MemoryProfiler.MetadataCollect](https://docs.unity3d.com/Packages/com.unity.memoryprofiler@latest/index.html?subfolder=/api/Unity.MemoryProfiler.MetadataCollect.html) instead, which will inject your implementation into any Player builds you make.

Additional Resources: [MemoryProfiler.MetadataCollect"](https://docs.unity3d.com/Packages/com.unity.memoryprofiler@latest/index.html?subfolder=/api/Unity.MemoryProfiler.MetadataCollect.html), [MemoryProfiler.TakeSnapshot](/engine/6000.5/script-reference/unity/profiling/memory/memoryprofiler/takesnapshot.md), [MemoryProfiler.CreatingMetadata](/engine/6000.5/script-reference/unity/profiling/memory/memoryprofiler/creatingmetadata.md).

## Properties

| Property                                                                                                    | Description                                                                |
| ----------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| [Description](/engine/6000.5/script-reference/unity/profiling/memory/memorysnapshotmetadata/description.md) | User defined metadata that provides a description for the memory snapshot. |