Developer
Log in

Reference

Error codes

Every error code Studio sends, with its stable name and the class each SDK raises for it. A code never changes meaning.

Codes

CodeNameMeaning
-32700parse_errorThe message isn't JSON.
-32600invalid_requestNot a JSON-RPC 2.0 request, or too many requests at once.
-32601method_not_foundNo such method.
-32602invalid_paramsA parameter is missing, unknown, of the wrong type or out of range. The message names it.
-32603internalSomething went wrong inside Studio.
-32001unauthorizedNot authorized: no pairing yet, or a wrong pairing code.
-32010unknown_actionNo action with that id.
-32011not_foundThe scene, layer, source, effect, automation, collection or destination named doesn't exist.
-32012confirm_requiredA destructive action without its confirmation.
-32013rate_limitedToo many of these too fast. data.retry_after_ms says when to try again.
-32014failedStudio tried and it didn't work. The message says why.
-32015unavailableNot possible right now: no collection open, the GPU still starting, or a feature this computer doesn't have.
-32016rejectedThe scene model refused the change. data has its reason and the index of the refused command.
-32017unknown_topicNo such state topic.
-32018forbiddenThis paired device isn't allowed to do that. Studio chooses what each device may do in Settings › Remote control; data.scope names what it needs.

In the SDKs

CodeC#TypeScriptPython
-32700 parse_errorVelumParseErrorExceptionVelumParseErrorErrorVelumParseErrorError
-32600 invalid_requestVelumInvalidRequestExceptionVelumInvalidRequestErrorVelumInvalidRequestError
-32601 method_not_foundVelumMethodNotFoundExceptionVelumMethodNotFoundErrorVelumMethodNotFoundError
-32602 invalid_paramsVelumInvalidParamsExceptionVelumInvalidParamsErrorVelumInvalidParamsError
-32603 internalVelumInternalExceptionVelumInternalErrorVelumInternalError
-32001 unauthorizedVelumUnauthorizedExceptionVelumUnauthorizedErrorVelumUnauthorizedError
-32010 unknown_actionVelumUnknownActionExceptionVelumUnknownActionErrorVelumUnknownActionError
-32011 not_foundVelumNotFoundExceptionVelumNotFoundErrorVelumNotFoundError
-32012 confirm_requiredVelumConfirmRequiredExceptionVelumConfirmRequiredErrorVelumConfirmRequiredError
-32013 rate_limitedVelumRateLimitedExceptionVelumRateLimitedErrorVelumRateLimitedError
-32014 failedVelumFailedExceptionVelumFailedErrorVelumFailedError
-32015 unavailableVelumUnavailableExceptionVelumUnavailableErrorVelumUnavailableError
-32016 rejectedVelumRejectedExceptionVelumRejectedErrorVelumRejectedError
-32017 unknown_topicVelumUnknownTopicExceptionVelumUnknownTopicErrorVelumUnknownTopicError
-32018 forbiddenVelumForbiddenExceptionVelumForbiddenErrorVelumForbiddenError

Every class derives from the SDK's base error: VelumException in C#, VelumError in TypeScript and Python. A connection that fails or closes before the answer is VelumConnectionException or VelumConnectionError.

to open · ↑ ↓ to move · Esc to close