Expand description
Host-device stream backend substrate.
The crate currently implements the selected RTP-MIDI subset without opening sockets or platform devices during normal validation. Host callbacks only receive a cloneable bounded queue handle and may enqueue packets through non-blocking calls. Device smoke tests are ignored by default; run them manually only when a matching external peer or platform device is available.
Re-exports§
pub use cookbook::fake_backend_demo;
Modules§
- cookbook
- Deterministic cookbook builders for stream-host recipes.
Structs§
- Audio
Device Card - Export-record-style descriptor for an audio device.
- Audio
Placement Request - Caller-side request to place an audio graph on a registered audio site.
- Audio
Provider Host - Host that loads audio providers through the kernel loader and registers sites.
- Audio
Provider Proof Entries - Proof-only table of provider entry points keyed by provider library id.
- Audio
Router - Registry and dispatcher for audio placement sites.
- Audio
Site Key - Stable runtime key for an audio evaluation site.
- Bounded
Content Store - Size-bounded store for sample-by-reference frames.
- Content
Frame - One sample-by-reference frame stored under bounded host policy.
- Device
Catalog - Registry of stream-device providers.
- Device
Placement - Placement plan for a device surface encoder and adapter pair.
- Device
Profile - Stream-facing profile advertised by a concrete device.
- Device
Record - Catalog row for a host-visible stream device.
- Device
Site - Export-record-style descriptor for a stream device site.
- Fake
Backend - Host-independent backend that opens push streams without hardware.
- Glasses
Placement Request - Placement request for one already-resolved glasses route.
- Host
Backend Info - Stable metadata describing a host backend.
- Host
Backend Registry - Deterministic registry of host stream backends.
- Host
Callback Cassette - Deterministic recording of host callback items.
- Host
Callback Queue - Cloneable handle host callbacks use to enqueue packets into a stream.
- Host
Callback Replay Report - Outcome counts from deterministic host callback cassette replay.
- Host
Clock Info - Clock metadata for an opened host stream.
- Host
Device Inventory - Devices and ports reported by a backend enumeration.
- Host
Device Spec - Specification of an enumerated host device.
- Host
Latency Info - Latency estimate for an opened host stream.
- Host
Open Plan - Resolved plan describing how a device would be opened.
- Host
Open Stream - Open stream plus host-side callback queue.
- Host
Port Spec - Addressable host port owned by an enumerated device.
- Host
Reconnect Policy - Reconnect behavior accepted by a host backend.
- Host
Stream Config - Accepted stream configuration returned by a host backend.
- Host
Stream Config Probe - Safe config probe for stream-host audio and MIDI defaults.
- Host
Stream Config Request - Request supplied to a host backend when opening a stream.
- LanPlacement
Report - Outcome of planning a LAN fragment placement.
- LanPlacement
Request - Request to place a stream fragment on a LAN peer under a chosen mode.
- Midi
Live Eval Site - Live MIDI evaluation site opened from a cataloged device record.
- Modeled
Audio Provider - Deterministic audio provider used by default validation.
- Modeled
Audio Site - Modeled audio site backed by an existing host backend.
- Modeled
Midi Provider - Deterministic MIDI provider used by default validation.
- Process
Ring Snapshot - Capacity snapshot for steady-state process-site checks.
- Process
Shared Ring - Preallocated bounded ring used at process-site stream boundaries.
- Registered
Audio Site - A router row for an audio site and the provider that owns it.
- Resolved
Glasses Placement - Validated placement for one glasses route.
- Retention
Window - Retention window assigned by one visible consent receipt.
- Router
Audio Provider Registrar - Registrar that wires provider sites into an
AudioRouter. - RtpMidi
Backend - Host backend implementing the selected RTP-MIDI input subset.
- RtpMidi
Port - An opened RTP-MIDI source port and its callback queue.
- Store
Evicted - One removed content-store entry.
- Store
Key - Stable key for a content-store entry.
- Stub
Provider - Hardware-free provider used when no concrete device provider is installed.
- Stub
Session - Hardware-free session that refuses all live device operations.
Enums§
- Device
Capability - Capability helpers for device-local sensors and actuators.
- Device
Direction - Direction supported by a cataloged stream device.
- Device
Error - Error returned by stream-device providers and sessions.
- Device
Kind - Stream-device media family surfaced by the shared device catalog.
- Device
Site Locality - Placement locality advertised by a device site.
- Glasses
Adapter Kind - Local adapter selected for a resolved glasses profile.
- Glasses
Capability - Glasses-sensitive provider capability classes.
- Glasses
Placement Error - Error returned while resolving a glasses route placement.
- Host
Backend Capability - Capability advertised by a host backend.
- Host
Direction - Direction of a host stream relative to the device.
- LanPlacement
Mode - Placement mode for a stream fragment hosted on a LAN peer.
- Placement
- Placement tier for a host-visible stream device.
- Placement
Error - Device placement validation error.
- Process
Ring Push - Push result for the bounded process-site ring.
- Watch
Capability - Watch-sensitive provider capability classes.
Constants§
- AUDIO_
PROVIDER_ ABI_ VERSION - ABI version currently accepted by the host-side audio provider registrar.
- AUDIO_
PROVIDER_ ENTRY_ V1 - Stable entry symbol exported by a loadable audio provider.
- CAP_
GLASSES_ CAMERA - Capability required for glasses camera frames.
- CAP_
GLASSES_ HAND - Capability required for glasses hand-ray samples.
- CAP_
GLASSES_ MIC - Capability required for glasses microphone capture.
- CAP_
GLASSES_ POSE - Capability required for glasses pose and tracking samples.
- CAP_
GLASSES_ VENDOR_ REPORT - Capability required for vendor diagnostic reporting.
- CAP_
GLASSES_ WORLD_ ANCHOR - Capability required for stable world-anchor observations.
- CAP_
WATCH_ HEALTH - Capability required for watch health and biometric streams.
- CAP_
WATCH_ LOCATION - Capability required for watch location and route streams.
- CAP_
WATCH_ MIC - Capability required for watch microphone audio.
- CAP_
WATCH_ VENDOR_ REPORT - Capability required for vendor diagnostic reports.
Traits§
- Audio
Provider Registrar - Host-supplied registration surface for loadable audio providers.
- Audio
Site - Runtime-openable audio placement target.
- Catalog
Device Provider - Provider of cataloged stream devices.
- Device
Provider - Provider that opens one stream-device session.
- Device
Sample - Device sample expression contract used by session polling helpers.
- Device
Session - Open stream-device session.
- Host
Backend - Backend contract for host-controlled stream devices.
- Host
Stream Driver - Native or external stream resource attached to an opened host stream.
- Stream
Eval Site - Open stream site returned by a device catalog.
Functions§
- audio_
device_ export_ symbol - Stable export symbol for an audio device owned by a loaded lib.
- audio_
site_ export_ symbol - Stable site export symbol for an audio site owned by a loaded lib.
- device_
sample_ kind_ symbol - Returns the qualified sample-kind symbol for
kind. - fake_
backend_ symbol - Stable fake backend id.
- glasses_
camera_ grant - Returns the visible grant symbol for glasses camera frames.
- glasses_
capability_ for_ sample - Classifies an XR stream expression into the glasses capability it needs.
- glasses_
hand_ grant - Returns the visible grant symbol for glasses hand-ray samples.
- glasses_
mic_ grant - Returns the visible grant symbol for glasses microphone capture.
- glasses_
pose_ grant - Returns the visible grant symbol for glasses pose samples.
- glasses_
retention_ windows - Builds bounded-store retention windows from glasses consent receipts.
- glasses_
vendor_ report_ grant - Returns the visible grant symbol for glasses vendor diagnostics.
- glasses_
world_ anchor_ grant - Returns the visible grant symbol for glasses world-anchor observations.
- hardware_
inventory_ probe_ capability_ symbol - Returns the stable capability id required for real hardware inventory probes.
- host_
stream_ config_ probe_ symbol - Returns the stable stream-host config probe id.
- lan_
bar_ delay_ mode_ symbol - Stable mode name for musically aligned bar-delay collaboration.
- lan_
experimental_ remote_ sample_ capability - Capability required to try pinned sample-domain placement across LAN.
- lan_
jitter_ buffered_ mode_ symbol - Stable mode name for jitter-buffered LAN placement.
- lan_
peer_ site_ symbol - Stable site name for a non-real-time node hosted by a LAN peer.
- lan_
pinned_ sample_ experimental_ diagnostic - Diagnostic emitted when experimental pinned sample-domain LAN placement is used.
- lan_
pinned_ sample_ refusal_ diagnostic - Diagnostic emitted when a pinned sample-domain node is refused across LAN.
- missing_
capability_ card_ expr - Emits a browse card for a missing backend capability.
- native_
audio_ provider_ capability - Capability required before a native audio provider can be loaded.
- poll_
device_ sample - Polls and decodes a typed device sample from a session.
- require_
glasses_ consent - Requires kernel authority, visible consent, and same-session receipt ownership.
- require_
glasses_ sample_ ingest - Requires the authority needed to ingest one glasses-sensitive stream expression.
- require_
watch_ consent - Requires kernel authority, visible consent, and same-session receipt ownership.
- require_
watch_ worn_ ingest - Requires the authority needed to ingest one worn-event expression.
- resolve_
glasses_ placement - Resolves a stable glasses route symbol to a validated placement.
- retention_
reason - Returns the stable reason for retention eviction.
- rtp_
midi_ backend_ symbol - Returns the stable symbol identifying the RTP-MIDI backend.
- size_
bound_ reason - Returns the stable reason for size-bound eviction.
- store_
glasses_ frame - Stores one by-reference glasses frame in a bounded content store.
- stream_
host_ capability - Returns the capability name gating host stream device access.
- stream_
host_ config_ lib_ symbol - Returns the stable config library id for stream-host defaults.
- stream_
host_ device_ read_ effect_ kind - Returns the stream-host effect kind for device reads.
- stream_
host_ device_ write_ effect_ kind - Returns the stream-host effect kind for device writes.
- sweep_
glasses_ retention - Sweeps stored glasses frames under modeled-clock retention windows.
- watch_
capability_ for_ worn_ event - Classifies a worn-event expression into the watch capability it needs.
- watch_
health_ grant - Returns the visible grant symbol for watch health streams.
- watch_
location_ grant - Returns the visible grant symbol for watch location streams.
- watch_
mic_ grant - Returns the visible grant symbol for watch microphone input.
- watch_
vendor_ report_ grant - Returns the visible grant symbol for watch vendor diagnostics.
Type Aliases§
- Audio
Provider Entry - Host-callable audio provider entry point.
- Device
Result - Result type returned by device providers and sessions.