Skip to main content

Crate sim_lib_stream_host

Crate sim_lib_stream_host 

Source
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§

AudioDeviceCard
Export-record-style descriptor for an audio device.
AudioPlacementRequest
Caller-side request to place an audio graph on a registered audio site.
AudioProviderHost
Host that loads audio providers through the kernel loader and registers sites.
AudioProviderProofEntries
Proof-only table of provider entry points keyed by provider library id.
AudioRouter
Registry and dispatcher for audio placement sites.
AudioSiteKey
Stable runtime key for an audio evaluation site.
BoundedContentStore
Size-bounded store for sample-by-reference frames.
ContentFrame
One sample-by-reference frame stored under bounded host policy.
DeviceCatalog
Registry of stream-device providers.
DevicePlacement
Placement plan for a device surface encoder and adapter pair.
DeviceProfile
Stream-facing profile advertised by a concrete device.
DeviceRecord
Catalog row for a host-visible stream device.
DeviceSite
Export-record-style descriptor for a stream device site.
FakeBackend
Host-independent backend that opens push streams without hardware.
GlassesPlacementRequest
Placement request for one already-resolved glasses route.
HostBackendInfo
Stable metadata describing a host backend.
HostBackendRegistry
Deterministic registry of host stream backends.
HostCallbackCassette
Deterministic recording of host callback items.
HostCallbackQueue
Cloneable handle host callbacks use to enqueue packets into a stream.
HostCallbackReplayReport
Outcome counts from deterministic host callback cassette replay.
HostClockInfo
Clock metadata for an opened host stream.
HostDeviceInventory
Devices and ports reported by a backend enumeration.
HostDeviceSpec
Specification of an enumerated host device.
HostLatencyInfo
Latency estimate for an opened host stream.
HostOpenPlan
Resolved plan describing how a device would be opened.
HostOpenStream
Open stream plus host-side callback queue.
HostPortSpec
Addressable host port owned by an enumerated device.
HostReconnectPolicy
Reconnect behavior accepted by a host backend.
HostStreamConfig
Accepted stream configuration returned by a host backend.
HostStreamConfigProbe
Safe config probe for stream-host audio and MIDI defaults.
HostStreamConfigRequest
Request supplied to a host backend when opening a stream.
LanPlacementReport
Outcome of planning a LAN fragment placement.
LanPlacementRequest
Request to place a stream fragment on a LAN peer under a chosen mode.
MidiLiveEvalSite
Live MIDI evaluation site opened from a cataloged device record.
ModeledAudioProvider
Deterministic audio provider used by default validation.
ModeledAudioSite
Modeled audio site backed by an existing host backend.
ModeledMidiProvider
Deterministic MIDI provider used by default validation.
ProcessRingSnapshot
Capacity snapshot for steady-state process-site checks.
ProcessSharedRing
Preallocated bounded ring used at process-site stream boundaries.
RegisteredAudioSite
A router row for an audio site and the provider that owns it.
ResolvedGlassesPlacement
Validated placement for one glasses route.
RetentionWindow
Retention window assigned by one visible consent receipt.
RouterAudioProviderRegistrar
Registrar that wires provider sites into an AudioRouter.
RtpMidiBackend
Host backend implementing the selected RTP-MIDI input subset.
RtpMidiPort
An opened RTP-MIDI source port and its callback queue.
StoreEvicted
One removed content-store entry.
StoreKey
Stable key for a content-store entry.
StubProvider
Hardware-free provider used when no concrete device provider is installed.
StubSession
Hardware-free session that refuses all live device operations.

Enums§

DeviceCapability
Capability helpers for device-local sensors and actuators.
DeviceDirection
Direction supported by a cataloged stream device.
DeviceError
Error returned by stream-device providers and sessions.
DeviceKind
Stream-device media family surfaced by the shared device catalog.
DeviceSiteLocality
Placement locality advertised by a device site.
GlassesAdapterKind
Local adapter selected for a resolved glasses profile.
GlassesCapability
Glasses-sensitive provider capability classes.
GlassesPlacementError
Error returned while resolving a glasses route placement.
HostBackendCapability
Capability advertised by a host backend.
HostDirection
Direction of a host stream relative to the device.
LanPlacementMode
Placement mode for a stream fragment hosted on a LAN peer.
Placement
Placement tier for a host-visible stream device.
PlacementError
Device placement validation error.
ProcessRingPush
Push result for the bounded process-site ring.
WatchCapability
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§

AudioProviderRegistrar
Host-supplied registration surface for loadable audio providers.
AudioSite
Runtime-openable audio placement target.
CatalogDeviceProvider
Provider of cataloged stream devices.
DeviceProvider
Provider that opens one stream-device session.
DeviceSample
Device sample expression contract used by session polling helpers.
DeviceSession
Open stream-device session.
HostBackend
Backend contract for host-controlled stream devices.
HostStreamDriver
Native or external stream resource attached to an opened host stream.
StreamEvalSite
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§

AudioProviderEntry
Host-callable audio provider entry point.
DeviceResult
Result type returned by device providers and sessions.