Actions
Updates
2 actions in the Updates group. Each is its own JSON-RPC method, and also runs through action.run.
update.checkCheck for updates
Asks Studio's update channel whether there's a newer Studio, as Check for updates in the Help menu does, and returns once it knows. Nothing is downloaded.
Parameters
Result
A UpdateState. See its fields under Shapes.
Live state
update.available bool
On while an update is on offer. From the update topic. How to read it.
{
"jsonrpc": "2.0",
"id": 1,
"method": "update.check"
}In the SDKs
Task<UpdateState> UpdateCheckAsync(CancellationToken cancellationToken = default)updateCheck(): Promise<UpdateState>async def update_check(self) -> UpdateStateJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {},
"required": [],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"available": {
"description": "On while an update is on offer (available, downloading or ready).",
"type": "boolean"
},
"channel": {
"description": "The update channel: stable, beta or internal.",
"type": [
"string",
"null"
]
},
"current_version": {
"description": "The running Studio's version.",
"type": [
"string",
"null"
]
},
"date": {
"description": "Its release date.",
"type": [
"string",
"null"
]
},
"downloaded_bytes": {
"type": "integer"
},
"error": {
"description": "Why the last check or download failed.",
"type": [
"string",
"null"
]
},
"install_pending": {
"description": "Update now was pressed while live, recording or keeping a replay buffer: it starts once that ends.",
"type": "boolean"
},
"last_checked_ms": {
"description": "When the channel was last asked (Unix ms).",
"type": [
"integer",
"null"
]
},
"latest": {
"description": "The newest version on the channel, once checked.",
"type": [
"string",
"null"
]
},
"notes": {
"description": "Its release notes (Markdown).",
"type": [
"string",
"null"
]
},
"progress": {
"description": "0 to 1 while downloading; 1 once ready.",
"type": [
"number",
"null"
]
},
"size": {
"description": "Its download's size in bytes (null when the package manager updates Studio).",
"type": [
"integer",
"null"
]
},
"state": {
"description": "idle (nothing on offer, or not checked yet), checking, available, downloading, ready (downloaded and verified: Studio restarts into it when asked) or error.",
"enum": [
"idle",
"checking",
"available",
"downloading",
"ready",
"error"
],
"title": "UpdateStatus",
"type": "string"
},
"updates_itself": {
"description": "This copy is updated by its package manager (Flatpak); Studio only says there's an update.",
"type": "boolean"
},
"version": {
"description": "The version on offer.",
"type": [
"string",
"null"
]
},
"waiting_for": {
"description": "What a pending install waits for (live, recording, replay buffer).",
"type": [
"string",
"null"
]
}
},
"required": [
"state",
"available",
"current_version",
"channel",
"latest",
"version",
"date",
"notes",
"size",
"progress",
"downloaded_bytes",
"install_pending",
"waiting_for",
"updates_itself",
"error",
"last_checked_ms"
],
"title": "UpdateState",
"type": "object"
}
}update.installInstall update
Downloads the update on offer and checks its signature and checksum, ready to restart into, as Update now does. Refused while live, recording or keeping a replay buffer: updates never start then. With restart, Studio restarts into the new version once it's ready.
Parameters
Restart Studio into the update once it's downloaded and verified.
Result
A UpdateState. See its fields under Shapes.
Live state
update.state string
idle, checking, available, downloading, ready or error. From the update topic. How to read it.
{
"jsonrpc": "2.0",
"id": 1,
"method": "update.install"
}In the SDKs
Task<UpdateState> UpdateInstallAsync(CancellationToken cancellationToken = default)async def update_install(self, *, restart: bool | None = None) -> UpdateStateJSON Schema
{
"params_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"restart": {
"default": false,
"description": "Restart Studio into the update once it's downloaded and verified.",
"type": "boolean"
}
},
"required": [],
"type": "object"
},
"result_schema": {
"additionalProperties": false,
"properties": {
"available": {
"description": "On while an update is on offer (available, downloading or ready).",
"type": "boolean"
},
"channel": {
"description": "The update channel: stable, beta or internal.",
"type": [
"string",
"null"
]
},
"current_version": {
"description": "The running Studio's version.",
"type": [
"string",
"null"
]
},
"date": {
"description": "Its release date.",
"type": [
"string",
"null"
]
},
"downloaded_bytes": {
"type": "integer"
},
"error": {
"description": "Why the last check or download failed.",
"type": [
"string",
"null"
]
},
"install_pending": {
"description": "Update now was pressed while live, recording or keeping a replay buffer: it starts once that ends.",
"type": "boolean"
},
"last_checked_ms": {
"description": "When the channel was last asked (Unix ms).",
"type": [
"integer",
"null"
]
},
"latest": {
"description": "The newest version on the channel, once checked.",
"type": [
"string",
"null"
]
},
"notes": {
"description": "Its release notes (Markdown).",
"type": [
"string",
"null"
]
},
"progress": {
"description": "0 to 1 while downloading; 1 once ready.",
"type": [
"number",
"null"
]
},
"size": {
"description": "Its download's size in bytes (null when the package manager updates Studio).",
"type": [
"integer",
"null"
]
},
"state": {
"description": "idle (nothing on offer, or not checked yet), checking, available, downloading, ready (downloaded and verified: Studio restarts into it when asked) or error.",
"enum": [
"idle",
"checking",
"available",
"downloading",
"ready",
"error"
],
"title": "UpdateStatus",
"type": "string"
},
"updates_itself": {
"description": "This copy is updated by its package manager (Flatpak); Studio only says there's an update.",
"type": "boolean"
},
"version": {
"description": "The version on offer.",
"type": [
"string",
"null"
]
},
"waiting_for": {
"description": "What a pending install waits for (live, recording, replay buffer).",
"type": [
"string",
"null"
]
}
},
"required": [
"state",
"available",
"current_version",
"channel",
"latest",
"version",
"date",
"notes",
"size",
"progress",
"downloaded_bytes",
"install_pending",
"waiting_for",
"updates_itself",
"error",
"last_checked_ms"
],
"title": "UpdateState",
"type": "object"
}
}
