---
url: >-
  https://adk.nht.io/api/@nhtio/adk/batteries/generation/local_diffusion/protocol/type-aliases/ImageFrame.md
description: A parsed image result frame.
---

# Type Alias: ImageFrame

```ts
type ImageFrame = {
  kind: "image";
  payload: {
    b64?: string;
    mimeType: string;
    path?: string;
  };
  rid: number;
};
```

Defined in: [src/batteries/generation/local\_diffusion/protocol.ts:92](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/generation/local_diffusion/protocol.ts#L92)

A parsed image result frame.

## Properties

| Property                                | Type                                                             | Description                                                                                    | Defined in                                                                                                                                                                |
| --------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|  `kind`       | `"image"`                                                        | Discriminant.                                                                                  | [src/batteries/generation/local\_diffusion/protocol.ts:94](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/generation/local_diffusion/protocol.ts#L94)   |
|  `payload` | { `b64?`: `string`; `mimeType`: `string`; `path?`: `string`; } | The image payload: either an inline base64 blob or a backend-written file path, plus its MIME. | [src/batteries/generation/local\_diffusion/protocol.ts:98](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/generation/local_diffusion/protocol.ts#L98)   |
| `payload.b64?`                          | `string`                                                         | Inline base64-encoded image bytes (mutually exclusive with `path`).                            | [src/batteries/generation/local\_diffusion/protocol.ts:102](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/generation/local_diffusion/protocol.ts#L102) |
| `payload.mimeType`                      | `string`                                                         | Concrete image MIME type, e.g. `image/png`.                                                    | [src/batteries/generation/local\_diffusion/protocol.ts:104](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/generation/local_diffusion/protocol.ts#L104) |
| `payload.path?`                         | `string`                                                         | Backend-written output file path (mutually exclusive with `b64`).                              | [src/batteries/generation/local\_diffusion/protocol.ts:100](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/generation/local_diffusion/protocol.ts#L100) |
|  `rid`         | `number`                                                         | The request id this image belongs to.                                                          | [src/batteries/generation/local\_diffusion/protocol.ts:96](https://github.com/NHTIO/ADK/blob/v1.20261003.0/src/src/batteries/generation/local_diffusion/protocol.ts#L96)   |