<!--
{
  "documentType" : "article",
  "framework" : "QuickTime File Format",
  "identifier" : "/documentation/QuickTime-File-Format/Sprite_track_properties",
  "metadataVersion" : "0.1.0",
  "role" : "article",
  "title" : "Sprite track properties"
}
-->

# Sprite track properties

Define properties that apply to an entire sprite track.

## Overview

> Important: Sprite media is deprecated in the QuickTime file format. The information that follows documents existing content containing sprite media and should not be used for new development.

In addition to defining properties for individual sprites, you can also define properties that apply to an entire sprite track. These properties may override default behavior or provide hints to the sprite media handler. The following sprite track properties are supported:

- `kSpriteTrackPropertyBackgroundColor`: Specifies a background color for the sprite track. The background color is used for any area that is not covered by regular sprites or background sprites. If you do not specify a background color, the sprite track uses black as the default background color.
- `kSpriteTrackPropertyOffscreenBitDepth`: Specifies a preferred bit depth for the sprite track’s offscreen buffer. The allowable values are 8 and 16. To save memory, you should set the value of this property to the minimum depth needed. If you do not specify a bit depth, the sprite track allocates an offscreen buffer with the depth of the deepest intersecting monitor.
- `kSpriteTrackPropertySampleFormat`: Specifies the sample format for the sprite track. If you do not specify a sample format, the sprite track uses the default format, `kKeyFrameAndSingleOverride`.

To specify sprite track properties, you create a single QT atom container and add a leaf atom for each property you want to specify. To add the properties to a sprite track, you call the media handler function `SetMediaPropertyAtom`. To retrieve a sprite track’s properties, you call the media handler function `GetMediaPropertyAtom`.

The sprite track properties and their corresponding data types are listed in the following table.

|Atom type                                     |Atom ID|Leaf data type  |
|----------------------------------------------|-------|----------------|
|`kSpriteTrackPropertyBackgroundColor`         |`1`    |`RGBColor`      |
|`kSpriteTrackPropertyOffscreenBitDepth`       |`1`    |`unsigned short`|
|`kSpriteTrackPropertySampleFormat`            |`1`    |`long`          |
|`kSpriteTrackPropertyHasActions`              |`1`    |`Boolean`       |
|`kSpriteTrackPropertyQTIdleEventsFrequency`   |`1`    |`UInt32`        |
|`kSpriteTrackPropertyVisible`                 |`1`    |`Boolean`       |
|`kSpriteTrackPropertyScaleSpritesToScaleWorld`|`1`    |`Boolean`       |

> Note: When pasting portions of two different tracks together, the Movie Toolbox checks to see that all sprite track properties match. If, in fact, they do match, the paste results in a single sprite track instead of two.

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)