Go fields, C JSON names, return codes and memory ownership. Configuration validation runs before any worker is started.
Download the files below directly. The downloads guide provides the public test key and configuration; pair the device code in your own account for testing.
C library and header, runnable C/Go examples, source and test configuration for Intel/AMD 64-bit.
Downloadstreamzet-linux-sdk-preview-20260923-key-amd64.zip
e22b4792bbdc58878c67c5104d182422f8accfea9da10379252e0a5296d3e57aC library and header, runnable C/Go examples, source and test configuration for ARM 64-bit. Not for xSpan ARMv5.
Downloadstreamzet-linux-sdk-preview-20260923-key-arm64.zip
58d120c0f123169726077a8845ac2619692cb14b45058e72a5aaa80700d6e5d0| Field / API | Type / default | Contract |
|---|---|---|
| Config / config | sdk.Config · required | Endpoint and feature configuration below. Start validates and defaults a copy. |
| StateDir / state_dir | string · required | Absolute owned directory, 0700, not a symlink. Created if absent. Exclusive file lock prevents simultaneous identity use. Keep it across updates; never clone to another device. |
| Fleet / fleet | bool · false | Opt in to remote batch commands as the host OS user while support runs. |
| Field / API | Type / default | Contract |
|---|---|---|
| APIKey / api_key | string · required | StreamZet key: sz_test_public for evaluation, or an issued sz_live_ key for tenant enrollment. The SDK manages service endpoints and its public transport key. |
| DeviceName / device_name | string · hostname | Empty uses os.Hostname(); resulting name must be nonblank and at most 128 UTF-8 bytes. |
| CaptureHelper / capture_helper | string · /usr/lib/streamzet/streamzet-capture | Absolute helper path; required even when terminal mode ignores capture. Existence is checked when desktop capture starts, not during Start. |
| Mode / mode | string · auto | Empty becomes auto. auto detects the current user’s desktop; terminal forces terminal-only. Other values rejected. |
| RelayOnly / relay_only | bool · false | true limits WebRTC to relay candidates; requires TURN. false permits direct and relay paths. |
| Field / API | Type / default | Contract |
|---|---|---|
| Start(ctx, options) | (*Support, error) | ctx: non-nil, not canceled context.Context. options: sdk.Options. Rejects root, invalid config/path, occupied process/state, filesystem/identity failures. ErrRunning means another SDK worker in this process. Success starts async enrollment; no services or signal handlers installed. |
| Support.Stop() | void | Idempotent, nonblocking cancellation. Does not confirm shutdown completion. |
| Support.Wait() | error | Blocks until worker ends; nil on normal stop, terminal worker error otherwise. Do not call on a GUI thread. |
| Support.Done() | <-chan struct{} | Read-only channel closed when all worker cleanup completes. |
| Support.Identity() | Identity | Thread-safe public snapshot; no secret. DeviceCode fills after enrollment; DeviceID may exist before registration. Not a presence signal. |
| Field / API | Type / default | Contract |
|---|---|---|
| StreamzetStart(char *json) | int | NUL-terminated UTF-8 JSON copied before return; caller owns input. Rejects unknown fields and trailing JSON. 0: started; 1: invalid/start error; 2: handle already started (Stop before reuse, even if worker ended). |
| StreamzetStatus() | char * · owned JSON | Snapshot fields below. Call StreamzetFree exactly once on the returned pointer. Calls serialize with Start/Stop; Status can block during Stop. |
| StreamzetStop() | void | Serialized, idempotent and blocking; requests stop, waits, clears handle. Call from a worker. Does not delete identity. |
| StreamzetFree(char *value) | void | Only a Status-owned pointer or NULL. Do not free twice or pass caller-owned/Go pointers. |
| Field / API | Type / default | Contract |
|---|---|---|
| running | boolean · false | Worker is alive. It does not mean online, enrolled or viewer-connected. |
| error | string · "" | Last synchronous Start failure or error collected by Stop. Empty means no recorded error, not network success. |
| identity | object · omitted | Present while the C handle exists; omitted before Start/after Stop. No secret or instance_id is exposed. |
| Identity.DeviceID / identity.device_id | string | Persistent public UUID, created before enrollment. |
| Identity.DeviceCode / identity.device_code | string · "" | Pairing code after enrollment; empty while unregistered. |