NetworkBandwidthDomain
Domain containing the network bandwidth usage for machines in the session.
Tracks BandwidthSource resources only. Producers (modules, ActiveFeed, etc.)
own a source resource per bandwidth contribution and recreate it when their
config changes; the domain reacts uniformly to the resulting
add/update/remove changes.
Methods
adapterCaps(self) -> List[BandwidthNetworkAdapterExport]
Per-adapter link-speed caps for every (hostname, networkAdaptorId)
referenced by the current entries. Live Update clients use this alongside
entries() to render TX/Max and RX/Max ratios.
Returns A vector of network adapter capacity records.
entries(self) -> List[BandwidthEntryExport]
Snapshot of all current bandwidth entries flattened into a JSON-friendly form.
Used by the Live Update WebSocket API as the subscribable view onto the
domain (DSOF-31721).
Returns A vector of bandwidth entries in their export form.
getBandwidth(self, machine: str, adaptor: str, atTime: float, onTrack: SuperTrack, activeOnly: bool) -> BandwidthUsage
Retrives the bandwidth estimate in bits per second.
Parameters:
- machineNodeId: The Comms node ID of a machine in the session.
- adaptorId: The unique ID of a network adaptor.
- atTime: The track time (in beats) at which the bandwidth will be estimated.
Returns Bandwidth estimate in bits per second for the bandwidth usage on a given machine, adaptor and track time.
trackPlayheads(self) -> List[BandwidthPlayheadExport]
Per-track playhead snapshot for every active TransportManager in the
local-or-director state. One row per running track. Live Update clients
use this alongside entries() to draw a vertical “now” line on each
track’s bandwidth sparkline.
Returns A vector of track-playhead records.