Source graphql/mediaserver.graphql + graphql/common.graphql. Endpoint /api/v1/graphql, subscriptions over graphql-ws.
| Field | Type | @auth scope | Description |
|---|---|---|---|
info | ServerInfo! | anon | |
health | Health! | anon | |
ready | Health! | anon | |
venues(first: Int, after: String) | VenueConnection! | info:read | |
venue(venueId: DocId!) | Venue | info:read | |
displays(venueId: DocId!, first: Int, after: String) | DisplayConnection! | info:read | |
display(venueId: DocId!, displayId: DocId!) | Display | info:read | |
output(venueId: DocId!) | Output | playback:read | |
calibration(venueId: DocId!) | JSON | info:read | |
calibrationJobs(venueId: DocId!, status: JobStatus, first: Int, after: String) | CalibrationJobConnection! | info:read | |
calibrationJob(venueId: DocId!, jobId: UUID!) | CalibrationJob | info:read | |
pairings(first: Int, after: String) | PairingConnection! | users:manage | |
pairing(pairingId: UUID!) | Pairing | anon | |
me | Principal | any | |
users(first: Int, after: String, q: String) | UserConnection! | users:manage | |
user(userId: UUID!) | User | users:manage | |
apiKeys(first: Int, after: String) | ApiKeyConnection! | keys:manage | |
apiKey(keyId: String!) | ApiKey | keys:manage | |
system | SystemStatus! | system:read | |
logs(first: Int, after: String, since: DateTime, level: LogLevel) | LogEntryConnection! | system:read | |
config | Config! | system:read | |
updateStatus | UpdateStatus! | system:read | |
nodes(first: Int, after: String) | NodeConnection! | info:read | |
node(nodeId: DocId!) | Node | info:read | |
shows(first: Int, after: String, q: String, tag: String, sort: String) | ShowSummaryConnection! | content:read | |
show(showId: DocId!) | Show | content:read | |
playlist(showId: DocId!, itemId: DocId!) | JSON | content:read | |
timeline(showId: DocId!, itemId: DocId!) | JSON | content:read | |
cue(showId: DocId!, itemId: DocId!) | JSON | content:read | |
trigger(showId: DocId!, itemId: DocId!) | JSON | content:read | |
matrix(showId: DocId!) | JSON | content:read | |
players(venueId: DocId!, first: Int, after: String) | PlayerConnection! | playback:read | |
player(venueId: DocId!, playerId: DocId!) | Player | playback:read | |
activeShow(venueId: DocId!) | ActiveShow | playback:read | |
parameters(venueId: DocId!, prefix: String, first: Int, after: String) | ParameterConnection! | playback:read | |
parameter(venueId: DocId!, path: String!) | Parameter | playback:read | |
upload(uploadId: UUID!) | Upload | content:write | |
assets(first: Int, after: String, type: AssetType, tag: String, status: AssetStatus, q: String, sort: String) | AssetConnection! | content:read | |
asset(assetId: DocId!) | Asset | content:read | |
storageStats | StorageStats! | content:read | |
audio(venueId: DocId!) | AudioState | playback:read | |
speakerLayout(venueId: DocId!) | JSON | info:read | |
audioZones(venueId: DocId!, first: Int, after: String) | AudioZoneConnection! | playback:read | |
audioZone(venueId: DocId!, zoneId: DocId!) | AudioZone | playback:read | |
audioDevices(venueId: DocId!, kind: String, first: Int, after: String) | AudioDeviceConnection! | playback:read | |
audioDevice(venueId: DocId!, deviceId: DocId!) | AudioDevice | playback:read | |
audioPresets(venueId: DocId!, kind: AudioPresetKind, first: Int, after: String) | AudioPresetSummaryConnection! | content:read | |
audioPreset(venueId: DocId!, presetId: DocId!) | AudioPreset | content:read | |
audioSessions(venueId: DocId!, first: Int, after: String) | AudioSessionConnection! | playback:read | |
audioSession(venueId: DocId!, sessionId: UUID!) | AudioSession | playback:read | |
generator(venueId: DocId!) | GeneratorState | playback:read | |
audioAnalysis(venueId: DocId!) | AudioAnalysisState | playback:read | |
audioReactive(venueId: DocId!) | AudioReactiveState | playback:read | |
audioReactiveScenes(venueId: DocId!, first: Int, after: String) | AudioReactiveSceneConnection! | content:read | |
audioReactiveScene(venueId: DocId!, sceneId: DocId!) | AudioReactiveScene | content:read | |
textureSources(venueId: DocId!, first: Int, after: String) | TextureSourceConnection! | playback:read | |
engines(first: Int, after: String) | EngineConnection! | info:read | |
engine(name: String!) | Engine | info:read | |
gateways(first: Int, after: String) | GatewayConnection! | gateways:manage | |
gateway(gatewayId: DocId!) | Gateway | gateways:manage | |
clients(first: Int, after: String) | ClientConnection! | system:read | |
events(topics: [String!]!, sinceSeq: Int, first: Int, after: String) | EventConnection! | events:subscribe | |
scenarios(first: Int, after: String) | ScenarioConnection! | content:read | |
scenario(scenarioId: String!) | Scenario | content:read | |
scenarioSessions(venueId: DocId!, first: Int, after: String) | ScenarioSessionConnection! | playback:read | |
scenarioSession(venueId: DocId!, sessionId: UUID!) | ScenarioSession | playback:read | |
scenarioSessionLog(venueId: DocId!, sessionId: UUID!, first: Int, after: String) | ScenarioLogEntryConnection! | playback:read | |
devices(first: Int, after: String) | DeviceConnection! | info:read | |
device(deviceId: DocId!) | Device | info:read | |
jobs(first: Int, after: String, kind: String, status: JobStatus) | JobConnection! | any | |
job(jobId: UUID!) | Job | any |
| Field | Type | @auth scope | Description |
|---|---|---|---|
createVenue(venue: JSON!) | Venue! | venues:write | |
putVenue(venueId: DocId!, venue: JSON!, ifMatch: Int, createOnly: Boolean) | Venue! | venues:write | |
patchVenue(venueId: DocId!, patch: JSON!, ifMatch: Int!) | Venue! | venues:write | |
deleteVenue(venueId: DocId!, ifMatch: Int!) | Boolean! | venues:write | |
activateVenue(venueId: DocId!) | Venue! | venues:write | |
patchDisplay(venueId: DocId!, displayId: DocId!, patch: JSON!, ifMatch: Int!) | Display! | venues:write | |
identifyDisplay(venueId: DocId!, displayId: DocId!, durationS: Float) | Boolean! | displays:control | |
setTestPattern(venueId: DocId!, displayId: DocId!, pattern: TestPatternInput!) | DisplayState! | displays:control | |
setDisplayPower(venueId: DocId!, displayId: DocId!, input: DisplayPowerInput!) | DisplayState! | displays:control | |
patchOutput(venueId: DocId!, patch: OutputPatch!) | Output! | playback:control | |
startCalibrationJob(venueId: DocId!, input: CalibrationJobInput!) | CalibrationJob! | calibration:run | |
submitCalibrationCapture(venueId: DocId!, jobId: UUID!, input: CalibrationCaptureInput!) | CalibrationJob! | calibration:run | |
applyCalibrationJob(venueId: DocId!, jobId: UUID!) | CalibrationJob! | calibration:run | |
cancelCalibrationJob(venueId: DocId!, jobId: UUID!) | CalibrationJob! | calibration:run | |
createSession(input: SessionInput!) | Tokens! | anon | |
deleteSession | Boolean! | any | |
refreshSession(refreshToken: String!) | Tokens! | anon | |
exchangeCloudToken(subjectToken: String!, client: ClientInfoInput) | Tokens! | anon | |
createPairing(input: PairingInput!) | Pairing! | anon | |
approvePairing(pairingId: UUID!, input: PairingApprovalInput) | Pairing! | users:manage | |
createUser(input: UserInput!) | User! | users:manage | |
patchUser(userId: UUID!, patch: UserPatch!, ifMatch: Int!) | User! | users:manage | |
deleteUser(userId: UUID!, ifMatch: Int!) | Boolean! | users:manage | |
createApiKey(input: ApiKeyInput!) | ApiKeyCreated! | keys:manage | |
deleteApiKey(keyId: String!) | Boolean! | keys:manage | |
clearLogs | Boolean! | system:admin | |
putConfig(values: JSON!, ifMatch: Int!) | Config! | system:admin | |
runDiagnostics(checks: [String!]) | Job! | system:read | |
createBackup(include: [String!], note: String) | Job! | system:admin | |
restoreBackup(uploadId: UUID!, confirm: Boolean!) | Job! | system:admin | |
startUpdate(input: UpdateInput) | Job! | system:admin | |
rebootSystem(input: PowerInput!) | PowerAccepted! | system:admin | |
shutdownSystem(input: PowerInput!) | PowerAccepted! | system:admin | |
createShow(show: JSON!) | Show! | content:write | |
putShow(showId: DocId!, show: JSON!, ifMatch: Int, createOnly: Boolean) | Show! | content:write | |
patchShow(showId: DocId!, patch: JSON!, ifMatch: Int!) | Show! | content:write | |
deleteShow(showId: DocId!, ifMatch: Int!) | Boolean! | content:write | |
putPlaylist(showId: DocId!, itemId: DocId!, playlist: JSON!, ifMatch: Int!) | JSON! | content:write | |
deletePlaylist(showId: DocId!, itemId: DocId!, ifMatch: Int!) | Boolean! | content:write | |
putTimeline(showId: DocId!, itemId: DocId!, timeline: JSON!, ifMatch: Int!) | JSON! | content:write | |
deleteTimeline(showId: DocId!, itemId: DocId!, ifMatch: Int!) | Boolean! | content:write | |
putCue(showId: DocId!, itemId: DocId!, cue: JSON!, ifMatch: Int!) | JSON! | content:write | |
deleteCue(showId: DocId!, itemId: DocId!, ifMatch: Int!) | Boolean! | content:write | |
putTrigger(showId: DocId!, itemId: DocId!, trigger: JSON!, ifMatch: Int!) | JSON! | content:write | |
deleteTrigger(showId: DocId!, itemId: DocId!, ifMatch: Int!) | Boolean! | content:write | |
putMatrix(showId: DocId!, matrix: JSON!, ifMatch: Int!) | JSON! | content:write | |
startImport(input: ImportInput!) | Job! | content:write | |
patchPlayer(venueId: DocId!, playerId: DocId!, patch: PlayerPatch!) | Player! | playback:control | |
play(venueId: DocId!, playerId: DocId!, input: PlayInput) | Player! | playback:control | |
pause(venueId: DocId!, playerId: DocId!) | Player! | playback:control | |
resume(venueId: DocId!, playerId: DocId!) | Player! | playback:control | |
stop(venueId: DocId!, playerId: DocId!) | Player! | playback:control | |
next(venueId: DocId!, playerId: DocId!) | Player! | playback:control | |
previous(venueId: DocId!, playerId: DocId!) | Player! | playback:control | |
seek(venueId: DocId!, playerId: DocId!, input: SeekInput!) | Player! | playback:control | |
fireCue(venueId: DocId!, cueId: DocId!, showId: DocId) | CueFired! | playback:control | |
setActiveShow(venueId: DocId!, showId: DocId, autoplay: Boolean) | ActiveShow! | playback:control | |
setParameter(venueId: DocId!, path: String!, value: JSON!, fadeSec: Float) | Parameter! | playback:control | |
createAsset(input: AssetInput!) | Asset! | content:write | |
patchAsset(assetId: DocId!, patch: AssetPatch!, ifMatch: Int!) | Asset! | content:write | |
deleteAsset(assetId: DocId!, ifMatch: Int!, force: Boolean) | Boolean! | content:write | |
patchAudio(venueId: DocId!, patch: AudioPatch!) | AudioState! | audio:control | |
putSpeakerLayout(venueId: DocId!, layout: JSON!, ifMatch: Int!) | JSON! | venues:write | |
putAudioZone(venueId: DocId!, zoneId: DocId!, input: AudioZoneInput!, ifMatch: Int, createOnly: Boolean) | AudioZone! | audio:control | |
patchAudioZone(venueId: DocId!, zoneId: DocId!, patch: AudioZonePatch!) | AudioZone! | audio:control | |
deleteAudioZone(venueId: DocId!, zoneId: DocId!, ifMatch: Int!) | Boolean! | audio:control | |
patchAudioDevice(venueId: DocId!, deviceId: DocId!, patch: AudioDevicePatch!) | AudioDevice! | audio:control | |
testAudioDevice(venueId: DocId!, deviceId: DocId!, input: AudioDeviceTestInput) | AudioDeviceTestResult! | audio:control | |
putAudioPreset(venueId: DocId!, presetId: DocId!, kind: AudioPresetKind!, document: JSON!, ifMatch: Int, createOnly: Boolean) | AudioPreset! | content:write | |
deleteAudioPreset(venueId: DocId!, presetId: DocId!, ifMatch: Int!) | Boolean! | content:write | |
startAudioSession(venueId: DocId!, input: AudioSessionInput!) | AudioSession! | audio:control | |
stopAudioSession(venueId: DocId!, sessionId: UUID!) | Boolean! | audio:control | |
setGenerator(venueId: DocId!, input: GeneratorInput!) | GeneratorState! | audio:control | |
stopGenerator(venueId: DocId!) | Boolean! | audio:control | |
setAudioAnalysis(venueId: DocId!, input: AudioAnalysisInput!) | AudioAnalysisState! | audio:control | |
patchAudioReactive(venueId: DocId!, patch: AudioReactivePatch!) | AudioReactiveState! | playback:control | |
putAudioReactiveScene(venueId: DocId!, sceneId: DocId!, input: AudioReactiveSceneInput!, ifMatch: Int, createOnly: Boolean) | AudioReactiveScene! | content:write | |
deleteAudioReactiveScene(venueId: DocId!, sceneId: DocId!, ifMatch: Int!) | Boolean! | content:write | |
setSourcePosition(venueId: DocId!, sourceId: DocId!, input: SourcePositionInput!) | Boolean! | audio:control | |
setComputeBackend(backend: String!) | Engine! | system:admin | |
restartEngine(name: String!) | Job! | system:admin | |
patchGateway(gatewayId: DocId!, patch: GatewayPatch!, ifMatch: Int!) | Gateway! | gateways:manage | |
testGateway(gatewayId: DocId!) | GatewayTestResult! | gateways:manage | |
sendOsc(input: SendOscInput!) | Boolean! | gateways:manage | |
publishAppPayload(app: String!, input: AppPayloadInput!) | AppPayload! | apps:publish | |
clearAppPayloads(app: String!) | Boolean! | apps:publish | |
registerClient(input: ClientInput!) | Client! | any | |
unregisterClient(clientId: UUID!) | Boolean! | any | |
postClientTelemetry(clientId: UUID!, samples: [TelemetrySampleInput!]!) | Boolean! | any | |
patchScenario(scenarioId: String!, enabled: Boolean!) | Scenario! | system:admin | |
startScenarioSession(venueId: DocId!, input: ScenarioSessionInput!) | ScenarioSession! | playback:control | |
pauseScenarioSession(venueId: DocId!, sessionId: UUID!) | ScenarioSession! | playback:control | |
resumeScenarioSession(venueId: DocId!, sessionId: UUID!) | ScenarioSession! | playback:control | |
stopScenarioSession(venueId: DocId!, sessionId: UUID!) | ScenarioSession! | playback:control | |
beginDevicePairing(deviceId: DocId!) | DevicePairingStarted! | venues:write | |
confirmDevicePairing(deviceId: DocId!, code: String!) | Device! | venues:write | |
unpairDevice(deviceId: DocId!) | Boolean! | venues:write | |
bindDevice(deviceId: DocId!, displayId: DocId, ifMatch: Int!) | Device! | venues:write | |
cancelJob(jobId: UUID!) | Job! | any |
| Field | Type | @auth scope | Description |
|---|---|---|---|
events(topics: [String!]!, sinceSeq: Int) | Event! | events:subscribe | |
systemHealth | Health! | info:read | |
engineChanged(name: String) | Engine! | info:read | name = `visual` also matches node-qualified engines `visual@<node>` (prefix before `@`); absent = all engines |
nodeChanged(nodeId: DocId) | Node! | info:read | |
venueChanged(venueId: DocId!) | Venue! | info:read | |
outputChanged(venueId: DocId!) | Output! | playback:read | |
playerChanged(venueId: DocId!, playerId: DocId!) | Player! | playback:read | |
playerPosition(venueId: DocId!, playerId: DocId!, hz: Float) | PlayerPosition! | playback:read | |
cueFired(venueId: DocId!) | CueFired! | playback:read | |
parameterChanged(venueId: DocId!, prefix: String) | Parameter! | playback:read | |
displayChanged(venueId: DocId!, displayId: DocId) | Display! | info:read | |
calibrationJobChanged(jobId: UUID!) | CalibrationJob! | info:read | |
audioChanged(venueId: DocId!) | AudioState! | playback:read | |
audioSessionChanged(venueId: DocId!, sessionId: UUID) | AudioSession! | playback:read | |
scenarioSessionChanged(venueId: DocId!, sessionId: UUID) | ScenarioSession! | playback:read | |
showChanged(showId: DocId) | Event! | content:read | |
assetChanged(assetId: DocId) | Asset! | content:read | |
uploadProgress(uploadId: UUID!) | Upload! | content:write | |
jobChanged(jobId: UUID!) | Job! | any | |
gatewayChanged(gatewayId: DocId) | Gateway! | gateways:manage | |
appPayload(app: String!) | AppPayload! | info:read | |
clientCommand(clientId: UUID!) | ClientCommand! | any | |
deviceChanged(deviceId: DocId) | Device! | info:read |
| Field | Type | @auth | Description |
|---|---|---|---|
venueId | DocId! | ||
showId | DocId | ||
warnings | [ShowWarning!] |
| Field | Type | @auth | Description |
|---|---|---|---|
id | String! | ||
name | String! | ||
role | Role! | ||
scopes | [String!]! | ||
prefix | String | ||
createdBy | String | ||
createdAt | DateTime! | ||
expiresAt | DateTime | ||
lastUsedAt | DateTime | ||
revokedAt | DateTime |
| Field | Type | @auth | Description |
|---|---|---|---|
edges | [ApiKeyEdge!]! | ||
nodes | [ApiKey!]! | ||
pageInfo | PageInfo! |
| Field | Type | @auth | Description |
|---|---|---|---|
key | ApiKey! | ||
token | String! | fdk_ token — returned only here, once. |
| Field | Type | @auth | Description |
|---|---|---|---|
cursor | String! | ||
node | ApiKey! |
| Field | Type | @auth | Description |
|---|---|---|---|
name | String! | ||
role | Role! | ||
scopes | [String!] | ||
expiresAt | DateTime |
| Field | Type | @auth | Description |
|---|---|---|---|
id | UUID! | ||
app | String! | ||
kind | String! | ||
schema | String | ||
data | JSON | ||
publishedBy | String | ||
expiresAt | DateTime! |
| Field | Type | @auth | Description |
|---|---|---|---|
kind | String! | ||
schema | String | ||
data | JSON! | ||
ttlSec | Int | ||
venueId | DocId | ||
playerId | DocId |
| Field | Type | @auth | Description |
|---|---|---|---|
id | DocId! | ||
name | String! | ||
type | AssetType! | ||
src | String | ||
texture | JSON | stream assets fed by a live source (asset.schema.json #/$defs/texture) | |
mediaType | String | ||
sha256 | String | ||
size | Float | ||
status | AssetStatus! | ||
problem | Problem | ||
progress | Float | ||
mapping | JSON | dome/1.1 #/$defs/mapping | |
media | JSON | probe data (asset.schema.json #/$defs/media) | |
thumbnails | [Thumbnail!] | ||
tags | [String!] | ||
usedBy | [DocId!] | ||
revision | Int! | ||
createdAt | DateTime! | ||
updatedAt | DateTime | ||
contentUrl | String! | REST URL of the content (Range, ETag = sha256) |
| Field | Type | @auth | Description |
|---|---|---|---|
edges | [AssetEdge!]! | ||
nodes | [Asset!]! | ||
pageInfo | PageInfo! |
| Field | Type | @auth | Description |
|---|---|---|---|
cursor | String! | ||
node | Asset! |
| Field | Type | @auth | Description |
|---|---|---|---|
uploadId | UUID | ||
url | String | ||
fallbackUrl | String | ||
id | DocId | ||
name | String | ||
type | AssetType | ||
mapping | JSON | ||
tags | [String!] | ||
sha256 | String |
| Field | Type | @auth | Description |
|---|---|---|---|
name | String | ||
type | AssetType | ||
mapping | JSON | ||
tags | [String!] |
UPLOADING PROCESSING READY FAILED UNKNOWN
VIDEO IMAGE AUDIO ZELIM BORANKO COMICS REALTIME STREAM DOME OTHER UNKNOWN
| Field | Type | @auth | Description |
|---|---|---|---|
enabled | Boolean! | ||
inputs | JSON! | audio-reactive.schema.json #/$defs/input |
| Field | Type | @auth | Description |
|---|---|---|---|
venueId | DocId! | ||
enabled | Boolean! | ||
status | String! | ||
problem | Problem | ||
engine | String | ||
sampleRate | Int | ||
blockSize | Int | ||
inputs | JSON! | audio-reactive.schema.json #/$defs/input |
| Field | Type | @auth | Description |
|---|---|---|---|
id | DocId! | ||
kind | String! | ||
name | String | ||
config | JSON | ||
state | JSON! |
| Field | Type | @auth | Description |
|---|---|---|---|
edges | [AudioDeviceEdge!]! | ||
nodes | [AudioDevice!]! | ||
pageInfo | PageInfo! |
| Field | Type | @auth | Description |
|---|---|---|---|
cursor | String! | ||
node | AudioDevice! |
| Field | Type | @auth | Description |
|---|---|---|---|
name | String | ||
gainDb | Float | ||
mute | Boolean | ||
config | JSON |
| Field | Type | @auth | Description |
|---|---|---|---|
kind | String | ||
frequencyHz | Float | ||
gainDb | Float | ||
durationS | Float |
| Field | Type | @auth | Description |
|---|---|---|---|
deviceId | DocId! | ||
ok | Boolean! | ||
latencyMs | Float | ||
detail | String | ||
problem | Problem |
| Field | Type | @auth | Description |
|---|---|---|---|
status | String! | ||
version | String |
DIGITAL HYBRID COMBINED UNKNOWN
| Field | Type | @auth | Description |
|---|---|---|---|
mode | AudioMode | ||
masterGainDb | Float | ||
mute | Boolean |
| Field | Type | @auth | Description |
|---|---|---|---|
id | DocId! | ||
kind | AudioPresetKind! | ||
title | JSON | ||
revision | Int! | ||
document | JSON! | ananta/1.0 programme | pattern | session document | |
sha256 | String | ||
updatedAt | DateTime |
PROGRAMME PATTERN SESSION UNKNOWN
| Field | Type | @auth | Description |
|---|---|---|---|
id | DocId! | ||
kind | AudioPresetKind! | ||
title | JSON | ||
revision | Int! |
| Field | Type | @auth | Description |
|---|---|---|---|
edges | [AudioPresetSummaryEdge!]! | ||
nodes | [AudioPresetSummary!]! | ||
pageInfo | PageInfo! |
| Field | Type | @auth | Description |
|---|---|---|---|
cursor | String! | ||
node | AudioPresetSummary! |
| Field | Type | @auth | Description |
|---|---|---|---|
enabled | Boolean | ||
activeSceneId | DocId | ||
intensity | Float |
| Field | Type | @auth | Description |
|---|---|---|---|
id | DocId! | ||
title | JSON! | ||
description | JSON | ||
revision | Int! | ||
mappings | JSON! | audio-reactive.schema.json #/$defs/mapping |
| Field | Type | @auth | Description |
|---|---|---|---|
edges | [AudioReactiveSceneEdge!]! | ||
nodes | [AudioReactiveScene!]! | ||
pageInfo | PageInfo! |
| Field | Type | @auth | Description |
|---|---|---|---|
cursor | String! | ||
node | AudioReactiveScene! |
| Field | Type | @auth | Description |
|---|---|---|---|
title | JSON! | ||
description | JSON | ||
mappings | JSON! |
| Field | Type | @auth | Description |
|---|---|---|---|
venueId | DocId! | ||
enabled | Boolean! | ||
status | String! | ||
problem | Problem | ||
activeSceneId | DocId | ||
intensity | Float! | ||
stats | JSON | ||
resolume | JSON | gateway.schema.json #/$defs/resolumeStatus |
| Field | Type | @auth | Description |
|---|---|---|---|
id | UUID! | ||
venueId | DocId! | ||
presetId | DocId! | ||
status | SessionStatus! | ||
engines | [String!] | ||
position | Float | ||
duration | Float | ||
itemIndex | Int | ||
targets | AudioTargets | ||
problem | Problem | ||
startedAt | DateTime! | ||
endedAt | DateTime |
| Field | Type | @auth | Description |
|---|---|---|---|
edges | [AudioSessionEdge!]! | ||
nodes | [AudioSession!]! | ||
pageInfo | PageInfo! |
| Field | Type | @auth | Description |
|---|---|---|---|
cursor | String! | ||
node | AudioSession! |
| Field | Type | @auth | Description |
|---|---|---|---|
presetId | DocId! | ||
gainDb | Float | ||
targets | AudioTargetsInput | ||
at | DateTime | ||
loop | Boolean |
| Field | Type | @auth | Description |
|---|---|---|---|
venueId | DocId! | ||
mode | AudioMode! | ||
masterGainDb | Float! | ||
mute | Boolean! | ||
anantasound | AudioEngineRef | ||
anantadigital | AudioEngineRef | ||
layoutRevision | Int | ||
revision | Int! |
| Field | Type | @auth | Description |
|---|---|---|---|
devices | [DocId!] | ||
zones | [DocId!] | ||
speakers | [DocId!] |
| Field | Type | @auth | Description |
|---|---|---|---|
devices | [DocId!] | ||
zones | [DocId!] | ||
speakers | [DocId!] |
| Field | Type | @auth | Description |
|---|---|---|---|
id | DocId! | ||
name | String | ||
speakers | [DocId!]! | ||
gainDb | Float! | ||
delayMs | Float | ||
eq | [EqBand!] | ||
mute | Boolean! | ||
revision | Int! |
| Field | Type | @auth | Description |
|---|---|---|---|
edges | [AudioZoneEdge!]! | ||
nodes | [AudioZone!]! | ||
pageInfo | PageInfo! |
| Field | Type | @auth | Description |
|---|---|---|---|
cursor | String! | ||
node | AudioZone! |
| Field | Type | @auth | Description |
|---|---|---|---|
name | String | ||
speakers | [DocId!]! | ||
gainDb | Float | ||
delayMs | Float | ||
eq | [EqBandInput!] | ||
mute | Boolean |
| Field | Type | @auth | Description |
|---|---|---|---|
name | String | ||
speakers | [DocId!] | ||
gainDb | Float | ||
delayMs | Float | ||
eq | [EqBandInput!] | ||
mute | Boolean |
The `Boolean` scalar type represents `true` or `false`.
| Field | Type | @auth | Description |
|---|---|---|---|
uploadId | UUID! | ||
stepId | DocId |
| Field | Type | @auth | Description |
|---|---|---|---|
id | UUID! | ||
venueId | DocId! | ||
kind | String! | ||
status | JobStatus! | ||
progress | Float | ||
displays | [DocId!] | ||
speakers | [DocId!] | ||
steps | JSON | ||
currentStep | String | ||
awaiting | JSON | ||
errors | JSON | ||
result | JSON | ||
problem | Problem | ||
createdAt | DateTime! | ||
updatedAt | DateTime |
| Field | Type | @auth | Description |
|---|---|---|---|
edges | [CalibrationJobEdge!]! | ||
nodes | [CalibrationJob!]! | ||
pageInfo | PageInfo! |
| Field | Type | @auth | Description |
|---|---|---|---|
cursor | String! | ||
node | CalibrationJob! |
| Field | Type | @auth | Description |
|---|---|---|---|
kind | String! | ||
displays | [DocId!] | ||
speakers | [DocId!] | ||
options | JSON |
| Field | Type | @auth | Description |
|---|---|---|---|
id | UUID! | ||
app | String! | ||
appVersion | String | ||
deviceName | String! | ||
platform | String | ||
capabilities | [String!]! | ||
principal | String | ||
commandsTopic | String | ||
registeredAt | DateTime! | ||
lastSeen | DateTime |
| Field | Type | @auth | Description |
|---|---|---|---|
command | String! | ||
params | JSON | ||
expiresAt | DateTime |
| Field | Type | @auth | Description |
|---|---|---|---|
edges | [ClientEdge!]! | ||
nodes | [Client!]! | ||
pageInfo | PageInfo! |
| Field | Type | @auth | Description |
|---|---|---|---|
cursor | String! | ||
node | Client! |
| Field | Type | @auth | Description |
|---|---|---|---|
app | String | ||
appVersion | String | ||
deviceName | String |
| Field | Type | @auth | Description |
|---|---|---|---|
app | String! | ||
appVersion | String | ||
deviceName | String! | ||
platform | String | ||
capabilities | [String!] |
| Field | Type | @auth | Description |
|---|---|---|---|
source | String! | ||
offsetMs | Float | ||
jitterMs | Float | ||
masterId | String | ||
locked | Boolean! |
Effective configuration; secrets are always "***".
| Field | Type | @auth | Description |
|---|---|---|---|
revision | Int! | ||
values | JSON! | ||
redacted | [String!] | ||
restartRequired | [String!] |
| Field | Type | @auth | Description |
|---|---|---|---|
count | Int! | ||
bytes | Float! |
| Field | Type | @auth | Description |
|---|---|---|---|
do | String! | ||
status | String! | ||
problem | Problem |
| Field | Type | @auth | Description |
|---|---|---|---|
cueId | DocId! | ||
showId | DocId! | ||
firedAt | DateTime! | ||
actions | [CueActionResult!] |
RFC 3339 UTC timestamp with milliseconds, e.g. 2026-10-19T12:00:00.000Z.
| Field | Type | @auth | Description |
|---|---|---|---|
id | DocId! | ||
serial | String | ||
product | String | ||
variant | String! | ||
hwRevision | String | ||
agentVersion | String | ||
protocolVersion | String | ||
capabilities | [String!] | ||
address | String! | ||
paired | Boolean! | ||
displayId | DocId | ||
state | JSON! |
| Field | Type | @auth | Description |
|---|---|---|---|
edges | [DeviceEdge!]! | ||
nodes | [Device!]! | ||
pageInfo | PageInfo! |
| Field | Type | @auth | Description |
|---|---|---|---|
cursor | String! | ||
node | Device! |
| Field | Type | @auth | Description |
|---|---|---|---|
deviceId | DocId! | ||
expiresAt | DateTime! | ||
codeLength | Int |
| Field | Type | @auth | Description |
|---|---|---|---|
id | DocId! | ||
venueId | DocId! | ||
revision | Int! | ||
config | JSON! | the .dome display entry (dome/1.1 #/$defs/display) | |
state | DisplayState! |
| Field | Type | @auth | Description |
|---|---|---|---|
edges | [DisplayEdge!]! | ||
nodes | [Display!]! | ||
pageInfo | PageInfo! |
| Field | Type | @auth | Description |
|---|---|---|---|
cursor | String! | ||
node | Display! |
| Field | Type | @auth | Description |
|---|---|---|---|
on | Boolean | ||
shutter | String |
| Field | Type | @auth | Description |
|---|---|---|---|
online | Boolean! | ||
power | String | ||
shutter | String | ||
signal | Boolean | ||
temperatureC | Float | ||
pattern | JSON | display/#/$defs/testPattern or null | |
lastSeen | DateTime | ||
capabilities | [String!] | ||
faults | [String!] |
Document-scoped id ^[A-Za-z0-9._-]{1,64}$ (.dome ids, aliases default / main).
| Field | Type | @auth | Description |
|---|---|---|---|
name | String! | ||
status | EngineStatus! | ||
version | String | ||
protocol | String | ||
endpoint | String | ||
nodes | [DocId!] | ||
backend | String | ||
backends | [String!] | ||
capabilities | JSON | ||
metrics | JSON | ||
problem | Problem | ||
since | DateTime |
| Field | Type | @auth | Description |
|---|---|---|---|
edges | [EngineEdge!]! | ||
nodes | [Engine!]! | ||
pageInfo | PageInfo! |
| Field | Type | @auth | Description |
|---|---|---|---|
cursor | String! | ||
node | Engine! |
UP DEGRADED DOWN INCOMPATIBLE UNKNOWN
| Field | Type | @auth | Description |
|---|---|---|---|
type | String! | ||
frequencyHz | Float! | ||
gainDb | Float | ||
q | Float | ||
enabled | Boolean |
| Field | Type | @auth | Description |
|---|---|---|---|
type | String! | ||
frequencyHz | Float! | ||
gainDb | Float | ||
q | Float | ||
enabled | Boolean |
Event envelope (02e §7.1): `data` is the event-kinds payload (resource / patch / revision).
| Field | Type | @auth | Description |
|---|---|---|---|
id | UUID! | ||
seq | Int! | ||
topic | String! | ||
kind | String! | ||
ts | DateTime! | ||
data | JSON! |
| Field | Type | @auth | Description |
|---|---|---|---|
nodes | [Event!]! | ||
pageInfo | PageInfo! | ||
lastSeq | Int | Highest seq delivered in this page. | |
resync | Boolean! | True when the requested sinceSeq is older than the ring buffer: re-read state. |
The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).
| Field | Type | @auth | Description |
|---|---|---|---|
id | DocId! | ||
name | String | ||
direction | GatewayDirection! | ||
protocol | String! | ||
vendor | String | ||
enabled | Boolean! | ||
status | String! | ||
docsOnly | Boolean | ||
listeners | JSON | ||
peers | JSON | ||
config | JSON | ||
allowCidrs | [String!] | ||
problem | Problem | ||
stats | JSON | ||
resolume | JSON | protocol resolume: gateway.schema.json #/$defs/resolumeStatus |
| Field | Type | @auth | Description |
|---|---|---|---|
edges | [GatewayEdge!]! | ||
nodes | [Gateway!]! | ||
pageInfo | PageInfo! |
INBOUND OUTBOUND CONVERTER UNKNOWN
| Field | Type | @auth | Description |
|---|---|---|---|
cursor | String! | ||
node | Gateway! |
| Field | Type | @auth | Description |
|---|---|---|---|
enabled | Boolean | ||
config | JSON | ||
allowCidrs | [String!] |
| Field | Type | @auth | Description |
|---|---|---|---|
gatewayId | DocId! | ||
ok | Boolean! | ||
latencyMs | Float | ||
remoteVersion | String | ||
detail | String | ||
problem | Problem |
| Field | Type | @auth | Description |
|---|---|---|---|
signal | String! | ||
frequencies | [Float!] | ||
gainDb | Float | ||
durationS | Float | ||
targets | AudioTargetsInput |
| Field | Type | @auth | Description |
|---|---|---|---|
signal | String! | ||
frequencies | [Float!] | ||
gainDb | Float | ||
durationS | Float | ||
targets | AudioTargets |
| Field | Type | @auth | Description |
|---|---|---|---|
running | Boolean! | ||
settings | GeneratorSettings | ||
startedAt | DateTime |
| Field | Type | @auth | Description |
|---|---|---|---|
status | HealthStatus! | ||
checks | JSON |
OK DEGRADED DOWN UNKNOWN
| Field | Type | @auth | Description |
|---|---|---|---|
uploadId | UUID | ||
url | String | ||
assetId | DocId | ||
format | String! | ||
target | ImportTargetInput | ||
options | JSON |
| Field | Type | @auth | Description |
|---|---|---|---|
kind | String | ||
id | DocId | ||
replace | Boolean | ||
activate | Boolean |
The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Long-running operation (schemas/api/1.0/job.schema.json).
| Field | Type | @auth | Description |
|---|---|---|---|
id | UUID! | ||
kind | String! | ||
status | JobStatus! | ||
progress | Float | ||
message | String | ||
createdAt | DateTime! | ||
updatedAt | DateTime | ||
finishedAt | DateTime | ||
result | JSON | ||
problem | Problem | ||
links | JSON |
| Field | Type | @auth | Description |
|---|---|---|---|
edges | [JobEdge!]! | ||
nodes | [Job!]! | ||
pageInfo | PageInfo! |
| Field | Type | @auth | Description |
|---|---|---|---|
cursor | String! | ||
node | Job! |
QUEUED RUNNING AWAITING_INPUT SUCCEEDED FAILED CANCELLED UNKNOWN
Any JSON value; the field description names the JSON Schema it is validated against.
| Field | Type | @auth | Description |
|---|---|---|---|
seq | Int | ||
ts | DateTime! | ||
level | LogLevel! | ||
target | String | ||
message | String! | ||
fields | JSON | ||
traceId | String |
| Field | Type | @auth | Description |
|---|---|---|---|
edges | [LogEntryEdge!]! | ||
nodes | [LogEntry!]! | ||
pageInfo | PageInfo! |
| Field | Type | @auth | Description |
|---|---|---|---|
cursor | String! | ||
node | LogEntry! |
TRACE DEBUG INFO WARN ERROR UNKNOWN
| Field | Type | @auth | Description |
|---|---|---|---|
matrixId | DocId | ||
row | DocId! | ||
column | DocId! |
| Field | Type | @auth | Description |
|---|---|---|---|
matrixId | DocId | ||
row | DocId! | ||
column | DocId! |
| Field | Type | @auth | Description |
|---|---|---|---|
id | DocId! | ||
name | String | ||
role | String! | ||
status | String! | ||
address | String | ||
engines | [String!] | ||
clock | ClockStatus | ||
lastSeen | DateTime |
| Field | Type | @auth | Description |
|---|---|---|---|
edges | [NodeEdge!]! | ||
nodes | [Node!]! | ||
pageInfo | PageInfo! |
| Field | Type | @auth | Description |
|---|---|---|---|
cursor | String! | ||
node | Node! |
| Field | Type | @auth | Description |
|---|---|---|---|
type | String! | ||
value | JSON |
| Field | Type | @auth | Description |
|---|---|---|---|
brightness | Float! | ||
volume | Float! | ||
gainDb | Float | ||
mute | Boolean | ||
blackout | Boolean! | ||
rotation | Float | ||
lighting | Boolean | ||
ndi | JSON |
| Field | Type | @auth | Description |
|---|---|---|---|
brightness | Float | ||
volume | Float | ||
gainDb | Float | ||
mute | Boolean | ||
blackout | Boolean | ||
rotation | Float | ||
lighting | Boolean | ||
ndi | JSON |
Relay page info.
| Field | Type | @auth | Description |
|---|---|---|---|
hasNextPage | Boolean! | ||
endCursor | String |
| Field | Type | @auth | Description |
|---|---|---|---|
pairingId | UUID! | ||
status | PairingStatus! | ||
code | String | ||
qr | String | ||
app | String | ||
deviceName | String | ||
role | Role | ||
expiresAt | DateTime! | ||
tokens | Tokens |
| Field | Type | @auth | Description |
|---|---|---|---|
approve | Boolean | ||
role | Role | ||
ttlSec | Int |
| Field | Type | @auth | Description |
|---|---|---|---|
edges | [PairingEdge!]! | ||
nodes | [Pairing!]! | ||
pageInfo | PageInfo! |
| Field | Type | @auth | Description |
|---|---|---|---|
cursor | String! | ||
node | Pairing! |
| Field | Type | @auth | Description |
|---|---|---|---|
app | String! | ||
deviceName | String! | ||
requestedRole | Role |
PENDING APPROVED DENIED EXPIRED UNKNOWN
| Field | Type | @auth | Description |
|---|---|---|---|
path | String! | ||
type | String! | ||
value | JSON! | number | boolean | string | |
min | Float | ||
max | Float | ||
unit | String | ||
values | [String!] | ||
readOnly | Boolean | ||
description | String |
| Field | Type | @auth | Description |
|---|---|---|---|
edges | [ParameterEdge!]! | ||
nodes | [Parameter!]! | ||
pageInfo | PageInfo! |
| Field | Type | @auth | Description |
|---|---|---|---|
cursor | String! | ||
node | Parameter! |
| Field | Type | @auth | Description |
|---|---|---|---|
id | DocId! | ||
venueId | DocId! | ||
name | String | ||
status | PlayerStatus! | ||
showId | DocId | ||
playlistId | DocId | ||
timelineId | DocId | ||
matrixCell | MatrixCell | ||
itemIndex | Int | ||
assetId | DocId | ||
position | Float! | ||
duration | Float | ||
rate | Float | ||
loop | Boolean | ||
volume | Float | ||
opacity | Float | ||
brightness | Float | ||
rotation | Float | ||
pending | Boolean | ||
scheduledAt | DateTime | ||
error | Problem | ||
revision | Int! | ||
updatedAt | DateTime |
| Field | Type | @auth | Description |
|---|---|---|---|
edges | [PlayerEdge!]! | ||
nodes | [Player!]! | ||
pageInfo | PageInfo! |
| Field | Type | @auth | Description |
|---|---|---|---|
cursor | String! | ||
node | Player! |
| Field | Type | @auth | Description |
|---|---|---|---|
rate | Float | ||
loop | Boolean | ||
volume | Float | ||
opacity | Float | ||
brightness | Float | ||
rotation | Float |
| Field | Type | @auth | Description |
|---|---|---|---|
venueId | DocId! | ||
playerId | DocId! | ||
position | Float! | ||
duration | Float | ||
rate | Float | ||
timecode | String |
IDLE LOADING PLAYING PAUSED STOPPED ERROR UNKNOWN
| Field | Type | @auth | Description |
|---|---|---|---|
showId | DocId | ||
playlistId | DocId | ||
itemIndex | Int | ||
timelineId | DocId | ||
matrixCell | MatrixCellInput | ||
assetId | DocId | ||
position | Float | ||
at | DateTime | ||
loop | Boolean |
| Field | Type | @auth | Description |
|---|---|---|---|
action | String! | ||
at | DateTime! |
| Field | Type | @auth | Description |
|---|---|---|---|
confirm | Boolean! | ||
delaySec | Int | ||
reason | String |
| Field | Type | @auth | Description |
|---|---|---|---|
subject | String! | ||
kind | String! | ||
name | String | ||
role | Role! | ||
scopes | [String!]! | ||
origin | String | ||
expiresAt | DateTime |
RFC 9457 problem (also in errors[].extensions.problem).
| Field | Type | @auth | Description |
|---|---|---|---|
type | String! | ||
title | String! | ||
status | Int! | ||
code | String! | ||
detail | String | ||
instance | String | ||
traceId | String | ||
errors | [ProblemError!] |
| Field | Type | @auth | Description |
|---|---|---|---|
pointer | String! | ||
detail | String! |
GUEST OPERATOR ADMIN SUPERADMIN UNKNOWN
| Field | Type | @auth | Description |
|---|---|---|---|
id | String! | ||
version | String! | ||
api | String! | ||
title | JSON! | ||
description | JSON | ||
enabled | Boolean! | ||
paramsSchema | JSON! | JSON Schema of the start parameters | |
capabilities | [String!]! | ||
minRole | Role | ||
sessions | Int |
| Field | Type | @auth | Description |
|---|---|---|---|
edges | [ScenarioEdge!]! | ||
nodes | [Scenario!]! | ||
pageInfo | PageInfo! |
| Field | Type | @auth | Description |
|---|---|---|---|
cursor | String! | ||
node | Scenario! |
| Field | Type | @auth | Description |
|---|---|---|---|
seq | Int! | ||
ts | DateTime! | ||
level | String! | ||
message | String! | ||
fields | JSON |
| Field | Type | @auth | Description |
|---|---|---|---|
edges | [ScenarioLogEntryEdge!]! | ||
nodes | [ScenarioLogEntry!]! | ||
pageInfo | PageInfo! |
| Field | Type | @auth | Description |
|---|---|---|---|
cursor | String! | ||
node | ScenarioLogEntry! |
| Field | Type | @auth | Description |
|---|---|---|---|
id | UUID! | ||
venueId | DocId! | ||
scenarioId | String! | ||
scenarioVersion | String | ||
status | SessionStatus! | ||
params | JSON! | ||
owner | String | ||
progress | Float | ||
phase | String | ||
message | String | ||
problem | Problem | ||
startedAt | DateTime! | ||
endedAt | DateTime |
| Field | Type | @auth | Description |
|---|---|---|---|
edges | [ScenarioSessionEdge!]! | ||
nodes | [ScenarioSession!]! | ||
pageInfo | PageInfo! |
| Field | Type | @auth | Description |
|---|---|---|---|
cursor | String! | ||
node | ScenarioSession! |
| Field | Type | @auth | Description |
|---|---|---|---|
scenarioId | String! | ||
params | JSON | ||
at | DateTime |
| Field | Type | @auth | Description |
|---|---|---|---|
position | Float | ||
marker | DocId | ||
normalized | Float | ||
at | DateTime |
| Field | Type | @auth | Description |
|---|---|---|---|
target | DocId! | ||
address | String! | ||
args | [OscArgInput!] |
GET /info (schemas/api/1.0/info.schema.json).
| Field | Type | @auth | Description |
|---|---|---|---|
product | String! | ||
serverVersion | String! | ||
contractVersion | String | ||
instanceId | UUID! | ||
name | String | ||
apiVersions | [String!]! | ||
legacyProfile | Boolean | ||
transports | JSON | transports (rest, graphql, ws, socketio, osc ports) | |
auth | JSON | ||
venues | JSON | ||
capabilities | JSON | ||
links | JSON |
| Field | Type | @auth | Description |
|---|---|---|---|
username | String! | ||
password | String! | ||
client | ClientInfoInput |
STARTING RUNNING PAUSED FINISHED STOPPED FAILED UNKNOWN
Show = .dome show manifest + server fields (schemas/api/1.0/show.schema.json).
| Field | Type | @auth | Description |
|---|---|---|---|
id | DocId! | ||
revision | Int! | ||
status | String | ||
meta | JSON! | ||
assets | JSON! | dome/1.1 #/$defs/asset[] | |
show | JSON! | dome/1.1 #/$defs/show | |
compat | JSON | ||
warnings | [ShowWarning!] | ||
createdAt | DateTime | ||
updatedAt | DateTime | ||
exportUrl | String! | REST URL of the .dome export (binary content is REST-only) |
| Field | Type | @auth | Description |
|---|---|---|---|
id | DocId! | ||
revision | Int! | ||
meta | JSON! | ||
status | String | ||
assetCount | Int | ||
duration | Float | ||
updatedAt | DateTime |
| Field | Type | @auth | Description |
|---|---|---|---|
edges | [ShowSummaryEdge!]! | ||
nodes | [ShowSummary!]! | ||
pageInfo | PageInfo! |
| Field | Type | @auth | Description |
|---|---|---|---|
cursor | String! | ||
node | ShowSummary! |
| Field | Type | @auth | Description |
|---|---|---|---|
code | String! | ||
detail | String! | ||
pointer | String |
| Field | Type | @auth | Description |
|---|---|---|---|
azimuth | Float! | ||
elevation | Float! | ||
distance | Float | ||
rampMs | Float |
| Field | Type | @auth | Description |
|---|---|---|---|
totalBytes | Float! | ||
usedBytes | Float! | ||
freeBytes | Float! | ||
quotaBytes | Float | ||
assets | CountBytes | ||
uploads | CountBytes | ||
byType | JSON |
The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
| Field | Type | @auth | Description |
|---|---|---|---|
host | JSON! | ||
temperatures | JSON | ||
disks | JSON | ||
uptimeSec | Float! | ||
serviceUptimeSec | Float | ||
versions | JSON! |
| Field | Type | @auth | Description |
|---|---|---|---|
ts | DateTime! | ||
sensor | String! | ||
values | [Float!]! | ||
unit | String |
| Field | Type | @auth | Description |
|---|---|---|---|
kind | String! | ||
params | JSON | ||
face | Int |
| Field | Type | @auth | Description |
|---|---|---|---|
id | DocId! | ||
transport | String! | ||
sender | String! | ||
application | String | ||
status | String! | ||
width | Int | ||
height | Int | ||
fps | Float | ||
pixelFormat | String | ||
assetId | DocId | ||
node | String | ||
lastSeen | DateTime |
| Field | Type | @auth | Description |
|---|---|---|---|
edges | [TextureSourceEdge!]! | ||
nodes | [TextureSource!]! | ||
pageInfo | PageInfo! |
| Field | Type | @auth | Description |
|---|---|---|---|
cursor | String! | ||
node | TextureSource! |
| Field | Type | @auth | Description |
|---|---|---|---|
size | Int! | ||
url | String! |
| Field | Type | @auth | Description |
|---|---|---|---|
accessToken | String! | ||
tokenType | String! | ||
expiresIn | Int! | ||
refreshToken | String | ||
refreshExpiresIn | Int | ||
scopes | [String!] | ||
principal | Principal |
| Field | Type | @auth | Description |
|---|---|---|---|
channel | String | ||
version | String | ||
uploadId | UUID | ||
components | [String!] |
| Field | Type | @auth | Description |
|---|---|---|---|
status | String! | ||
current | JSON | ||
available | JSON | ||
jobId | UUID | ||
checkedAt | DateTime |
| Field | Type | @auth | Description |
|---|---|---|---|
id | UUID! | ||
length | Float! | ||
offset | Float! | ||
status | String! | ||
metadata | JSON! | ||
assetId | DocId | ||
problem | Problem | ||
expiresAt | DateTime | ||
createdAt | DateTime! |
| Field | Type | @auth | Description |
|---|---|---|---|
id | UUID! | ||
username | String! | ||
displayName | String | ||
role | Role! | ||
disabled | Boolean | ||
revision | Int! | ||
createdAt | DateTime! | ||
updatedAt | DateTime | ||
lastLoginAt | DateTime |
| Field | Type | @auth | Description |
|---|---|---|---|
edges | [UserEdge!]! | ||
nodes | [User!]! | ||
pageInfo | PageInfo! |
| Field | Type | @auth | Description |
|---|---|---|---|
cursor | String! | ||
node | User! |
| Field | Type | @auth | Description |
|---|---|---|---|
username | String! | ||
displayName | String | ||
password | String! | ||
role | Role! | ||
disabled | Boolean |
| Field | Type | @auth | Description |
|---|---|---|---|
displayName | String | ||
password | String | ||
role | Role | ||
disabled | Boolean |
Lowercase RFC 9562 UUID (server resources: UUIDv7).
Venue = .dome venue manifest + server fields (schemas/api/1.0/venue.schema.json).
| Field | Type | @auth | Description |
|---|---|---|---|
id | DocId! | ||
revision | Int! | ||
status | String! | ||
default | Boolean | ||
activeShowId | DocId | ||
meta | JSON! | dome/1.1 #/$defs/meta | |
dome | JSON! | dome/1.1 #/$defs/dome | |
displays | [Display!]! | ||
calibration | JSON | dome/1.1 #/$defs/calibration | |
speakerLayout | JSON | dome/1.1 #/$defs/audio (speaker layout) | |
compat | JSON | ||
createdAt | DateTime | ||
updatedAt | DateTime | ||
output | Output! | playback:read | |
players | [Player!]! | playback:read | |
player(playerId: DocId!) | Player | playback:read | |
audio | AudioState | playback:read | |
activeShow | Show | content:read | |
calibrationJobs(status: JobStatus) | [CalibrationJob!]! |
| Field | Type | @auth | Description |
|---|---|---|---|
edges | [VenueEdge!]! | ||
nodes | [Venue!]! | ||
pageInfo | PageInfo! |
| Field | Type | @auth | Description |
|---|---|---|---|
cursor | String! | ||
node | Venue! |
NativeMindNONC · commercial use → NativeMind sales · support@freedome.nativemind.net