freedome_client library

Freedome client SDK (pure Dart: VM, Flutter, web; 02f §6).

FreedomeClient: REST + realtime (plain WS freedome.v1 by default, GraphQL-WS, socket.io opt-in via package:freedome_client/socket_io.dart), the connection state machine with reconnect / resync, offline cache and outbox, credentials (guest, password, pairing, API key, cloud) and the repositories: venues, engine, calibration, playback, content (resumable uploads), OSC; GraphQL queries; the .dome / FDMESH / .zelim / .boranko / .comics codecs; discovery and pairing links.

File helpers, mDNS discovery: package:freedome_client/io.dart (not on web). Account API (L7): package:freedome_client/account.dart. Test doubles: package:freedome_client/testing.dart.

Classes

ActiveShowRequest: PUT /venues/{venueId}/active-show: load a show onto the venue (mapped onto its geometry); showId null unloads.
ActiveShowState: Model ActiveShowState (schemas/api/1.0/player.schema.json#/$defs/activeShowState).
Ambisonics: Model Ambisonics (schemas/dome/1.1/dome.schema.json#/$defs/audio/properties/ambisonics).
AmbisonicsChannelOrder: Open string enumeration AmbisonicsChannelOrder; unknown values are preserved (isUnknown).
AmbisonicsNormalisation: Open string enumeration AmbisonicsNormalisation; unknown values are preserved (isUnknown).
ApiKey: API key
ApiKeyApiKey: Model ApiKeyApiKey (schemas/api/1.0/api-key.schema.json#/$defs/apiKey).
ApiKeyCreated: 201 body of POST /api-keys: the key plus its token, shown once.
ApiKeyCredentials: API key (Authorization: Bearer fdk_…, 02e §3.6) for services, kiosks, integrations.
ApiKeyInput: POST /api-keys. A key never gets more than the caller's own role.
ApiKeyPage: Model ApiKeyPage (schemas/api/1.0/api-key.schema.json#/$defs/page).
ApiOperation: One REST operation of the media-server API v1 (02e §5), identified by its OpenAPI operationId.
AppPayload: App payload
AppPayloadKind: Open string enumeration AppPayloadKind; unknown values are preserved (isUnknown).
AppPayloadTarget: Model AppPayloadTarget (schemas/api/1.0/app-payload.schema.json#/properties/target).
AppTarget: See PlayTarget.app.
Asset: Media / scene (01b §4.5). External assets (absolute URI) carry sha256 + size.
AssetAudio: Model AssetAudio (schemas/dome/1.1/dome.schema.json#/$defs/asset/properties/audio).
AssetAudioKind: Open string enumeration AssetAudioKind; unknown values are preserved (isUnknown).
AssetChanged: asset.* on assets/{a}.
AssetCreateRequest: POST /assets JSON body: register a finished tus upload or an external URL (streams, CDN).
AssetMapping: Content mapping onto the dome (01b §4.5, 02b §4.4).
AssetMappingLayout: 1.1: cubemap 3x2 | 6x1 | cross; pyramid_views cross | row | grid
AssetMedia: Probe result (ffprobe): container, streams, duration. probeUnavailable when the server has no prober (asset still ready).
AssetMediaAudio: Model AssetMediaAudio (schemas/api/1.0/asset.schema.json#/$defs/media/properties/audio).
AssetMediaVideo: Model AssetMediaVideo (schemas/api/1.0/asset.schema.json#/$defs/media/properties/video).
AssetMultipart: POST /assets multipart/form-data body (simple upload ≤ 100 MB): part file + optional JSON fields.
AssetPage: Model AssetPage (schemas/api/1.0/asset.schema.json#/$defs/page).
AssetPatch: Model AssetPatch (schemas/api/1.0/asset.schema.json#/$defs/patch).
AssetResource: Model AssetResource (schemas/api/1.0/asset.schema.json#/$defs/asset).
AssetResourceThumbnails: Model AssetResourceThumbnails (schemas/api/1.0/asset.schema.json#/$defs/asset/properties/thumbnails/items).
AssetResourceType: Open string enumeration AssetResourceType; unknown values are preserved (isUnknown).
AssetStatus: Open string enumeration AssetStatus; unknown values are preserved (isUnknown).
AssetTarget: See PlayTarget.asset.
AssetTexture: Stream asset fed by another application on the engine's machine (derived by the server from src, read-only).
AssetType: Open string enumeration AssetType; unknown values are preserved (isUnknown).
AssetVideo: Model AssetVideo (schemas/dome/1.1/dome.schema.json#/$defs/asset/properties/video).
AssetVideoCodec: Open string enumeration AssetVideoCodec; unknown values are preserved (isUnknown).
AssetVideoStereo: Open string enumeration AssetVideoStereo; unknown values are preserved (isUnknown).
AssetZelimHint: 1.1: hint for type zelim (project = JSON variant J, binary = variant B); content sniffing wins. A J project may carry quantum.scene (02e §9.3).
AssetZelimHintVariant: Open string enumeration AssetZelimHintVariant; unknown values are preserved (isUnknown).
AudioAnalysisFrame: One analysis frame of one input (event audio.analysis). rms, peak and bands are linear amplitude relative to full scale, clamped to 0..1, after the input's envelope (a voice at -24 dBFS reads 0.06). Scene smoothing is applied after this.
AudioAnalysisInput: One analysed input (a vocal microphone, an instrument group, a mix).
AudioAnalysisSettings: PUT /venues/{venueId}/audio/analysis body: replaces the whole list of inputs.
AudioAnalysisState: GET /venues/{venueId}/audio/analysis, event audioAnalysis.state.
AudioBands: Band energies, each 0..1. Fixed ranges: subBass 30–150 Hz, mid 150–800 Hz, highMid 800–4000 Hz, treble 4000–16000 Hz.
AudioCentroidRange: Frequencies that map to centroid 0 and 1.
AudioDecoder: Model AudioDecoder (schemas/dome/1.1/dome.schema.json#/$defs/audio/properties/decoder).
AudioDecoderKind: Open string enumeration AudioDecoderKind; unknown values are preserved (isUnknown).
AudioDevice: Audio device = .dome audio.devices[] / speakers[] entry + live state (02c §6).
AudioDeviceKind: Open string enumeration AudioDeviceKind; unknown values are preserved (isUnknown).
AudioDevicePage: Model AudioDevicePage (schemas/api/1.0/audio.schema.json#/$defs/devicePage).
AudioDevicePatch: Model AudioDevicePatch (schemas/api/1.0/audio.schema.json#/$defs/devicePatch).
AudioDeviceRef: Model AudioDeviceRef (schemas/dome/1.1/dome.schema.json#/$defs/audioDevice).
AudioDeviceRefKind: Open string enumeration AudioDeviceRefKind; unknown values are preserved (isUnknown).
AudioDeviceState: Model AudioDeviceState (schemas/api/1.0/audio.schema.json#/$defs/device/properties/state).
AudioDeviceStateEngine: Open string enumeration AudioDeviceStateEngine; unknown values are preserved (isUnknown).
AudioDeviceTest: Model AudioDeviceTest (schemas/api/1.0/audio.schema.json#/$defs/deviceTest).
AudioDeviceTestKind: Open string enumeration AudioDeviceTestKind; unknown values are preserved (isUnknown).
AudioDeviceTestResult: Model AudioDeviceTestResult (schemas/api/1.0/audio.schema.json#/$defs/deviceTestResult).
AudioEngineRef: Model AudioEngineRef (schemas/api/1.0/audio.schema.json#/$defs/engineRef).
AudioEngineRefStatus: Open string enumeration AudioEngineRefStatus; unknown values are preserved (isUnknown).
AudioInputEnvelope: Model AudioInputEnvelope (schemas/api/1.0/audio-reactive.schema.json#/$defs/input/properties/envelope).
AudioInputOnset: Model AudioInputOnset (schemas/api/1.0/audio-reactive.schema.json#/$defs/input/properties/onset).
AudioLayout: AnantaSound layout (01b §4.4).
AudioMetric: A value of the analysis frame. rms, peak: envelope; subBass, mid, highMid, treble: bands; centroid: spectral brightness; onset: attack strength. Open list.
AudioMode: 1.1 (02c AQ4, replaces x-ananta.mode): audio engines used by the show; absent = digital.
AudioModeValue: A8: digital = anAntaDigital only; hybrid = anAntaSound (mechanical devices); combined = both.
AudioOnset: One detected attack (event audio.onset).
AudioOnsetBand: band with the largest energy rise, when known
AudioPatch: Model AudioPatch (schemas/api/1.0/audio.schema.json#/$defs/patch).
AudioPreset: Installed L6 preset: an ananta/1.0 programme, pattern or session document (02c, RC2).
AudioPresetInput: PUT /venues/{venueId}/audio/presets/{presetId} body.
AudioPresetKind: Open string enumeration AudioPresetKind; unknown values are preserved (isUnknown).
AudioPresetPage: Model AudioPresetPage (schemas/api/1.0/audio.schema.json#/$defs/presetPage).
AudioPresetPageItems: Model AudioPresetPageItems (schemas/api/1.0/audio.schema.json#/$defs/presetPage/properties/items/items).
AudioReactiveCurve: for t in 0..1: linear t; exp t²; log log10(1 + 9t); s-curve 3t² − 2t³
AudioReactiveMapping: One metric → one target. continuous: the mapped value is sent on every frame it changes. trigger: one message when the metric rises through threshold, then nothing for cooldownMs.
AudioReactiveMappingMode: Open string enumeration AudioReactiveMappingMode; unknown values are preserved (isUnknown).
AudioReactiveOscType: OSC argument type
AudioReactivePatch: PATCH /venues/{venueId}/audio/reactive. activeSceneId null = no scene. An unknown scene, or a scene whose gateway or input does not exist, is refused with 422.
AudioReactiveRange: Linear map before the curve. inMax > inMin (422 otherwise); outMin > outMax inverts. Defaults 0, 1, 0, 1.
AudioReactiveRepository: Analysis, scenes and texture sources of one venue (venueId, default default).
AudioReactiveScene: A scene is data: which metrics drive which targets. Mapping ids are unique within the scene.
AudioReactiveSceneBody: Model AudioReactiveSceneBody (schemas/api/1.0/audio-reactive.schema.json#/$defs/sceneBody).
AudioReactiveSceneInput: PUT …/audio/reactive/scenes/{sceneId} body.
AudioReactiveScenePage: Model AudioReactiveScenePage (schemas/api/1.0/audio-reactive.schema.json#/$defs/scenePage).
AudioReactiveSmoothing: Asymmetric smoothing of the mapped value, applied by the media server.
AudioReactiveSource: Model AudioReactiveSource (schemas/api/1.0/audio-reactive.schema.json#/$defs/mapping/properties/source).
AudioReactiveState: AudioReactive state
AudioReactiveStateBody: GET /venues/{venueId}/audio/reactive, event audioReactive.state.
AudioReactiveTarget: Where a mapping goes. kind osc: an OSC address of an outbound gateway. Open list: a server that does not know a kind answers 422.
AudioReactiveTargetKind: Open string enumeration AudioReactiveTargetKind; unknown values are preserved (isUnknown).
AudioRepository: Audio of one venue (venueId, default default).
AudioServiceStatus: Service status. Open list.
AudioSession: Model AudioSession (schemas/api/1.0/audio.schema.json#/$defs/session).
AudioSessionPage: Model AudioSessionPage (schemas/api/1.0/audio.schema.json#/$defs/sessionPage).
AudioSessionStart: POST /venues/{venueId}/audio/sessions: run an installed preset (programme or session).
AudioSessionStatus: Open string enumeration AudioSessionStatus; unknown values are preserved (isUnknown).
AudioState: Audio state
AudioStateEngines: Model AudioStateEngines (schemas/api/1.0/audio.schema.json#/properties/engines).
AudioTargets: Model AudioTargets (schemas/api/1.0/audio.schema.json#/$defs/targets).
AudioZone: anAntaDigital zone: a subset of speakers with gain, delay, EQ.
AudioZoneBody: Model AudioZoneBody (schemas/api/1.0/audio.schema.json#/$defs/zoneBody).
AudioZoneInput: Model AudioZoneInput (schemas/api/1.0/audio.schema.json#/$defs/zoneInput).
AudioZonePage: Model AudioZonePage (schemas/api/1.0/audio.schema.json#/$defs/zonePage).
AudioZonePatch: Model AudioZonePatch (schemas/api/1.0/audio.schema.json#/$defs/zonePatch).
AuthMethod: Open string enumeration AuthMethod; unknown values are preserved (isUnknown).
AwaitedInput: Model AwaitedInput (schemas/api/1.0/calibration-job.schema.json#/$defs/awaiting).
AwaitedInputKind: Open string enumeration AwaitedInputKind; unknown values are preserved (isUnknown).
BackendRequest: Model BackendRequest (schemas/api/1.0/engine.schema.json#/$defs/backendRequest).
BackendRequestBackend: Open string enumeration BackendRequestBackend; unknown values are preserved (isUnknown).
BackoffPolicy: Exponential backoff with full jitter (AWS architecture blog "Exponential Backoff And Jitter").
BackupRequest: Model BackupRequest (schemas/api/1.0/system.schema.json#/$defs/backupRequest).
BackupRequestInclude: Open string enumeration BackupRequestInclude; unknown values are preserved (isUnknown).
BlendMapRef: Model BlendMapRef (schemas/dome/1.1/dome.schema.json#/$defs/displayCalibration/properties/blend).
BorankoCodec: .boranko reader / writer.
BorankoProject: A decoded .boranko project (normalised; unknown keys kept).
BytesContentSource: A ContentSource over bytes in memory.
BytesInput: See FormatInput.bytes.
CachedValue: A cached JSON value with the time it was read from the server.
CacheStore: Read-cache port: last known server representations by key (<dome id>/<resource>).
Calibration: Per-display calibration (01b §4.3); keys of displays are display ids (checked by the codecs).
CalibrationCapture: POST …/captures JSON body: a camera frame uploaded before (tus upload id); multipart/form-data with an image part is the alternative (≤ 32 MB).
CalibrationChanged: calibration.updated on venues/{v}/calibration.
CalibrationDisplayError: Model CalibrationDisplayError (schemas/api/1.0/calibration-job.schema.json#/$defs/calibrationJob/properties/errors/items).
CalibrationJob: Calibration job
CalibrationJobCalibrationJob: Model CalibrationJobCalibrationJob (schemas/api/1.0/calibration-job.schema.json#/$defs/calibrationJob).
CalibrationJobChanged: calibrationJob.* on venues/{v}/calibration/jobs/{j}.
CalibrationJobPage: Model CalibrationJobPage (schemas/api/1.0/calibration-job.schema.json#/$defs/page).
CalibrationKind: Open string enumeration CalibrationKind; unknown values are preserved (isUnknown).
CalibrationMethod: Open string enumeration CalibrationMethod; unknown values are preserved (isUnknown).
CalibrationReport: Model CalibrationReport (schemas/dome/1.1/dome.schema.json#/$defs/displayCalibration/properties/report).
CalibrationRepository: Visual (and later audio) calibration jobs of a venue.
CalibrationRequest: POST /venues/{venueId}/calibration/jobs body.
CalibrationStep: Model CalibrationStep (schemas/api/1.0/calibration-job.schema.json#/$defs/calibrationJob/properties/steps/items).
CalibrationStepStatus: Open string enumeration CalibrationStepStatus; unknown values are preserved (isUnknown).
CaptureFrame: A camera / phone frame for the awaited calibration step (JPEG or PNG, ≤ 32 MB).
ClientCapability: Open string enumeration ClientCapability; unknown values are preserved (isUnknown).
ClientCommand: Server → device command, delivered as event client.command on clients/{clientId}/commands.
ClientCommandCommand: Open string enumeration ClientCommandCommand; unknown values are preserved (isUnknown).
ClientCommandEvent: client.command on clients/{c}/commands (vibrate, capture, sensors, biometric).
ClientDevice: Model ClientDevice (schemas/api/1.0/client.schema.json#/$defs/client).
ClientInfo: Model ClientInfo (schemas/api/1.0/auth.schema.json#/$defs/clientInfo).
ClientPage: Model ClientPage (schemas/api/1.0/client.schema.json#/$defs/page).
ClientRegistration: Model ClientRegistration (schemas/api/1.0/client.schema.json#/$defs/input).
ClientsRepository: Registration of this app instance as a client device of the dome, and its sensor telemetry.
ClientTelemetry: POST /clients/{clientId}/telemetry: batched sensor samples (replaces sendSensorData).
ClientTelemetrySamples: Model ClientTelemetrySamples (schemas/api/1.0/client.schema.json#/$defs/telemetry/properties/samples/items).
ClockStatus: Clock status of a node (02d ClockStatus).
ClockStatusSource: Open string enumeration ClockStatusSource; unknown values are preserved (isUnknown).
CloudAccepted: Model CloudAccepted (schemas/cloud/1.0/cloud.schema.json#/$defs/accepted).
CloudAccount: Model CloudAccount (schemas/cloud/1.0/cloud.schema.json#/$defs/account).
CloudAccountPatch: Model CloudAccountPatch (schemas/cloud/1.0/cloud.schema.json#/$defs/accountPatch).
CloudAccountPlatformRole: Open string enumeration CloudAccountPlatformRole; unknown values are preserved (isUnknown).
CloudAccountStatus: Open string enumeration CloudAccountStatus; unknown values are preserved (isUnknown).
CloudApp: Model CloudApp (schemas/cloud/1.0/cloud.schema.json#/$defs/app).
CloudAppPage: Model CloudAppPage (schemas/cloud/1.0/cloud.schema.json#/$defs/appPage).
CloudCatalogueItem: Model CloudCatalogueItem (schemas/cloud/1.0/cloud.schema.json#/$defs/catalogueItem).
CloudCatalogueItemKind: Open string enumeration CloudCatalogueItemKind; unknown values are preserved (isUnknown).
CloudCatalogueItemPage: Model CloudCatalogueItemPage (schemas/cloud/1.0/cloud.schema.json#/$defs/catalogueItemPage).
CloudCatalogueItemPriceKind: Open string enumeration CloudCatalogueItemPriceKind; unknown values are preserved (isUnknown).
CloudCatalogueItemStatus: Open string enumeration CloudCatalogueItemStatus; unknown values are preserved (isUnknown).
CloudCatalogueItemVisibility: Open string enumeration CloudCatalogueItemVisibility; unknown values are preserved (isUnknown).
CloudCloudEvent: Cloud realtime event (socket.io /v1 on /api/socket.io/, GraphQL subscriptions): the common envelope with topic = cloud/{orgId}/… or user/{userId}/…
CloudCloudEventData: Model CloudCloudEventData (schemas/cloud/1.0/cloud.schema.json#/$defs/cloudEvent/properties/data).
CloudCloudEventDataKind: Open string enumeration CloudCloudEventDataKind; unknown values are preserved (isUnknown).
CloudCloudKey: Model CloudCloudKey (schemas/cloud/1.0/cloud.schema.json#/$defs/cloudKey).
CloudCloudKeyCreated: Model CloudCloudKeyCreated (schemas/cloud/1.0/cloud.schema.json#/$defs/cloudKeyCreated).
CloudCloudKeyInput: Model CloudCloudKeyInput (schemas/cloud/1.0/cloud.schema.json#/$defs/cloudKeyInput).
CloudCloudKeyKind: Open string enumeration CloudCloudKeyKind; unknown values are preserved (isUnknown).
CloudCloudKeyPage: Model CloudCloudKeyPage (schemas/cloud/1.0/cloud.schema.json#/$defs/cloudKeyPage).
CloudCredentials: A user signed in to the cloud (L7 freedome_server, 02h): its JWT is exchanged at POST /auth/token-exchange for a local session on linked installations (02e §3.6). token is asked again when the local session cannot be refreshed (feed it from FreedomeAccountClient).
CloudDeviceCode: RFC 8628 device authorization response.
CloudDeviceTokenRequest: Model CloudDeviceTokenRequest (schemas/cloud/1.0/cloud.schema.json#/$defs/deviceTokenRequest).
CloudDiscovery: The user's domes registered on the cloud (L7). Implementation: P6 (6.SDK.1); the interface lets apps wire it into CompositeDiscovery today.
CloudDome: Model CloudDome (schemas/cloud/1.0/cloud.schema.json#/$defs/dome).
CloudDomeInput: Model CloudDomeInput (schemas/cloud/1.0/cloud.schema.json#/$defs/domeInput).
CloudDomeInputKind: Open string enumeration CloudDomeInputKind; unknown values are preserved (isUnknown).
CloudDomeKind: Open string enumeration CloudDomeKind; unknown values are preserved (isUnknown).
CloudEmail: Model CloudEmail (schemas/cloud/1.0/cloud.schema.json#/$defs/email).
CloudEnrollmentApproval: Model CloudEnrollmentApproval (schemas/cloud/1.0/cloud.schema.json#/$defs/enrollmentApproval).
CloudEnrollmentState: Model CloudEnrollmentState (schemas/cloud/1.0/cloud.schema.json#/$defs/enrollmentState).
CloudEnrollmentStateStatus: Open string enumeration CloudEnrollmentStateStatus; unknown values are preserved (isUnknown).
CloudEnrollmentToken: Model CloudEnrollmentToken (schemas/cloud/1.0/cloud.schema.json#/$defs/enrollmentToken).
CloudEnrollmentTokenInput: Model CloudEnrollmentTokenInput (schemas/cloud/1.0/cloud.schema.json#/$defs/enrollmentTokenInput).
CloudEnrollmentTokenPage: Model CloudEnrollmentTokenPage (schemas/cloud/1.0/cloud.schema.json#/$defs/enrollmentTokenPage).
CloudEnrollRequest: Model CloudEnrollRequest (schemas/cloud/1.0/cloud.schema.json#/$defs/enrollRequest).
CloudEnrollWithToken: Model CloudEnrollWithToken (schemas/cloud/1.0/cloud.schema.json#/$defs/enrollWithToken).
CloudInstallation: Model CloudInstallation (schemas/cloud/1.0/cloud.schema.json#/$defs/installation).
CloudInstallationCredentials: Model CloudInstallationCredentials (schemas/cloud/1.0/cloud.schema.json#/$defs/installationCredentials).
CloudInstallationPage: Model CloudInstallationPage (schemas/cloud/1.0/cloud.schema.json#/$defs/installationPage).
CloudInstallationPatch: Model CloudInstallationPatch (schemas/cloud/1.0/cloud.schema.json#/$defs/installationPatch).
CloudInstallationPatchTelemetryLevel: Open string enumeration CloudInstallationPatchTelemetryLevel; unknown values are preserved (isUnknown).
CloudInstallationStatus: Open string enumeration CloudInstallationStatus; unknown values are preserved (isUnknown).
CloudInstallationTelemetryLevel: Open string enumeration CloudInstallationTelemetryLevel; unknown values are preserved (isUnknown).
CloudInvitation: Model CloudInvitation (schemas/cloud/1.0/cloud.schema.json#/$defs/invitation).
CloudInvitationInput: Model CloudInvitationInput (schemas/cloud/1.0/cloud.schema.json#/$defs/invitationInput).
CloudInvitationInputRole: Open string enumeration CloudInvitationInputRole; unknown values are preserved (isUnknown).
CloudInvitationPage: Model CloudInvitationPage (schemas/cloud/1.0/cloud.schema.json#/$defs/invitationPage).
CloudInvitationRole: Open string enumeration CloudInvitationRole; unknown values are preserved (isUnknown).
CloudJwks: Model CloudJwks (schemas/cloud/1.0/cloud.schema.json#/$defs/jwks).
CloudJwksKeys: Model CloudJwksKeys (schemas/cloud/1.0/cloud.schema.json#/$defs/jwks/properties/keys/items).
CloudLoginDevice: Model CloudLoginDevice (schemas/cloud/1.0/cloud.schema.json#/$defs/loginDevice).
CloudLoginDevicePage: Model CloudLoginDevicePage (schemas/cloud/1.0/cloud.schema.json#/$defs/loginDevicePage).
CloudMember: Model CloudMember (schemas/cloud/1.0/cloud.schema.json#/$defs/member).
CloudMemberPage: Model CloudMemberPage (schemas/cloud/1.0/cloud.schema.json#/$defs/memberPage).
CloudMemberPatch: Model CloudMemberPatch (schemas/cloud/1.0/cloud.schema.json#/$defs/memberPatch).
CloudMemberPatchRole: Open string enumeration CloudMemberPatchRole; unknown values are preserved (isUnknown).
CloudMemberRole: Open string enumeration CloudMemberRole; unknown values are preserved (isUnknown).
CloudMembership: Model CloudMembership (schemas/cloud/1.0/cloud.schema.json#/$defs/membership).
CloudMembershipRole: Open string enumeration CloudMembershipRole; unknown values are preserved (isUnknown).
CloudMeta: Model CloudMeta (schemas/cloud/1.0/cloud.schema.json#/$defs/meta).
CloudOauth: Model CloudOauth (schemas/cloud/1.0/cloud.schema.json#/$defs/oauth).
CloudOauthClient: Open string enumeration CloudOauthClient; unknown values are preserved (isUnknown).
CloudOperations: The REST operations of the cloud server (L7) API v1 known to this version (02e §5).
CloudOrg: Model CloudOrg (schemas/cloud/1.0/cloud.schema.json#/$defs/org).
CloudOrgInput: Model CloudOrgInput (schemas/cloud/1.0/cloud.schema.json#/$defs/orgInput).
CloudOrgKind: Open string enumeration CloudOrgKind; unknown values are preserved (isUnknown).
CloudOrgMyRole: Open string enumeration CloudOrgMyRole; unknown values are preserved (isUnknown).
CloudOrgPage: Model CloudOrgPage (schemas/cloud/1.0/cloud.schema.json#/$defs/orgPage).
CloudOrgPatch: Model CloudOrgPatch (schemas/cloud/1.0/cloud.schema.json#/$defs/orgPatch).
CloudPasswordChange: Model CloudPasswordChange (schemas/cloud/1.0/cloud.schema.json#/$defs/passwordChange).
CloudPasswordReset: Model CloudPasswordReset (schemas/cloud/1.0/cloud.schema.json#/$defs/passwordReset).
CloudRefresh: Model CloudRefresh (schemas/cloud/1.0/cloud.schema.json#/$defs/refresh).
CloudRoomJoin: Model CloudRoomJoin (schemas/cloud/1.0/cloud.schema.json#/$defs/roomJoin).
CloudSession: Session tokens (same shape as the media server, api/1.0/auth tokens) + created / linked for OAuth.
CloudSignIn: Model CloudSignIn (schemas/cloud/1.0/cloud.schema.json#/$defs/signIn).
CloudSignInClient: Open string enumeration CloudSignInClient; unknown values are preserved (isUnknown).
CloudSignUp: Model CloudSignUp (schemas/cloud/1.0/cloud.schema.json#/$defs/signUp).
CloudSignUpClient: Open string enumeration CloudSignUpClient; unknown values are preserved (isUnknown).
CloudToken: Model CloudToken (schemas/cloud/1.0/cloud.schema.json#/$defs/token).
CloudVenue: Model CloudVenue (schemas/cloud/1.0/cloud.schema.json#/$defs/venue).
CloudVenueInput: Model CloudVenueInput (schemas/cloud/1.0/cloud.schema.json#/$defs/venueInput).
CloudVenuePage: Model CloudVenuePage (schemas/cloud/1.0/cloud.schema.json#/$defs/venuePage).
ColourCalibration: Model ColourCalibration (schemas/dome/1.1/dome.schema.json#/$defs/displayCalibration/properties/colour).
ComicsCodec: .comics reader (read-only import format).
ComicsDocument: A decoded .comics.
CompositeDiscovery: Merges several discoveries by dome id (the freshest record wins; mDNS beats manual for the address, so a dome that changed its IP is re-resolved), debounced by debounce.
ComputeBackend: visual: active compute / render backend
ContentChange: What changed in the content store (assets/{a} events).
ContentQuery: Filter of ContentRepository.list (02e §3.4: plain query params named after fields).
ContentRepository: The content of the media server: assets (with resumable uploads), shows, imports.
ContentSource: Bytes to upload (portable; package:freedome_client/io.dart adds files).
CountBytes: Model CountBytes (schemas/api/1.0/asset.schema.json#/$defs/countBytes).
Cue: Model Cue (schemas/dome/1.1/dome.schema.json#/$defs/cue).
CueAction: Model CueAction (schemas/dome/1.1/dome.schema.json#/$defs/action).
CueActionKind: Open string enumeration CueActionKind; unknown values are preserved (isUnknown).
CueAt: Model CueAt (schemas/dome/1.1/dome.schema.json#/$defs/cue/properties/at).
CueEvent: cue.fired / cue.failed on venues/{v}/cues.
CueFired: Model CueFired (schemas/api/1.0/player.schema.json#/$defs/cueFired).
CueFiredActions: Model CueFiredActions (schemas/api/1.0/player.schema.json#/$defs/cueFired/properties/actions/items).
CueFiredActionsStatus: Open string enumeration CueFiredActionsStatus; unknown values are preserved (isUnknown).
CurrentTarget: See PlayTarget.current.
Decoded<T>: A decoded document with its reader warnings (<code> or <code>:<pointer>, order-insensitive).
DeviceBind: Model DeviceBind (schemas/api/1.0/device.schema.json#/$defs/bind).
DevicePairingConfirm: Model DevicePairingConfirm (schemas/api/1.0/device.schema.json#/$defs/pairingConfirm).
DevicePairingStarted: POST /devices/{deviceId}/pairing: the device shows a code (display / LED); the operator confirms it.
DiagnosticsRequest: Model DiagnosticsRequest (schemas/api/1.0/system.schema.json#/$defs/diagnosticsRequest).
DiagnosticsRequestChecks: Open string enumeration DiagnosticsRequestChecks; unknown values are preserved (isUnknown).
DirectoryInput: See FormatInput.directory.
DiscoveredDome: A dome found by a DomeDiscovery.
Display: Visual device (01b §4.2): projector (incl. fisheye), LED, prism unit, smartphone + lens, NDI output.
DisplayCalibration: Model DisplayCalibration (schemas/dome/1.1/dome.schema.json#/$defs/displayCalibration).
DisplayCapability: Open string enumeration DisplayCapability; unknown values are preserved (isUnknown).
DisplayChanged: display.state / display.pattern / display.error on venues/{v}/displays/{d}.
DisplayColour: Model DisplayColour (schemas/dome/1.1/dome.schema.json#/$defs/display/properties/colour).
DisplayColourGamut: Open string enumeration DisplayColourGamut; unknown values are preserved (isUnknown).
DisplayFault: Model DisplayFault (schemas/api/1.0/display.schema.json#/$defs/state/properties/faults/items).
DisplayInfo: Display
DisplayInfoDisplay: Model DisplayInfoDisplay (schemas/api/1.0/display.schema.json#/$defs/display).
DisplayLens: Model DisplayLens (schemas/dome/1.1/dome.schema.json#/$defs/lens).
DisplayLensCurvature: 1.1 (EN, curved LED walls): the display surface is a cylinder (axis vertical = curved horizontally, the usual curved wall) or a sphere section; absent = flat.
DisplayLensCurvatureAxis: Open string enumeration DisplayLensCurvatureAxis; unknown values are preserved (isUnknown).
DisplayModel: Model DisplayModel (schemas/dome/1.1/dome.schema.json#/$defs/display/properties/model).
DisplayOptics: 1.1 (02a V12, replaces x-freedome-optics): per-face layout of prism / pyramid optics on the display frame.
DisplayOutputBinding: Model DisplayOutputBinding (schemas/dome/1.1/dome.schema.json#/$defs/display/properties/output).
DisplayPage: Model DisplayPage (schemas/api/1.0/display.schema.json#/$defs/page).
DisplayPose: Model DisplayPose (schemas/dome/1.1/dome.schema.json#/$defs/pose).
DisplayPower: Open string enumeration DisplayPower; unknown values are preserved (isUnknown).
DisplayPowerRequest: POST …/power body; only what the device supports (state.capabilities).
DisplayShutter: Open string enumeration DisplayShutter; unknown values are preserved (isUnknown).
DisplayState: Model DisplayState (schemas/api/1.0/display.schema.json#/$defs/state).
DisplayStereo: Model DisplayStereo (schemas/dome/1.1/dome.schema.json#/$defs/display/properties/stereo/oneOf/1).
DisplayType: Open string enumeration DisplayType; unknown values are preserved (isUnknown).
DistortionModel: Open string enumeration DistortionModel; unknown values are preserved (isUnknown).
DomeAuthor: Model DomeAuthor (schemas/dome/1.1/dome.schema.json#/$defs/meta/properties/authors/items).
DomeByteSource: Random-access, read-only bytes (a file, an in-memory buffer, a blob). Implementations for files live in package:freedome_client/io.dart.
DomeCodec: Reader / writer of .dome files.
DomeContainer: The entries of a .dome — a ZIP file or an unpacked <name>.dome/ directory.
DomeDiscovery: Finds domes (02f §8.1).
DomeDocument: A .dome read by DomeReader.
DomeEntryInfo: Metadata of one entry in a DomeContainer.
DomeEntrySource: A source of one entry to write: size bytes from open (called up to twice for stored entries).
DomeGenerator: Model DomeGenerator (schemas/dome/1.1/dome.schema.json#/$defs/meta/properties/generator).
DomeGeometry: Dome geometry (01b §4.1). Right-handed, metres, degrees; +Y zenith, -Z front.
DomeKind: Closed: selects the required sections.
DomeLimits: Size guards of the container readers (01b §2.1 defaults).
DomeManifest: .dome manifest 1.1
DomeMeta: Model DomeMeta (schemas/dome/1.1/dome.schema.json#/$defs/meta).
DomeMode: Open string enumeration DomeMode; unknown values are preserved (isUnknown).
DomeOrientation: Open string enumeration DomeOrientation; unknown values are preserved (isUnknown).
DomePackage: A decoded .dome: the manifest plus access to every container entry.
DomeReader: The strict reader.
DomeReadOptions: Options of DomeReader.read.
DomeSeating: Open string enumeration DomeSeating; unknown values are preserved (isUnknown).
DomeShape: Open string enumeration DomeShape; unknown values are preserved (isUnknown).
DomeSignatureManifest: .dome signature manifest 1.1
DomeSurface: Model DomeSurface (schemas/dome/1.1/dome.schema.json#/$defs/dome/properties/surface).
DomeTopics: Event topics of API v1 (one tree for WS, socket.io, GraphQL subscriptions and OSC).
DomeValidator: Semantic validation of a .dome (01b §2.1) beyond what the generated models check: ids, references, embedded paths, kind-dependent sections, non-empty lists, checksums. Not a full JSON-Schema 2020-12 validator (patterns / ranges of the schema are left to the contract's reference validator and the media server).
EngineChanged: engine.status / engine.metrics / engine.error on engines/{name}.
EngineName: Open string enumeration EngineName; unknown values are preserved (isUnknown).
EnginePage: Model EnginePage (schemas/api/1.0/engine.schema.json#/$defs/page).
EngineRepository: Displays of a venue (engine outputs + device state), test patterns, identify, power; visual-engine status.
EngineState: Open string enumeration EngineState; unknown values are preserved (isUnknown).
EngineStatus: Model EngineStatus (schemas/api/1.0/engine.schema.json#/$defs/engine).
EnrollmentDenial: Model EnrollmentDenial (schemas/cloud/1.0/cloud.schema.json#/$defs/enrollmentDenial).
EqBand: Model EqBand (schemas/api/1.0/audio.schema.json#/$defs/eqBand).
EqBandType: Open string enumeration EqBandType; unknown values are preserved (isUnknown).
ErrorUnit: Open string enumeration ErrorUnit; unknown values are preserved (isUnknown).
EventKinds: Event kinds of API v1 (02e §7.2; data.kind of an event message). Unknown kinds stay valid.
EventPage: GET /events (history ring buffer, resume after reconnect): events with seq > sinceSeq on the requested topics. resync: true = the gap is older than the buffer; re-read state.
EventPageItems: S→C event (02e §7.1).
EventPageItemsData: Event data by kind
FireCueRequest: Model FireCueRequest (schemas/api/1.0/player.schema.json#/$defs/fireCue).
FormatInput: A file or a directory to sniff / decode (portable: callers supply bytes and lookups; io.dart builds them from the file system).
FormatMime: MIME types of the content formats (02e §9.2).
FormatSniffer: Content sniffing (02e §9.2): content wins, the extension is never consulted.
FreedomeClient: Client of one dome's media server (L3) over the public API v1 (L4).
FreedomeClientOptions: Client options (02f §6).
FreedomeCredentials: How the client authenticates.
FreedomeEndpoint: Address of one dome's media server, from discovery, a pairing link or manual entry.
FreedomeEvent: An event (02e §7.1): data = {seq, kind, resource | patch, revision?} on a topic.
FreedomeLogRecord: One log record emitted by the SDK.
FreedomeRequest: A REST request relative to the API base (/api/v1).
FreedomeResponse: A REST response.
FreedomeTransport: Sends REST requests to one media server.
FreedomeTransportFactory: Creates transports for an endpoint (injectable: tests and FakeDomeServer use an in-process factory).
Gateway: Model Gateway (schemas/api/1.0/gateway.schema.json#/$defs/gateway).
GatewayDirection: Open string enumeration GatewayDirection; unknown values are preserved (isUnknown).
GatewayListeners: Model GatewayListeners (schemas/api/1.0/gateway.schema.json#/$defs/gateway/properties/listeners/items).
GatewayListenersTransport: Open string enumeration GatewayListenersTransport; unknown values are preserved (isUnknown).
GatewayPage: Model GatewayPage (schemas/api/1.0/gateway.schema.json#/$defs/page).
GatewayPatch: Model GatewayPatch (schemas/api/1.0/gateway.schema.json#/$defs/patch).
GatewayPeers: Model GatewayPeers (schemas/api/1.0/gateway.schema.json#/$defs/gateway/properties/peers/items).
GatewaysRepository: Gateways of this server.
GatewayStatus: Open string enumeration GatewayStatus; unknown values are preserved (isUnknown).
GatewayTestResult: Model GatewayTestResult (schemas/api/1.0/gateway.schema.json#/$defs/testResult).
GeneratorSession: The venue generator (…/audio/generator): start / change (start), stop, and its state from generator.state events — read over REST once and after a resync, never polled while realtime is up.
GeneratorSettings: Test / MULTI generator (iScillator semantics; replaces generate_test_signal).
GeneratorSettingsSignal: Open string enumeration GeneratorSettingsSignal; unknown values are preserved (isUnknown).
GeneratorState: Model GeneratorState (schemas/api/1.0/audio.schema.json#/$defs/generatorState).
GraphqlClient: GraphQL queries and mutations.
GraphqlTransport: Model GraphqlTransport (schemas/api/1.0/info.schema.json#/properties/transports/properties/graphql).
GraphqlWsChannel: A RealtimeChannel over GraphQL subscriptions.
GuestCredentials: No credentials: anonymous access (info; kiosk installations may grant guest scopes).
HealthCheck: Model HealthCheck (schemas/api/1.0/info.schema.json#/$defs/health/properties/checks/additionalProperties).
HealthCheckStatus: Open string enumeration HealthCheckStatus; unknown values are preserved (isUnknown).
HealthStatus: Open string enumeration HealthStatus; unknown values are preserved (isUnknown).
HttpRestTransport: FreedomeTransport over an injectable http.Client.
HttpTransportFactory: Default factory: one http.Client per endpoint.
IdentifyRequest: POST …/identify body (optional): how long to show the id overlay.
ImportFormat: Open string enumeration ImportFormat; unknown values are preserved (isUnknown).
ImportRequest: Import request
ImportResult: result of a succeeded import job.
ImportTarget: Model ImportTarget (schemas/api/1.0/import.schema.json#/properties/target).
ImportTargetKind: Open string enumeration ImportTargetKind; unknown values are preserved (isUnknown).
InMemoryCacheStore: In-memory CacheStore (default).
InMemoryOutboxStore: In-memory OutboxStore.
InMemoryPinStore: In-memory PinStore (default).
InMemoryTokenStore: In-memory TokenStore (default; nothing survives the process).
Job: Job
JobChanged: job.state / job.progress on jobs/{j}.
JobJob: Model JobJob (schemas/api/1.0/job.schema.json#/$defs/job).
JobKind: Open string enumeration JobKind; unknown values are preserved (isUnknown).
JobLinks: Model JobLinks (schemas/api/1.0/job.schema.json#/$defs/job/properties/links).
JobPage: Model JobPage (schemas/api/1.0/job.schema.json#/$defs/page).
JobStatus: queued → running ⇄ awaiting_input → succeeded | failed | cancelled.
JsonSchemaRegistry: A set of schemas addressable by $id.
LensDistortion: 1.1 (02b E4): lens distortion model.
LensKind: Open string enumeration LensKind; unknown values are preserved (isUnknown).
LogEntry: Model LogEntry (schemas/api/1.0/system.schema.json#/$defs/logEntry).
LogEntryEvent: log.entry on system/logs.
LogLevel: Open string enumeration LogLevel; unknown values are preserved (isUnknown).
LogPage: Model LogPage (schemas/api/1.0/system.schema.json#/$defs/logPage).
MatrixCell: Model MatrixCell (schemas/dome/1.1/dome.schema.json#/$defs/matrix/properties/cells/items).
MediaPlayer: 1.1 (02d MD8): named media player. Player main always exists (implicit: all displays, source = startup).
MediaPlayerTarget: absent = all displays
MemoryByteSource: A DomeByteSource over bytes in memory (works on every platform, incl. web).
MemoryDomeContainer: A container held in memory (entries built by an app before writing, or a test).
MessageSocket: One open bidirectional text-frame connection.
MessageTypes: Known message types (02e §8.1). The set is open: readers ignore unknown types.
MultiParams: The seven MULTI parameters (program, target, enviroment, modulation, multi, channel, audio).
MultipartPart: One part of a multipart/form-data body.
MultiProgramme: Building and reading MULTI programmes.
NdiOutput: Model NdiOutput (schemas/api/1.0/output.schema.json#/properties/ndi).
NodeInfo: Cluster node (02d UC-K1–K3): this server and the engine hosts it drives.
NodeInfoRole: Open string enumeration NodeInfoRole; unknown values are preserved (isUnknown).
NodeInfoStatus: Open string enumeration NodeInfoStatus; unknown values are preserved (isUnknown).
NodePage: Model NodePage (schemas/api/1.0/system.schema.json#/$defs/nodePage).
OfflinePolicy: What the client does with operations while offline (02f §7.4).
OperationParam: One parameter of an operation.
Operations: The REST operations of the media-server API v1 known to this version (02e §5).
OperationSchema: Request and response schemas of an operation (JSON Schema texts by content type; responses by status code or default).
OpticsViewport: Model OpticsViewport (schemas/dome/1.1/dome.schema.json#/$defs/optics/properties/viewports/items).
OscArg: Model OscArg (schemas/api/1.0/gateway.schema.json#/$defs/oscArg).
OscArgType: Open string enumeration OscArgType; unknown values are preserved (isUnknown).
OscMessage: One OSC message (address + typed args: int, double, String, bool, bytes as List<int>).
OscRepository: OSC through the media server: send to a configured target (scope gateways:manage), observe the OSC traffic of the gateways (gateways/{g} gateway.message events, debug).
OscSendRequest: POST /integrations/osc/send: to a configured OSC target only (never an arbitrary host).
OscTransport: Model OscTransport (schemas/api/1.0/info.schema.json#/properties/transports/properties/osc).
OtherEvent: Any other (or future) kind.
OutboxEntry: One queued idempotent write (JSON body only; uploads resume by themselves).
OutboxOutcome: Outcome of replaying one OutboxEntry.
OutboxStore: Write-queue port (02f §7.4): entries are replayed in order after a resync.
OutputChanged: output.state on venues/{v}/output.
Page<T>: One page of a cursor-paginated collection (02e §3.4).
Pairing: Pairing state. code (6 digits) is returned only to the requester on creation and shown on the dome / in Manager; tokens only once, to the requester's first poll after approval.
PairingApproval: POST /auth/pairings/{pairingId}/approve body (operator side).
PairingCredentials: Pairing of an app / device (POST /auth/pairings, 02e §3.6): the server answers with a 6-digit code that the operator sees on the dome / in Manager and approves; the client polls until the pairing is approved, denied or expired. The approved pairing carries a long-lived device token.
PairingLink: freedome://pair?host=<h>&port=<p>&id=<domeId>&code=<6 digits>&fp=<sha256>[&tls=1][&name=…] — shown as a QR code by Manager / the media-server console.
PairingRequest: POST /auth/pairings (anonymous; ecosystem app asks for a guest token).
PairingStatus: Open string enumeration PairingStatus; unknown values are preserved (isUnknown).
ParameterInfo: A node / layer parameter (02d ParameterService UC-N1–N3; Screenberry-compatible surface).
ParameterInfoType: Open string enumeration ParameterInfoType; unknown values are preserved (isUnknown).
ParameterPage: Model ParameterPage (schemas/api/1.0/player.schema.json#/$defs/parameterPage).
ParameterValue: PUT /venues/{venueId}/parameters/{path} body.
PasswordCredentials: Local media-server account (POST /auth/session).
PinStore: Trust-on-first-use store of certificate pins by dome id (02f §8.2): a changed fingerprint is a hard error (TlsPinMismatchException) until the user re-pairs (deletes the pin).
PlaybackChanged: player.state / player.position / player.ended / player.error on venues/{v}/players/{p}.
PlaybackRepository: Players and master output of the media server (02f §6).
PlaybackSnapshot: A player state with its freshness (02f §7.4: stale reads show asOf).
Player: Model Player (schemas/api/1.0/player.schema.json#/$defs/player).
PlayerHandle: One media player (main by default) of one venue.
PlayerMatrixCell: Model PlayerMatrixCell (schemas/api/1.0/player.schema.json#/$defs/matrixCell).
PlayerPage: Model PlayerPage (schemas/api/1.0/player.schema.json#/$defs/page).
PlayerPatch: PATCH /venues/{venueId}/players/{playerId} (merge-patch; playback is last-writer-wins, no If-Match).
PlayerState: Media player
PlayerStateTarget: Model PlayerStateTarget (schemas/api/1.0/player.schema.json#/$defs/player/properties/target).
PlayerStatus: Open string enumeration PlayerStatus; unknown values are preserved (isUnknown).
Playlist: Model Playlist (schemas/dome/1.1/dome.schema.json#/$defs/playlist).
PlaylistItem: x-screenberry: Screenberry item fields without a .dome equivalent, round-trip only (02d MD8).
PlaylistTarget: See PlayTarget.playlist.
PlayRequest: POST …/play: what to play (absent = resume the loaded source / startup) and when. at = scheduled start on the server clock (multi-node sync, 02d UC-K5).
PlayTarget: What to play (02f §6 PlayTarget).
PowerAccepted: Model PowerAccepted (schemas/api/1.0/system.schema.json#/$defs/powerAccepted).
PowerAcceptedAction: Open string enumeration PowerAcceptedAction; unknown values are preserved (isUnknown).
PowerRequest: POST /system/reboot and /system/shutdown body.
Principal: GET /auth/me: who is calling and what they may do.
PrincipalKind: Open string enumeration PrincipalKind; unknown values are preserved (isUnknown).
PrismGeometry: 1.1 (02b E4): physical prism / pyramid geometry (engine PrismGeometry).
Problem: Problem details
ProblemCode: Open string enumeration ProblemCode; unknown values are preserved (isUnknown).
ProblemFieldError: Model ProblemFieldError (schemas/common/1.0/problem.schema.json#/$defs/fieldError).
Projection: Open string enumeration Projection; unknown values are preserved (isUnknown).
ProtocolVersions: Versions implemented by this release of freedome_protocol.
PublishedPayload: Response of publishAppPayload and the data.resource of event app.payload.
RealtimeChannel: One open realtime session (any transport). Created by a RealtimeConnector.
RealtimeClosed: Why a realtime session ended.
RealtimeHello: What the client says when opening a realtime session (hello).
RealtimeResult: The result of a realtime call.
RefreshRequest: POST /auth/refresh.
ResolumeComposition: Summary of the open composition.
ResolumeConfig: config of the outbound Resolume Arena / Avenue driver (protocol resolume). Defaults are Resolume's own ports; they equal the media server's defaults, so on one machine move the media server (docs/audio-reactive.md).
ResolumeLink: Model ResolumeLink (schemas/api/1.0/gateway.schema.json#/$defs/resolumeLink).
ResolumeLinkState: for OSC over UDP, up means sending: there is no acknowledgement
ResolumeProduct: GET /api/v1/product of Resolume, when reachable.
ResolumeStatus: Model ResolumeStatus (schemas/api/1.0/gateway.schema.json#/$defs/resolumeStatus).
RestoreRequest: Model RestoreRequest (schemas/api/1.0/system.schema.json#/$defs/restoreRequest).
RestTransport: Model RestTransport (schemas/api/1.0/info.schema.json#/properties/transports/properties/rest).
Role: Role = scope bundle (02e §3.6). Open enum: clients map unknown roles to UNKNOWN.
RoomCorrection: Model RoomCorrection (schemas/dome/1.1/dome.schema.json#/$defs/audio/properties/roomCorrection).
RoomCorrectionKind: Open string enumeration RoomCorrectionKind; unknown values are preserved (isUnknown).
Scenario: Model Scenario (schemas/api/1.0/scenario.schema.json#/$defs/scenario).
ScenarioCapability: Open string enumeration ScenarioCapability; unknown values are preserved (isUnknown).
ScenarioLogEntry: Model ScenarioLogEntry (schemas/api/1.0/scenario-session.schema.json#/$defs/logEntry).
ScenarioLogEntryLevel: Open string enumeration ScenarioLogEntryLevel; unknown values are preserved (isUnknown).
ScenarioLogPage: Model ScenarioLogPage (schemas/api/1.0/scenario-session.schema.json#/$defs/logPage).
ScenarioPage: Model ScenarioPage (schemas/api/1.0/scenario.schema.json#/$defs/page).
ScenarioPatch: PATCH /scenarios/{scenarioId} (admin, UC-SC5).
ScenarioSession: Model ScenarioSession (schemas/api/1.0/scenario-session.schema.json#/$defs/session).
ScenarioSessionPage: Model ScenarioSessionPage (schemas/api/1.0/scenario-session.schema.json#/$defs/page).
ScenarioSessionStart: POST /venues/{venueId}/scenario-sessions (UC-SC2); params are validated against the scenario's paramsSchema (422).
ScenarioSessionStatus: Open string enumeration ScenarioSessionStatus; unknown values are preserved (isUnknown).
SchemaError: One validation error.
Scopes: Authorisation scopes of API v1 (02e §3.6) and the role bundles.
SeekRequest: POST …/seek: exactly one of position (s), marker (timeline marker id) or normalized (0..1).
SemVer: A major.minor.patch[-pre][+build] version as used by formatVersion and serverVersion.
ServerAuth: Model ServerAuth (schemas/api/1.0/info.schema.json#/properties/auth).
ServerHealth: GET /health and /ready (unversioned, anonymous).
ServerInfo: Server info
ServerProduct: Open string enumeration ServerProduct; unknown values are preserved (isUnknown).
ServerTransports: Model ServerTransports (schemas/api/1.0/info.schema.json#/properties/transports).
Session: The authenticated principal as the client sees it (the server still enforces every scope).
SessionRequest: POST /auth/session (local account).
SessionRevoked: session.revoked on auth/sessions.
Show: Playlists, timelines, matrix, cues, triggers, startup (01b §4.6).
ShowBody: Show content shared by GET / PUT / POST: the .dome show sections.
ShowInput: POST /shows and PUT /shows/{showId} body. Assets are referenced by .dome asset entries; an entry whose src is asset:<assetId> points to an asset already stored on the server.
ShowMatrix: Screenberry-style matrix (compatibility); cells reference row / column ids.
ShowPage: Model ShowPage (schemas/api/1.0/show.schema.json#/$defs/page).
ShowParts: Single show parts; writes send the show ETag (ifMatch, read first when not given) (/shows/{showId}/playlists|timelines|cues|triggers/{itemId}, /shows/{showId}/matrix).
ShowPatch: PATCH /shows/{showId} (application/merge-patch+json): any subset of the sections; arrays are replaced whole (RFC 7396).
ShowRef: Exactly one of playlist / timeline / matrix / asset id.
ShowResource: Model ShowResource (schemas/api/1.0/show.schema.json#/$defs/show).
ShowStatus: incomplete = referenced assets not ready yet
ShowSummary: Collection item: no assets / show body.
ShowTarget: See PlayTarget.show.
ShowWarning: Model ShowWarning (schemas/api/1.0/show.schema.json#/$defs/warning).
ShutterRequest: Open string enumeration ShutterRequest; unknown values are preserved (isUnknown).
SignedEntry: Model SignedEntry (schemas/dome/1.1/signature.schema.json#/properties/signedEntries/items).
SniffResult: What FormatSniffer.sniff detected.
SocketioCall: socket.io call payload = WS call data (02e §8.2).
SocketioTransport: Model SocketioTransport (schemas/api/1.0/info.schema.json#/properties/transports/properties/socketio).
SourcePosition: Interactive / realtime source position (spherical, listener at the dome centre).
Speaker: Model Speaker (schemas/dome/1.1/dome.schema.json#/$defs/speaker).
SpeakerKind: Open string enumeration SpeakerKind; unknown values are preserved (isUnknown).
StaticDiscovery: Saved / manually entered endpoints (always "found"; ids taken from the endpoints).
StereoEye: Open string enumeration StereoEye; unknown values are preserved (isUnknown).
StorageStats: GET /storage (replaces /api/v1/content/stats).
StoredTokens: Persisted tokens of one endpoint.
SystemConfig: Effective server configuration (TOML sections as JSON). Secret values are always returned as "" and a PUT that sends "" keeps the stored secret (redaction rule, 01a §3).
SystemConfigInput: PUT /system/config body (If-Match = config revision).
SystemStatus: System status
SystemStatusDisks: Model SystemStatusDisks (schemas/api/1.0/system.schema.json#/properties/disks/items).
SystemStatusHost: Model SystemStatusHost (schemas/api/1.0/system.schema.json#/properties/host).
SystemStatusHostArch: Open string enumeration SystemStatusHostArch; unknown values are preserved (isUnknown).
SystemStatusHostCpu: Model SystemStatusHostCpu (schemas/api/1.0/system.schema.json#/properties/host/properties/cpu).
SystemStatusHostGpus: Model SystemStatusHostGpus (schemas/api/1.0/system.schema.json#/properties/host/properties/gpus/items).
SystemStatusHostMemory: Model SystemStatusHostMemory (schemas/api/1.0/system.schema.json#/properties/host/properties/memory).
TestPattern: PUT /venues/{venueId}/displays/{displayId}/pattern body (engine freedome_pattern_*).
TestPatternKind: Open string enumeration TestPatternKind; unknown values are preserved (isUnknown).
TextureSource: A live source seen by the engine (GET /venues/{venueId}/texture-sources, event textureSource.state).
TextureSourcePage: Model TextureSourcePage (schemas/api/1.0/asset.schema.json#/$defs/textureSourcePage).
TextureSourceStatus: Open string enumeration TextureSourceStatus; unknown values are preserved (isUnknown).
TextureTransport: Shared GPU texture or spare network transport of a live source. Open list.
Timeline: Model Timeline (schemas/dome/1.1/dome.schema.json#/$defs/timeline).
TimelineClip: x-screenberry: Screenberry item fields without a .dome equivalent, round-trip only (02d MD8).
TimelineMarker: Model TimelineMarker (schemas/dome/1.1/dome.schema.json#/$defs/timeline/properties/markers/items).
TimelineMarkerKind: Open string enumeration TimelineMarkerKind; unknown values are preserved (isUnknown).
TimelineTrack: Model TimelineTrack (schemas/dome/1.1/dome.schema.json#/$defs/timeline/properties/tracks/items).
TimelineTrackKind: Open string enumeration TimelineTrackKind; unknown values are preserved (isUnknown).
TokenExchangeRequest: POST /auth/token-exchange: an L7 (freedome.nativemind.us) access JWT for a local session; linked installations only (JWKS of the cloud).
TokenSet: Model TokenSet (schemas/api/1.0/auth.schema.json#/$defs/tokens).
TokenStore: Token persistence port (02f §6; freedome_flutter binds flutter_secure_storage).
TopicSpec: One topic template of API v1 (02e §7.2), e.g. venues/{venueId}/players/{playerId}.
TopicTable: The topic templates of API v1 (02e §7.2), one tree for WS, socket.io, GraphQL and OSC.
Transition: Model Transition (schemas/dome/1.1/dome.schema.json#/$defs/transition).
TransitionKind: Open string enumeration TransitionKind; unknown values are preserved (isUnknown).
Trigger: Model Trigger (schemas/dome/1.1/dome.schema.json#/$defs/trigger).
TriggerSource: Open string enumeration TriggerSource; unknown values are preserved (isUnknown).
TypedEvent: A typed view of a FreedomeEvent; typedEvent builds one for every known kind.
UpdateRequest: Model UpdateRequest (schemas/api/1.0/system.schema.json#/$defs/updateRequest).
UpdateRequestChannel: Open string enumeration UpdateRequestChannel; unknown values are preserved (isUnknown).
UpdateStatus: Model UpdateStatus (schemas/api/1.0/system.schema.json#/$defs/updateStatus).
UpdateStatusStatus: Open string enumeration UpdateStatusStatus; unknown values are preserved (isUnknown).
UploadCapabilities: Informative mirror of the OPTIONS /uploads headers (Tus-Version, Tus-Extension, Tus-Max-Size, Tus-Checksum-Algorithm).
UploadCapabilitiesExtensions: Open string enumeration UploadCapabilitiesExtensions; unknown values are preserved (isUnknown).
UploadChanged: upload.progress on uploads/{u}.
UploadMetadata: Upload-Metadata (tus: comma-separated key base64(value) pairs), decoded.
UploadProgress: Progress of an upload.
UploadPurposeKind: Open string enumeration UploadPurposeKind; unknown values are preserved (isUnknown).
UploadResult: The result of a finished upload: the created asset (purpose asset) or just the upload id (other purposes).
UploadState: Open string enumeration UploadState; unknown values are preserved (isUnknown).
UploadStatus: Upload
UploadStatusLinks: Model UploadStatusLinks (schemas/api/1.0/upload.schema.json#/properties/links).
UploadTask: One resumable upload (02f §6 UploadTask).
User: User
UserInput: POST /users.
UserPage: Model UserPage (schemas/api/1.0/user.schema.json#/$defs/page).
UserPatch: PATCH /users/{userId} (merge-patch). Changing the password revokes the user's sessions.
UserUser: Model UserUser (schemas/api/1.0/user.schema.json#/$defs/user).
ValidationIssue: One validation finding.
Venue: Venue
VenueBody: Venue content shared by GET / PUT / POST: the .dome venue sections.
VenueChanged: venue.updated / venue.deleted / venue.activeShow on venues/{v}.
VenueInput: POST /venues and PUT /venues/{venueId} body.
VenueOutput: Venue output
VenueOutputPatch: PATCH body (application/merge-patch+json): any subset of the output fields.
VenueOutputPatchNdi: Model VenueOutputPatchNdi (schemas/api/1.0/output.schema.json#/$defs/patch/properties/ndi).
VenuePage: GET /venues page.
VenuesRepository: Venues of the media server: the dome geometry, displays, calibration and audio layout (.dome kind venue).
VenueStatus: Open string enumeration VenueStatus; unknown values are preserved (isUnknown).
VenueSummary: Model VenueSummary (schemas/api/1.0/info.schema.json#/properties/venues/items).
VenueVenue: Model VenueVenue (schemas/api/1.0/venue.schema.json#/$defs/venue).
Versioned<T>: A response body with its entity tag (ETag, derived from the resource revision, 02e §3.5).
ViewportMirror: Open string enumeration ViewportMirror; unknown values are preserved (isUnknown).
VisualDevice: Model VisualDevice (schemas/api/1.0/device.schema.json#/$defs/device).
VisualDevicePage: Model VisualDevicePage (schemas/api/1.0/device.schema.json#/$defs/page).
VisualDeviceState: Model VisualDeviceState (schemas/api/1.0/device.schema.json#/$defs/device/properties/state).
VisualDeviceStatePower: Open string enumeration VisualDeviceStatePower; unknown values are preserved (isUnknown).
WarpKind: Open string enumeration WarpKind; unknown values are preserved (isUnknown).
WarpMesh: A warp mesh: per display vertex the dome-UV coordinates (and an optional weight).
WarpMeshCodec: Reader / writer of FDMESH files.
WarpMeshRef: Model WarpMeshRef (schemas/dome/1.1/dome.schema.json#/$defs/displayCalibration/properties/warp).
WsBye: Model WsBye (schemas/api/1.0/ws-messages.schema.json#/$defs/byeData).
WsChannel: The freedome.v1 channel over a MessageSocket.
WsCloseCodes: WebSocket close codes used by the server (02e §8.1, byeData.code).
WsDeniedTopic: Model WsDeniedTopic (schemas/api/1.0/ws-messages.schema.json#/$defs/subscribeResult/properties/denied/items).
WsHello: Model WsHello (schemas/api/1.0/ws-messages.schema.json#/$defs/helloData).
WsMessage: One envelope message.
WsResult: Model WsResult (schemas/api/1.0/ws-messages.schema.json#/$defs/resultData).
WsResume: Model WsResume (schemas/api/1.0/ws-messages.schema.json#/$defs/helloData/properties/resume).
WsResync: Client must re-read state via REST / GraphQL for these topics.
WsResyncReason: Open string enumeration WsResyncReason; unknown values are preserved (isUnknown).
WsSubscribe: Model WsSubscribe (schemas/api/1.0/ws-messages.schema.json#/$defs/subscribeData).
WsSubscribeOptions: Model WsSubscribeOptions (schemas/api/1.0/ws-messages.schema.json#/$defs/subscribeData/properties/options).
WsSubscribeResult: result.body of subscribe / unsubscribe: accepted filters + denied ones with a problem (no leak of existence).
WsTransport: Model WsTransport (schemas/api/1.0/info.schema.json#/properties/transports/properties/ws).
WsUnsubscribe: Model WsUnsubscribe (schemas/api/1.0/ws-messages.schema.json#/$defs/unsubscribeData).
WsWelcome: Model WsWelcome (schemas/api/1.0/ws-messages.schema.json#/$defs/welcomeData).
ZelimBinaryCodec: Binary .zelim (variant B) reader / writer.
ZelimCodec: Either variant: sniff by content, then decode (a .zelim matching neither → unsupported-format).
ZelimElement: One element of a quantum scene (v2 model).
ZelimGroup: One interaction group (≤ 5 members).
ZelimJsonCodec: .zelim JSON project (variant J) reader / writer.
ZelimProject: A .zelim JSON project (variant J), kept as the parsed document (unknown keys preserved).
ZelimScene: A binary .zelim quantum scene (variant B) in the v2 model.
ZipDomeContainer: A container in a ZIP file.

Enums

ConnectionState: Connection states (02f §7.3).
DetectedFormat: A detected content format.
DiscoverySource: Where a DiscoveredDome came from.
FreedomeLogLevel: Severity of a FreedomeLogRecord.
RealtimeTransport: Which realtime transport the client uses (02f §6 FreedomeClientOptions.realtime).
UploadPurpose: What happens with a finished upload.
UploadTaskState: Lifecycle of an UploadTask.

Extensions

AudioMulti on AudioRepository: MULTI on the dome over contract v1 (preset + looping session).
TypedEventStream on Stream<FreedomeEvent>: client.events().typed<PlaybackChanged>() (02f §6.1).

Constants

bundledApiSchemas → const Map<String, String>: JSON Schema texts bundled for validation ($id → JSON; JsonSchemaRegistry.fromTexts).
bundledSchemas → const Map<String, String>: JSON Schema texts bundled for validation ($id → JSON; JsonSchemaRegistry.fromTexts).
domeMimeType → const String: MIME type of a packed .dome (01b §2).
domeSchemaJson → const String: The JSON Schema text this file was generated from (bundled for validators, 02f §12).
domeSchemaJsonId → const String: $id of the bundled schema domeSchemaJson.
domeStoredExtensions → const Set<String>: Extensions written stored (01b §2.1); everything else is deflated.
freedomeClientVersion → const String: Version of this package (sent in X-Freedome-Client and hello.sdk).
graphqlEventsSubscription → const String: The event subscription document (02e §6).
graphqlWsSubprotocol → const String: The graphql-transport-ws sub-protocol name.
maxUploadChunk → const int: Largest chunk the client sends (Cloudflare limit, 02e C12).
operationSchemas → const Map<String, OperationSchema>: Parameters, request bodies and responses of every media-server operation (contract OpenAPI).
wsSubprotocol → const String: The plain-WebSocket sub-protocol name.
zelimRootParent → const int: Parent id of a root element (v2; v1 elements are all roots).

Functions

audioSessionEnded(AudioSessionStatus status) → bool: Whether an audio session status is final.
decodeText(Uint8List b, String what) → String: Strict UTF-8 after stripping one leading BOM (02e §9.5); invalid → validation-failed pointer "".
domeEntryStored(String path) → bool: Whether path is written stored (media) rather than deflated.
fingerprintMatches(String fingerprint, String pin) → bool: Whether the SHA-256 fingerprint of a certificate (hex, colons allowed) matches pin (full value or a prefix of ≥ 16 hex digits, as in the mDNS TXT fp).
isImageName(String name) → bool: Whether name is an image entry of a legacy .comics.
isTerminal(JobStatus s) → bool: Whether s is a final job state.
jsonMergePatch(Object? target, Object? patch) → Object?: Applies an RFC 7396 JSON merge patch to target (returns a new value; target is not modified).
memorySocketPair({String? protocol}) → (MessageSocket, MessageSocket): A pair of connected in-memory sockets (client side, server side) — used by the in-process fake and tests.
multipart(List<MultipartPart> parts) → (String, Uint8List): Encodes parts as multipart/form-data; returns (content type, body).
rfc3339Millis(DateTime t) → String: RFC 3339 UTC with milliseconds, the contract timestamp form (2026-10-19T12:00:00.000Z, 02e §3.1).
samePin(String a, String b) → bool: Whether two pins (full fingerprints or ≥ 16-hex-digit prefixes) denote the same certificate.
sha256Hex(Stream<List<int>> data) → Future<String>: Hex SHA-256 of a stream (incremental, constant memory).
socketUri(FreedomeEndpoint endpoint, String path, [Map<String, String> query = const {}]) → Uri: ws(s)://host:port<path>?<query> for endpoint.
storedTokensOf(TokenSet t) → StoredTokens: StoredTokens of a server token set.
typedEvent(FreedomeEvent e) → TypedEvent: The typed view of e. A resource that does not decode yields a view with a null payload (never throws): realtime must not break on a newer server's representation.
uuidV7([DateTime? now]) → String: A new UUIDv7 (RFC 9562): 48-bit Unix milliseconds, version 7, variant 10, random rest; lowercase.
venueInputOf(DomeManifest m) → VenueInput: The venue sections of a .dome manifest as a PUT /venues/{id} body (02e §5.2: manifest without format / formatVersion / kind; x-* keys kept).

Typedefs

FileLookup = Future<Uint8List?> Function(String relativePath): Reads a file relative to an input's root (a directory form, or the directory of a single file); null = absent.
FreedomeLogger = void Function(FreedomeLogRecord record): Receives the SDK's log records (apps route them to their logger).
MessageSocketConnector = Future<MessageSocket> Function(FreedomeEndpoint endpoint, String path, {Map<String, String> headers, List<String> protocols, Map<String, String> query, Duration timeout}): Opens a MessageSocket to path (below the endpoint root, e.g. /api/v1/ws) with protocols.
RealtimeConnector = Future<RealtimeChannel> Function(RealtimeTransport kind, RealtimeHello hello, {required Duration heartbeat, required Duration timeout}): Opens realtime sessions to one endpoint.
RealtimeConnectorFactory = RealtimeConnector Function(FreedomeEndpoint endpoint, {FreedomeLogger? logger}): Builds a RealtimeConnector for an endpoint (used by the socket.io entry point).

Exceptions / Errors

ConflictException: 409 conflict / 412 precondition-failed: the resource changed; latest is the current server version when the client could fetch it.
ForbiddenException: 403 forbidden: the principal lacks scope.
FreedomeException: Base of every error thrown by freedome_client.
IncompatibleServerException: The server speaks no API major this client supports (02f §7.3 incompatible).
NetworkException: The server could not be reached / the connection failed.
NotFoundException: 404 not-found.
OfflineException: Live control attempted while the media server is unreachable (02f §7.4: fail fast, never queued).
PayloadTooLargeException: 413 payload-too-large: a size guard was hit (entries, manifest, ratio, total size).
QueuedForReplayException: An idempotent write could not reach the server and was queued in the app's OutboxStore (02f §7.4); it is replayed in order after the next resync — results arrive on FreedomeClient.outboxOutcomes.
RateLimitedException: 429 rate-limited.
RequestTimeoutException: A request did not complete within its timeout (02f §7.2: 10 s default).
ServerException: Any other server problem (5xx, engine-unavailable, unknown codes).
TlsPinMismatchException: The server's TLS certificate does not match the fingerprint pinned at pairing (02f §8.2, §17: hard error, re-pair).
UnauthorizedException: 401 unauthenticated: missing / expired / revoked credentials.
UnsupportedCapabilityException: The server does not offer a capability the call needs.
UnsupportedFormatException: 415 unsupported-format: not a .dome / unknown major version / unsupported ZIP feature.
ValidationException: 422 validation-failed (server) or a local validation failure (codecs): pointer is a JSON pointer / entry path, reason the rule; issues lists every finding when several were collected.

freedome_client library

Classes

Enums

Extensions

Constants

Functions

Typedefs

Exceptions / Errors

freedome_client package

freedome_client library