Update Protocol.md with the new request types

Added SetSyncOffset and GetSyncOffset to the documentation
This commit is contained in:
Marwin M 2017-08-07 16:02:09 +02:00 committed by GitHub
parent 712bd6e8f3
commit 59de83b45d

View File

@ -95,6 +95,8 @@ The protocol in general is based on the OBS Remote protocol created by Bill Hami
- ["SetMute"](#setmute) - ["SetMute"](#setmute)
- ["GetMute"](#getmute) - ["GetMute"](#getmute)
- ["ToggleMute"](#togglemute) - ["ToggleMute"](#togglemute)
- ["SetSyncOffset"](#setsyncoffset)
- ["GetSyncOffset"](#getsyncoffset)
- **Scene Items** - **Scene Items**
- ["SetSceneItemRender"](#setsourcerender) (a.k.a `SetSourceRender`) - ["SetSceneItemRender"](#setsourcerender) (a.k.a `SetSourceRender`)
- ["SetSceneItemPosition"](#setsceneitemposition) - ["SetSceneItemPosition"](#setsceneitemposition)
@ -691,6 +693,29 @@ __Response__ : OK if specified source exists, error otherwise.
--- ---
#### "SetSyncOffset"
Set the sync offset of a specific source.
__Request fields__ :
- **"source"** (string) : the name of the source
- **"offset"** (integer) : the desired sync offset in nanoseconds
__Response__ : OK if specified source exists, error otherwise.
---
#### "GetSyncOffset"
Get the sync offset of a specific source.
__Request fields__ :
- **"source"** (string) : the name of the source
__Response__ : OK if source exists, with these additional fields :
- **"name"** (string) : source name
- **"offset"** (integer) : source sync offset, in nanoseconds
---
#### "GetSpecialSources" #### "GetSpecialSources"
Get configured special sources like Desktop Audio and Mic/Aux sources. Get configured special sources like Desktop Audio and Mic/Aux sources.