Merge pull request #5 from GravityDarkLab/update-docs

Update docs

Author: GravityDarkLab

README.md

@@ -1,12 +1,14 @@
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/7effd0e67a70432eb40c85bdbabba728)](https://app.codacy.com/gh/GravityDarkLab/obs-controller-api?utm_source=github.com&utm_medium=referral&utm_content=GravityDarkLab/obs-controller-api&utm_campaign=Badge_Grade)
 # OBS-Controller API
 
 This is an API for controlling OBS Studio via HTTP requests.
 It is written in Java with Spring Boot and uses
 the [obs-websocket](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md)
-plugin.
+plugin for [OBS studio](https://obsproject.com/).
 
-![OBS-Controller-API.png](assets/OBS-Controller-API.png)
+<div style="display: inline-flex; align-items: center;">
+  <img src="assets/OBS-Controller-API.png" alt="OBS-Controller-API" width="500" style="margin-right: 10px;">
+  <img src="assets/OBS-Controller-API-v2.png" alt="OBS-Controller-API-v2" width="700" height="400">
+</div>
 
 ## Installation
 
@@ -23,24 +25,24 @@ plugin.
 3. Copy the ipAdresse, port and password of the Websocket Server.
 4. Send `POST` requests to `http://localhost:8080/obs/connect` with the following required parameters to connect to the
    Websocket Server:
-    - `ipAdresse`: The ipAdresse of the Websocket Server.
+    - `ipAddress`: The ipAdresse of the Websocket Server.
     - `port`: The port of the Websocket Server.
     - `password`: The password of the Websocket Server.
 5. Send a `POST` request to `http://localhost:8080/obs/authenticate` with the following required parameters to
    authenticate to the Websocket Server:
-    - `ipAdresse`: The ipAdresse of the Websocket Server.
+    - `ipAddress`: The ipAdresse of the Websocket Server.
     - `port`: The port of the Websocket Server.
 6. Send a `POST` request to `http://localhost:8080/obs/startRecording` with the following required parameters to start
    recording:
-    - `ipAdresse`: The ipAdresse of the Websocket Server.
+    - `ipAddress`: The ipAdresse of the Websocket Server.
     - `port`: The port of the Websocket Server.
 7. Send a `POST` request to `http://localhost:8080/obs/stopRecording` with the following required parameters to stop
    recording:
-    - `ipAdresse`: The ipAdresse of the Websocket Server.
+    - `ipAddress`: The ipAdresse of the Websocket Server.
     - `port`: The port of the Websocket Server.
 8. Send a `POST` request to `http://localhost:8080/obs/disconnect` with the following required parameters to disconnect
    from the Websocket Server:
-    - `ipAdresse`: The ipAdresse of the Websocket Server.
+    - `ipAddress`: The ipAdresse of the Websocket Server.
     - `port`: The port of the Websocket Server.
 
 ## Available Endpoints
@@ -52,38 +54,59 @@ requires specific parameters as part of the query string.
 
 1. **Connect to OBS**
     - `POST /obs/connect`
-        - Parameters: `ipAdresse`, `port`, `password`
-        - Example: `POST http://localhost:8080/obs/connect?ipAdresse=<ipAdresse>&port=<port>&password=<password>`
+        - Parameters: `ipAddress`, `port`, `password`
+        - Example: `POST http://localhost:8080/obs/connect?ipAddress=<ipAddress>&port=<port>&password=<password>`
 
 2. **Authenticate with OBS**
     - `POST /obs/authenticate`
-        - Parameters: `ipAdresse`, `port`
-        - Example: `POST http://localhost:8080/obs/authenticate?ipAdresse=<ipAdresse>&port=<port>`
+        - Parameters: `ipAddress`, `port`
+        - Example: `POST http://localhost:8080/obs/authenticate?ipAddress=<ipAddress>&port=<port>`
 
 3. **Disconnect from OBS**
     - `POST /obs/disconnect`
-        - Parameters: `ipAdresse`, `port`
-        - Example: `POST http://localhost:8080/obs/disconnect?ipAdresse=<ipAdresse>&port=<port>`
+        - Parameters: `ipAddress`, `port`
+        - Example: `POST http://localhost:8080/obs/disconnect?ipAddress=<ipAddress>&port=<port>`
 
 4. **Reconnect to OBS**
     - `POST /obs/reconnect`
-        - Parameters: `ipAdresse`, `port`
-        - Example: `POST http://localhost:8080/obs/reconnect?ipAdresse=<ipAdresse>&port=<port>`
+        - Parameters: `ipAddress`, `port`
+        - Example: `POST http://localhost:8080/obs/reconnect?ipAddress=<ipAddress>&port=<port>`
 
 ### OBS Recording Control
 
 1. **Start Recording**
     - `POST /obs/startRecording`
-        - Parameters: `ipAdresse`, `port`
-        - Example: `POST http://localhost:8080/obs/startRecording?ipAdresse=<ipAdresse>&port=<port>`
-
-2. **Stop Recording**
+        - Parameters: `ipAddress`, `port`
+        - Example: `POST http://localhost:8080/obs/startRecording?ipAddress=<ipAddress>&port=<port>`
+2. **Start Recording to All clients**
+    - `POST /obs/startRecordingToAllClients
+        - Example: `POST http://localhost:8080/obs/startRecordingAll`
+3. **Stop Recording**
     - `POST /obs/stopRecording`
-        - Parameters: `ipAdresse`, `port`
-        - Example: `POST http://localhost:8080/obs/stopRecording?ipAdresse=<ipAdresse>&port=<port>`
-
-![swagger-doc.png](assets/swagger-doc.png)
+        - Parameters: `ipAddress`, `port`
+        - Example: `POST http://localhost:8080/obs/stopRecording?ipAddress=<ipAddress>&port=<port>`
+4. **Stop Recording to All clients**
+    - `POST /obs/stopRecordingToAllClients
+        - Example: `POST http://localhost:8080/obs/stopRecordingAll`
+
+### Health Check
+
+1. **Connected Clients**
+    - `GET /obs/ipAddresses`
+        - Example: `GET http://localhost:8080/obs/ipAddresses`
+2. **Number of Connected Clients**
+    - `GET /obs/count`
+        - Example: `GET http://localhost:8080/obs/count`
+3. **Test connection to a client**
+    - `GET /obs/testConnection`
+        - Parameters: `ipAddress`, `port`
+        - Example: `GET http://localhost:8080/obs/testConnection?ipAddress=<ipAddress>&port=<port>`
+
+<div style="display: flex; align-items: center;">
+  <img src="assets/swagger-doc.png" alt="OBS-Controller-API" width="800" style="margin-right: 10px;">
+</div>
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the Isar Aerospace Technologies GmbH License - see the [LICENSE](LICENSE) file for
+details.