[**Kvaser CanKing GUI Extensions SDK v7.6.1**](../../README.md)

***

[Kvaser CanKing GUI Extensions SDK](../../modules.md) / [models](../README.md) / Frame

# Interface: Frame

A message describing a frame.

## Properties

### canFrameFlags?

> `optional` **canFrameFlags?**: [`CanFrameFlags`](CanFrameFlags.md)

Special CAN flags

***

### data

> **data**: `number`[]

Frame data. Uses repeated uint32 rather than bytes because the proto bytes type
does not support individual byte access efficiently in the ts-proto generated TypeScript
bindings; repeated uint32 provides direct indexed access to each data byte.

***

### deltaTimeUs?

> `optional` **deltaTimeUs?**: `Long`

Delta time in microseconds since the previous frame with the same fixed pos identifier

***

### dlc

> **dlc**: `number`

Frame DLC

***

### fixedPosIdentifier?

> `optional` **fixedPosIdentifier?**: `string`

Fixed position frame identifier

***

### hashCode

> **hashCode**: `number`

Frame hash code, a unique key that identifies the frame

***

### id

> **id**: `number`

Frame identifier

***

### linFrameFlags?

> `optional` **linFrameFlags?**: [`LinFrameFlags`](LinFrameFlags.md)

Special LIN flags

***

### matchedMessageQualifiedName?

> `optional` **matchedMessageQualifiedName?**: `string`

Qualified name of the database message this frame was decoded with, absent when no
database message matched.
This is what lets a client attribute a frame to the exact frame definition it came from,
which neither the frame identifier nor the message name can do on their own: PGN lookup
matches an identifier the definition does not carry, and message names are only unique
within a single database, not across a cluster of them.

***

### messageName

> **messageName**: `string`

Frame identifier

***

### muxValue?

> `optional` **muxValue?**: `number`

Multiplexing value of the frame, used in multiplexed CAN frames

***

### properties

> **properties**: `object`

Extra properties

#### Index Signature

\[`key`: `string`\]: [`FramePropertyValue`](FramePropertyValue.md)

***

### protocol?

> `optional` **protocol?**: `string`

Protocol used for this frame

***

### signalValues

> **signalValues**: [`SignalValue`](SignalValue.md)[]

Signal values

***

### sourceId

> **sourceId**: `string`

Identifier of the source node

***

### sourceName

> **sourceName**: `string`

Name of the source node

***

### streamId

> **streamId**: `string`

Identifier of the stream node

***

### timeUs

> **timeUs**: `Long`

Timestamp in microseconds when the frame was received or transmitted

***

### tx

> **tx**: `boolean`

Flag indicating if this message was transmitted or received