From 06c1648f553054d5739308736e51a2230b37f760 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20L?= Date: Thu, 23 Feb 2017 22:21:06 +0100 Subject: [PATCH] Updated PROTOCOL.md : new table of contents --- PROTOCOL.md | 43 ++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 40 insertions(+), 3 deletions(-) diff --git a/PROTOCOL.md b/PROTOCOL.md index 05b21c2a..a5f519f5 100644 --- a/PROTOCOL.md +++ b/PROTOCOL.md @@ -6,9 +6,46 @@ Messages exchanged between the client and the server are JSON objects. The protocol in general is based on the OBS Remote protocol created by Bill Hamilton, with new commands specific to OBS Studio. ### Table of contents -- [Events](#events) -- [Requests](#requests) -- [Authentication](#authentication) +* [Events](#events) + - [Description](#description) + - [Event Types](#event-types) + - ["SwitchScenes"](#switchscenes) + - ["ScenesChanged"](#sceneschanged) + - ["SwitchTransition"](#switchtransition) + - ["TransitionListChanged"](#transitionlistchanged) + - ["StreamStarting"](#streamstarting) + - ["StreamStarted"](#streamstarted) + - ["StreamStopping"](#streamstopping) + - ["StreamStopped"](#streamstopped) + - ["RecordingStarting"](#recordingstarting) + - ["RecordingStarted"](#recordingstarted) + - ["RecordingStopping"](#recordingstopping) + - ["RecordingStopped"](#recordingstopped) + - ["StreamStatus"](#streamstatus) + - ["Exiting"](#exiting) +* [Requests](#requests) + - [Description](#description-1) + - [Request Types](#request-types) + - ["GetVersion"](#getversion) + - ["GetAuthRequired"](#getauthrequired) + - ["Authenticate"](#authenticate) + - ["GetCurrentScene"](#getcurrentscene) + - ["SetCurrentScene"](#setcurrentscene) + - ["GetSceneList"](#getscenelist) + - ["SetSourceRender"](#setsourcerender) + - ["StartStopStreaming"](#startstopstreaming) + - ["StartStopRecording"](#startstoprecording) + - ["GetStreamingStatus"](#getstreamingstatus) + - ["GetTransitionList"](#gettransitionlist) + - ["GetCurrentTransition"](#getcurrenttransition) + - ["SetCurrentTransition"](#setcurrenttransition) + - ["SetVolume"](#setvolume) + - ["GetVolume"](#getvolume) + - ["SetMute"](#setmute) + - ["ToggleMute"](#togglemute) + - ["SetSceneItemPosition"](#setsceneitemposition) + - ["SetSceneItemTransform"](#setsceneitemtransform) +* [Authentication](#authentication) ## Events ### Description