diff --git a/docs/docs/generate_md.py b/docs/docs/generate_md.py index e3295c35..ee746281 100644 --- a/docs/docs/generate_md.py +++ b/docs/docs/generate_md.py @@ -10,7 +10,8 @@ enumTypeOrder = [ 'RequestBatchExecutionType', 'RequestStatus', 'EventSubscription', - 'ObsMediaInputAction' + 'ObsMediaInputAction', + 'ObsOutputState' ] categoryOrder = [ diff --git a/src/utils/Obs.h b/src/utils/Obs.h index ea54b0ac..d9c619e8 100644 --- a/src/utils/Obs.h +++ b/src/utils/Obs.h @@ -67,17 +67,97 @@ template T *GetCalldataPointer(const calldata_t *data, const char *n } enum ObsOutputState { + /** + * Unknown state. + * + * @enumIdentifier OBS_WEBSOCKET_OUTPUT_UNKNOWN + * @enumType ObsOutputState + * @rpcVersion 1 + * @initialVersion 5.0.0 + * @api enums + */ OBS_WEBSOCKET_OUTPUT_UNKNOWN, + /** + * The output is starting. + * + * @enumIdentifier OBS_WEBSOCKET_OUTPUT_STARTING + * @enumType ObsOutputState + * @rpcVersion 1 + * @initialVersion 5.0.0 + * @api enums + */ OBS_WEBSOCKET_OUTPUT_STARTING, + /** + * The input has started. + * + * @enumIdentifier OBS_WEBSOCKET_OUTPUT_STARTED + * @enumType ObsOutputState + * @rpcVersion 1 + * @initialVersion 5.0.0 + * @api enums + */ OBS_WEBSOCKET_OUTPUT_STARTED, + /** + * The output is stopping. + * + * @enumIdentifier OBS_WEBSOCKET_OUTPUT_STOPPING + * @enumType ObsOutputState + * @rpcVersion 1 + * @initialVersion 5.0.0 + * @api enums + */ OBS_WEBSOCKET_OUTPUT_STOPPING, + /** + * The output has stopped. + * + * @enumIdentifier OBS_WEBSOCKET_OUTPUT_STOPPED + * @enumType ObsOutputState + * @rpcVersion 1 + * @initialVersion 5.0.0 + * @api enums + */ OBS_WEBSOCKET_OUTPUT_STOPPED, + /** + * The output has disconnected and is reconnecting. + * + * @enumIdentifier OBS_WEBSOCKET_OUTPUT_RECONNECTING + * @enumType ObsOutputState + * @rpcVersion 1 + * @initialVersion 5.0.0 + * @api enums + */ OBS_WEBSOCKET_OUTPUT_RECONNECTING, + /** + * The output has reconnected successfully. + * + * @enumIdentifier OBS_WEBSOCKET_OUTPUT_RECONNECTED + * @enumType ObsOutputState + * @rpcVersion 1 + * @initialVersion 5.2.0 + * @api enums + */ OBS_WEBSOCKET_OUTPUT_RECONNECTED, + /** + * The output is now paused. + * + * @enumIdentifier OBS_WEBSOCKET_OUTPUT_PAUSED + * @enumType ObsOutputState + * @rpcVersion 1 + * @initialVersion 5.2.0 + * @api enums + */ OBS_WEBSOCKET_OUTPUT_PAUSED, + /** + * The output has been resumed (unpaused). + * + * @enumIdentifier OBS_WEBSOCKET_OUTPUT_RESUMED + * @enumType ObsOutputState + * @rpcVersion 1 + * @initialVersion 5.0.0 + * @api enums + */ OBS_WEBSOCKET_OUTPUT_RESUMED, }; - NLOHMANN_JSON_SERIALIZE_ENUM(ObsOutputState, { {OBS_WEBSOCKET_OUTPUT_UNKNOWN, "OBS_WEBSOCKET_OUTPUT_UNKNOWN"}, {OBS_WEBSOCKET_OUTPUT_STARTING, "OBS_WEBSOCKET_OUTPUT_STARTING"}, @@ -162,7 +242,6 @@ enum ObsMediaInputAction { */ OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PREVIOUS, }; - NLOHMANN_JSON_SERIALIZE_ENUM(ObsMediaInputAction, { {OBS_WEBSOCKET_MEDIA_INPUT_ACTION_NONE, "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_NONE"},