OutputOptions Struct

Buffering / sync options for the Output Node. More...

Declaration

struct simaai::neat::OutputOptions { ... }

Included Headers

#include <Output.h>

Public Member Attributes Index

int	max_buffers = 4
	Cap on queued samples before back-pressure. 0 = unbounded. More...
bool	drop = false
	If true, drop the oldest sample on overflow instead of blocking. More...
bool	sync = false
	If true, sync to the pipeline clock (slower, but matches realtime). More...
CombinePolicy	combine_policy = CombinePolicy::None
	Multi-producer Graph combine policy. More...

Public Static Functions Index

static OutputOptions	Latest ()
	Preset: keep only the most recent sample (drop=true, max_buffers=1). Lowest latency. More...
static OutputOptions	EveryFrame (int max_buffers=30)
	Preset: keep up to max_buffers samples; consumer pulls every frame. More...
static OutputOptions	Clocked (int max_buffers=1)
	Preset: clocked output (sync=true) — pace samples to wall-clock. More...

Description

Buffering / sync options for the Output Node.

The three factory presets cover the common use cases — pick one rather than configuring fields manually.

Definition at line 57 of file Output.h.

Public Member Attributes

combine_policy

CombinePolicy simaai::neat::OutputOptions::combine_policy = CombinePolicy::None

Multi-producer Graph combine policy.

Definition at line 61 of file Output.h.

drop

bool simaai::neat::OutputOptions::drop = false

If true, drop the oldest sample on overflow instead of blocking.

Definition at line 59 of file Output.h.

max_buffers

int simaai::neat::OutputOptions::max_buffers = 4

Cap on queued samples before back-pressure. 0 = unbounded.

Definition at line 58 of file Output.h.

sync

bool simaai::neat::OutputOptions::sync = false

If true, sync to the pipeline clock (slower, but matches realtime).

Definition at line 60 of file Output.h.

Public Static Functions

Clocked()

OutputOptions simaai::neat::OutputOptions::Clocked (int max_buffers=1)

static

Preset: clocked output (sync=true) — pace samples to wall-clock.

Definition at line 68 of file Output.h.

EveryFrame()

OutputOptions simaai::neat::OutputOptions::EveryFrame (int max_buffers=30)

static

Preset: keep up to max_buffers samples; consumer pulls every frame.

Definition at line 66 of file Output.h.

Latest()

OutputOptions simaai::neat::OutputOptions::Latest ()

static

Preset: keep only the most recent sample (drop=true, max_buffers=1). Lowest latency.

Definition at line 64 of file Output.h.

---

The documentation for this struct was generated from the following file:

• Output.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.