Your first capture
This walks through the shortest path from nothing installed to a recorded session with real data in it, using the microphone module as the example - it needs no special hardware beyond whatever microphone Windows already recognizes on your workstation, so you can follow every step on the machine you are reading this on. Each step links to the page that documents it in full; this page does not repeat that detail.
Before you start
- A Windows x64 workstation meeting HEAT Capture’s own prerequisites: Administrator rights, the WebView2 Runtime, at least 5 GiB free disk.
- A reachable HEAT platform instance and an account on it.
- A VRAI-supplied
.hczconfiguration package for your deployment - this is how most customers receive their approved module set; see Install HEAT Capture if you do not have one yet.
Read Deployment models first if you have not already - it explains why the network this workstation sits on matters before you install anything.
Install HEAT Capture
-
Follow Install HEAT Capture end to end, including importing your
.hczconfiguration package and signing in to your HEAT platform instance. -
Confirm the install with the version check at the end of that page before continuing - a working install is much easier to reason about than a partial one.
Add the microphone module
-
If your imported
.hczpackage already includes the microphone module, skip to enabling it below. Otherwise, follow Install a capture module to install it from the registry. -
Open the microphone module’s page in HEAT Capture, enable it, and leave every setting at its default - the defaults only detect voice activity, they do not record or transcribe anything, so there is nothing to configure for this first run. See Configure the microphone module if you want to change that later.
Run a session
-
Follow Run a session to sign in, confirm the module is running, and start the session.
-
Speak into your microphone for a few seconds. Watch HEAT Capture’s delivery counters move - that is the microphone module’s voice-activity events reaching HEAT Capture and being delivered to your platform instance.
-
Stop the session, following the same page.
Verify
Confirm the session and its data on your HEAT platform instance - what that looks like depends on your platform, which is outside this documentation set (see What HEAT Capture is for that boundary). On the HEAT Capture side, the session should show as stopped with a non-zero packet count, and no parked packets left behind.
Where to go next
- Add more modules relevant to your exercise from the module catalogue.
- Capturing from a simulator instead of, or alongside, hardware sensors? See the plugin catalogue for MACE, Unreal Engine and VBS4.
- Building an integration against the data itself? Start at ProtoLib’s message reference.