---
title: "IsKeyframe"
---
<!-- DO NOT EDIT! This file was auto-generated by crates/build/re_types_builder/src/codegen/docs/website.rs -->

Whether a [`components.VideoSample`](https://rerun.io/docs/reference/types/components/video_sample) contains a keyframe (also known as a sync sample or IDR).

A keyframe in this sense must be _decoder re-entrant_: a decoder must be able to start
decoding the stream from this sample alone, with no prior decoder state.
Not every intra-coded frame qualifies. Some codecs have intra-only frames that may
still reference existing decoder state and are therefore not valid sync points.
See [`components.VideoCodec`](https://rerun.io/docs/reference/types/components/video_codec) for the codec-specific definition of a keyframe.

## Rerun datatype
[`Bool`](../datatypes/bool.md)


## Arrow datatype
```
Boolean
```

## API reference links
 * 🌊 [C++ API docs for `IsKeyframe`](https://ref.rerun.io/docs/cpp/stable/structrerun_1_1components_1_1IsKeyframe.html)
 * 🐍 [Python API docs for `IsKeyframe`](https://ref.rerun.io/docs/python/stable/common/components#rerun.components.IsKeyframe)
 * 🦀 [Rust API docs for `IsKeyframe`](https://docs.rs/rerun/latest/rerun/components/struct.IsKeyframe.html)


## Used by

* [`VideoStream`](../archetypes/video_stream.md)
