From d2d2bdd730ab9843c6986c80ae8f46a8c28819c6 Mon Sep 17 00:00:00 2001 From: Github Actions <> Date: Wed, 1 Sep 2021 17:44:19 +0000 Subject: [PATCH] docs(ci): Update generated docs - 9a8587d [skip ci] --- docs/generated/protocol.md | 124 +++++++++---------------------------- 1 file changed, 29 insertions(+), 95 deletions(-) diff --git a/docs/generated/protocol.md b/docs/generated/protocol.md index 5da710cb..c5e42e0f 100644 --- a/docs/generated/protocol.md +++ b/docs/generated/protocol.md @@ -188,11 +188,11 @@ enum RequestStatus { Success = 100, - // The `requestType` key is missing from the request data + // The `requestType` field is missing from the request data MissingRequestType = 203, - // The request type is invalid (does not exist) + // The request type is invalid or does not exist UnknownRequestType = 204, - // Generic error code (comment is expected to be provided) + // Generic error code (comment required) GenericError = 205, // A required request parameter is missing @@ -200,10 +200,10 @@ enum RequestStatus { // The request does not have a valid requestData object. MissingRequestData = 301, - // Generic invalid request parameter message + // Generic invalid request parameter message (comment required) InvalidRequestParameter = 400, // A request parameter has the wrong data type - InvalidRequestParameterDataType = 401, + InvalidRequestParameterType = 401, // A request parameter (float or int) is out of valid range RequestParameterOutOfRange = 402, // A request parameter (string or array) is empty and cannot be @@ -215,102 +215,36 @@ enum RequestStatus { OutputRunning = 500, // An output is not running and should be OutputNotRunning = 501, - // Stream is running and cannot be - StreamRunning = 502, - // Stream is not running and should be - StreamNotRunning = 503, - // Record is running and cannot be - RecordRunning = 504, - // Record is not running and should be - RecordNotRunning = 505, - // Record is paused and cannot be - RecordPaused = 506, - // Replay buffer is running and cannot be - ReplayBufferRunning = 507, - // Replay buffer is not running and should be - ReplayBufferNotRunning = 508, - // Replay buffer is disabled and cannot be - ReplayBufferDisabled = 509, + // An output is paused and should not be + OutputPaused = 502, + // An output is disabled and should not be + OutputDisabled = 503, // Studio mode is active and cannot be - StudioModeActive = 510, + StudioModeActive = 504, // Studio mode is not active and should be - StudioModeNotActive = 511, - // Virtualcam is running and cannot be - VirtualcamRunning = 512, - // Virtualcam is not running and should be - VirtualcamNotRunning = 513, + StudioModeNotActive = 505, - // The specified source (obs_source_t) was of the invalid type (Eg. input instead of scene) - InvalidSourceType = 600, - // The specified source (obs_source_t) was not found (generic for input, filter, transition, scene) - SourceNotFound = 601, - // The specified source (obs_source_t) already exists. Applicable to inputs, filters, transitions, scenes - SourceAlreadyExists = 602, - // The specified input (obs_source_t-OBS_SOURCE_TYPE_FILTER) was not found - InputNotFound = 603, + // The resource was not found + ResourceNotFound = 600, + // The resource already exists + ResourceAlreadyExists = 601, + // The type of resource found is invalid + InvalidResourceType = 602, + // There are not enough instances of the resource in order to perform the request + NotEnoughResources = 603, + // The state of the resource is invalid. For example, if the resource is blocked from being accessed + InvalidResourceState = 604, // The specified input (obs_source_t-OBS_SOURCE_TYPE_INPUT) had the wrong kind - InvalidInputKind = 604, - // The specified filter (obs_source_t-OBS_SOURCE_TYPE_FILTER) was not found - FilterNotFound = 605, - // The specified transition (obs_source_t-OBS_SOURCE_TYPE_TRANSITION) was not found - TransitionNotFound = 606, - // The specified transition (obs_source_t-OBS_SOURCE_TYPE_TRANSITION) does not support setting its position (transition is of fixed type) - TransitionDurationFixed = 607, - // The specified scene (obs_source_t-OBS_SOURCE_TYPE_SCENE), (obs_scene_t) was not found - SceneNotFound = 608, - // The specified scene item (obs_sceneitem_t) was not found - SceneItemNotFound = 609, - // The specified scene collection was not found - SceneCollectionNotFound = 610, - // The specified profile was not found - ProfileNotFound = 611, - // The specified output (obs_output_t) was not found - OutputNotFound = 612, - // The specified encoder (obs_encoder_t) was not found - EncoderNotFound = 613, - // The specified service (obs_service_t) was not found - ServiceNotFound = 614, - // The specified hotkey was not found - HotkeyNotFound = 615, - // The specified directory was not found - DirectoryNotFound = 616, - // The specified config item (config_t) was not found. Could be section or parameter name - ConfigParameterNotFound = 617, - // The specified property (obs_properties_t) was not found - PropertyNotFound = 618, - // The specififed key (OBS_KEY_*) was not found - KeyNotFound = 619, - // The specified data realm (OBS_WEBSOCKET_DATA_REALM_*) was not found - DataRealmNotFound = 620, - // The scene collection already exists - SceneCollectionAlreadyExists = 621, - // There are not enough scene collections to perform the action - NotEnoughSceneCollections = 622, - // The profile already exists - ProfileAlreadyExists = 623, - // There are not enough profiles to perform the action - NotEnoughProfiles = 624, - // There are not enough scenes to perform the action - NotEnoughScenes = 625, + InvalidInputKind = 605, - // Processing the request failed unexpectedly - RequestProcessingFailed = 700, - // Starting the Output failed - OutputStartFailed = 701, - // Duplicating the scene item failed - SceneItemDuplicationFailed = 702, - // Rendering the screenshot failed - ScreenshotRenderFailed = 703, - // Encoding the screenshot failed - ScreenshotEncodeFailed = 704, - // Saving the screenshot failed - ScreenshotSaveFailed = 705, - // Creating the directory failed - DirectoryCreationFailed = 706, + // Creating the resource failed + ResourceCreationFailed = 700, + // Performing an action on the resource failed + ResourceActionFailed = 701, + // Processing the request failed unexpectedly (comment required) + RequestProcessingFailed = 702, // The combination of request parameters cannot be used to perform an action - CannotAct = 707, - // Creation of a new stream service failed - StreamServiceCreationFailed = 708, + CannotAct = 703, }; ```