# VisionFrameContext

<a id="visionframecontext"></a>

# VisionFrameContext

```cpp
#include <icy/vision/types.h>

struct VisionFrameContext
```

[Defined in src/vision/include/icy/vision/types.h:30](https://github.com/auscaster/icey/blob/main/src/vision/include/icy/vision/types.h#L30)

The frame a result refers to: its source and stream, frame ID, timing, size, pixel format and whether it is a keyframe.

## Public Attributes

| Return | Name | Description |
|--------|------|-------------|
| `std::string` | [`sourceId`](#sourceid-1)  |  |
| `std::string` | [`streamId`](#streamid-2)  |  |
| `uint64_t` | [`frameId`](#frameid)  |  |
| `int64_t` | [`ptsUsec`](#ptsusec)  |  |
| `int64_t` | [`receivedAtUsec`](#receivedatusec)  |  |
| `int` | [`width`](#width-5)  |  |
| `int` | [`height`](#height-5)  |  |
| `std::string` | [`pixelFmt`](#pixelfmt-3)  |  |
| `bool` | [`keyframe`](#keyframe)  |  |

---

<a id="sourceid-1"></a>

### sourceId

```cpp
std::string sourceId
```

[Defined in src/vision/include/icy/vision/types.h:32](https://github.com/auscaster/icey/blob/main/src/vision/include/icy/vision/types.h#L32)

---

<a id="streamid-2"></a>

### streamId

```cpp
std::string streamId
```

[Defined in src/vision/include/icy/vision/types.h:33](https://github.com/auscaster/icey/blob/main/src/vision/include/icy/vision/types.h#L33)

---

<a id="frameid"></a>

### frameId

```cpp
uint64_t frameId = 0
```

[Defined in src/vision/include/icy/vision/types.h:34](https://github.com/auscaster/icey/blob/main/src/vision/include/icy/vision/types.h#L34)

---

<a id="ptsusec"></a>

### ptsUsec

```cpp
int64_t ptsUsec = 0
```

[Defined in src/vision/include/icy/vision/types.h:35](https://github.com/auscaster/icey/blob/main/src/vision/include/icy/vision/types.h#L35)

---

<a id="receivedatusec"></a>

### receivedAtUsec

```cpp
int64_t receivedAtUsec = 0
```

[Defined in src/vision/include/icy/vision/types.h:36](https://github.com/auscaster/icey/blob/main/src/vision/include/icy/vision/types.h#L36)

---

<a id="width-5"></a>

### width

```cpp
int width = 0
```

[Defined in src/vision/include/icy/vision/types.h:37](https://github.com/auscaster/icey/blob/main/src/vision/include/icy/vision/types.h#L37)

---

<a id="height-5"></a>

### height

```cpp
int height = 0
```

[Defined in src/vision/include/icy/vision/types.h:38](https://github.com/auscaster/icey/blob/main/src/vision/include/icy/vision/types.h#L38)

---

<a id="pixelfmt-3"></a>

### pixelFmt

```cpp
std::string pixelFmt
```

[Defined in src/vision/include/icy/vision/types.h:39](https://github.com/auscaster/icey/blob/main/src/vision/include/icy/vision/types.h#L39)

---

<a id="keyframe"></a>

### keyframe

```cpp
bool keyframe = false
```

[Defined in src/vision/include/icy/vision/types.h:40](https://github.com/auscaster/icey/blob/main/src/vision/include/icy/vision/types.h#L40)