# BenchmarkReport

This message is generated by the
[BenchmarkIn](https://docs.luxonis.com/software-v3/depthai/depthai-components/nodes/benchmark_in.md) node and is used for
reporting performance metrics of your DepthAI pipeline in real time. The BenchmarkReport contains key statistics such as the
frames per second (FPS), total elapsed time during the benchmark period, the number of messages processed, individual message
latencies, and the average latency.

## Message Details

fps The measured frames per second (FPS) at which the node processes messages.

timeTotal The total time (in seconds) that has elapsed during the benchmarking period.

numMessagesReceived:
The number of messages received and processed during the current benchmark period.

latencies:
A list of latencies (in seconds) for each processed message, which can help in understanding the distribution of processing
delays.

averageLatency:
The average latency (in seconds) computed over all processed messages.

## Reference

### dai::BenchmarkReport

Kind: class

BenchmarkReport message.

#### float fps

Kind: variable

#### float timeTotal

Kind: variable

#### float numMessagesReceived

Kind: variable

#### float averageLatency

Kind: variable

#### std::vector< float > latencies

Kind: variable

#### BenchmarkReport()

Kind: function

#### ~BenchmarkReport()

Kind: function

#### void serialize(std::vector< std::uint8_t > & metadata, DatatypeEnum & datatype)

Kind: function

#### DatatypeEnum getDatatype()

Kind: function

Get the datatype of this specific message.

return: DatatypeEnum

#### DEPTHAI_SERIALIZE(BenchmarkReport, Buffer::sequenceNum, Buffer::ts, Buffer::tsDevice, fps, timeTotal, numMessagesReceived,
averageLatency, latencies)

Kind: function

### Need assistance?

Head over to [Discussion Forum](https://discuss.luxonis.com/) for technical support or any other questions you might have.
