Skip to content

Commit

Permalink
Update control.md
Browse files Browse the repository at this point in the history
  • Loading branch information
badaix committed Jan 16, 2025
1 parent b8a662b commit 63f9ce1
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 31 deletions.
2 changes: 1 addition & 1 deletion changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@

### Bugfixes

- Fix CVE-2023-36177: Remove "AddStream" and "RemoveStream" RPC (Issue #1327)
- Fix compile error on MacOS
- Remove PiMusicBox from readme (Issue ##1304)
- Add missing include (Issue #1295)
Expand All @@ -18,7 +19,6 @@

### General

- Server: Fix CVE-2023-36177 (Issue #1327)
- CI: execute unit tests (asan and tsan)
- CI: create doxygen documentation
- CI: compile release and debug builds
Expand Down
30 changes: 0 additions & 30 deletions doc/json_rpc_api/control.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,8 +159,6 @@ The Server JSON object contains a list of Groups and Streams. Every Group holds
* [Server.GetStatus](#servergetstatus)
* [Server.DeleteClient](#serverdeleteclient)
* Stream
* [Stream.AddStream](#streamaddstream)
* [Stream.RemoveStream](#streamremovestream)
* [Stream.Control](#streamcontrol)
* [Stream.SetProperty](#streamsetproperty)

Expand Down Expand Up @@ -412,34 +410,6 @@ Some requests might return more specific json error messages.
{"jsonrpc":"2.0","method":"Server.OnUpdate","params":{"server":{"groups":[{"clients":[{"config":{"instance":2,"latency":6,"name":"123 456","volume":{"muted":false,"percent":48}},"connected":true,"host":{"arch":"x86_64","ip":"127.0.0.1","mac":"00:21:6a:7d:74:fc","name":"T400","os":"Linux Mint 17.3 Rosa"},"id":"00:21:6a:7d:74:fc#2","lastSeen":{"sec":1488025751,"usec":654777},"snapclient":{"name":"Snapclient","protocolVersion":2,"version":"0.10.0"}}],"id":"4dcc4e3b-c699-a04b-7f0c-8260d23c43e1","muted":false,"name":"","stream_id":"stream 2"}],"server":{"host":{"arch":"x86_64","ip":"","mac":"","name":"T400","os":"Linux Mint 17.3 Rosa"},"snapserver":{"controlProtocolVersion":1,"name":"Snapserver","protocolVersion":1,"version":"0.10.0"}},"streams":[{"id":"stream 1","status":"idle","uri":{"fragment":"","host":"","path":"/tmp/snapfifo","query":{"chunk_ms":"20","codec":"flac","name":"stream 1","sampleformat":"48000:16:2"},"raw":"pipe:///tmp/snapfifo?name=stream 1","scheme":"pipe"}},{"id":"stream 2","status":"idle","uri":{"fragment":"","host":"","path":"/tmp/snapfifo","query":{"chunk_ms":"20","codec":"flac","name":"stream 2","sampleformat":"48000:16:2"},"raw":"pipe:///tmp/snapfifo?name=stream 2","scheme":"pipe"}}]}}}
```

### Stream.AddStream

#### Request

```json
{"id":8,"jsonrpc":"2.0","method":"Stream.AddStream","params":{"streamUri":"pipe:///tmp/snapfifo?name=stream 2"}}
```

#### Response

```json
{"id":8,"jsonrpc":"2.0","result":{"stream_id":"stream 2"}}
```

### Stream.RemoveStream

#### Request

```json
{"id":8,"jsonrpc":"2.0","method":"Stream.RemoveStream","params":{"id":"stream 2"}}
```

#### Response

```json
{"id":8,"jsonrpc":"2.0","result":{"stream_id":"stream 2"}}
```

### Stream.Control

#### Request
Expand Down

0 comments on commit 63f9ce1

Please sign in to comment.