mirror of
https://github.com/Palakis/obs-websocket.git
synced 2024-08-30 18:12:16 +00:00
docs(travis): Update protocol.md - 87b4768 [skip ci]
This commit is contained in:
parent
87b47689eb
commit
82a1e7d253
@ -772,7 +772,7 @@
|
|||||||
"api": "events",
|
"api": "events",
|
||||||
"name": "ReplayStarting",
|
"name": "ReplayStarting",
|
||||||
"category": "replay buffer",
|
"category": "replay buffer",
|
||||||
"since": "unreleased",
|
"since": "4.2.0",
|
||||||
"names": [
|
"names": [
|
||||||
{
|
{
|
||||||
"name": "",
|
"name": "",
|
||||||
@ -788,7 +788,7 @@
|
|||||||
"sinces": [
|
"sinces": [
|
||||||
{
|
{
|
||||||
"name": "",
|
"name": "",
|
||||||
"description": "unreleased"
|
"description": "4.2.0"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"heading": {
|
"heading": {
|
||||||
@ -805,7 +805,7 @@
|
|||||||
"api": "events",
|
"api": "events",
|
||||||
"name": "ReplayStarted",
|
"name": "ReplayStarted",
|
||||||
"category": "replay buffer",
|
"category": "replay buffer",
|
||||||
"since": "unreleased",
|
"since": "4.2.0",
|
||||||
"names": [
|
"names": [
|
||||||
{
|
{
|
||||||
"name": "",
|
"name": "",
|
||||||
@ -821,7 +821,7 @@
|
|||||||
"sinces": [
|
"sinces": [
|
||||||
{
|
{
|
||||||
"name": "",
|
"name": "",
|
||||||
"description": "unreleased"
|
"description": "4.2.0"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"heading": {
|
"heading": {
|
||||||
@ -838,7 +838,7 @@
|
|||||||
"api": "events",
|
"api": "events",
|
||||||
"name": "ReplayStopping",
|
"name": "ReplayStopping",
|
||||||
"category": "replay buffer",
|
"category": "replay buffer",
|
||||||
"since": "unreleased",
|
"since": "4.2.0",
|
||||||
"names": [
|
"names": [
|
||||||
{
|
{
|
||||||
"name": "",
|
"name": "",
|
||||||
@ -854,7 +854,7 @@
|
|||||||
"sinces": [
|
"sinces": [
|
||||||
{
|
{
|
||||||
"name": "",
|
"name": "",
|
||||||
"description": "unreleased"
|
"description": "4.2.0"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"heading": {
|
"heading": {
|
||||||
@ -871,7 +871,7 @@
|
|||||||
"api": "events",
|
"api": "events",
|
||||||
"name": "ReplayStopped",
|
"name": "ReplayStopped",
|
||||||
"category": "replay buffer",
|
"category": "replay buffer",
|
||||||
"since": "unreleased",
|
"since": "4.2.0",
|
||||||
"names": [
|
"names": [
|
||||||
{
|
{
|
||||||
"name": "",
|
"name": "",
|
||||||
@ -887,7 +887,7 @@
|
|||||||
"sinces": [
|
"sinces": [
|
||||||
{
|
{
|
||||||
"name": "",
|
"name": "",
|
||||||
"description": "unreleased"
|
"description": "4.2.0"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"heading": {
|
"heading": {
|
||||||
@ -1849,7 +1849,7 @@
|
|||||||
"api": "requests",
|
"api": "requests",
|
||||||
"name": "SetSyncOffset",
|
"name": "SetSyncOffset",
|
||||||
"category": "sources",
|
"category": "sources",
|
||||||
"since": "unreleased",
|
"since": "4.2.0",
|
||||||
"params": [
|
"params": [
|
||||||
{
|
{
|
||||||
"type": "String",
|
"type": "String",
|
||||||
@ -1877,7 +1877,7 @@
|
|||||||
"sinces": [
|
"sinces": [
|
||||||
{
|
{
|
||||||
"name": "",
|
"name": "",
|
||||||
"description": "unreleased"
|
"description": "4.2.0"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"heading": {
|
"heading": {
|
||||||
@ -1899,7 +1899,7 @@
|
|||||||
"api": "requests",
|
"api": "requests",
|
||||||
"name": "GetSyncOffset",
|
"name": "GetSyncOffset",
|
||||||
"category": "sources",
|
"category": "sources",
|
||||||
"since": "unreleased",
|
"since": "4.2.0",
|
||||||
"returns": [
|
"returns": [
|
||||||
{
|
{
|
||||||
"type": "String",
|
"type": "String",
|
||||||
@ -1934,7 +1934,7 @@
|
|||||||
"sinces": [
|
"sinces": [
|
||||||
{
|
{
|
||||||
"name": "",
|
"name": "",
|
||||||
"description": "unreleased"
|
"description": "4.2.0"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"heading": {
|
"heading": {
|
||||||
@ -2792,7 +2792,7 @@
|
|||||||
"api": "requests",
|
"api": "requests",
|
||||||
"name": "ResetSceneItem",
|
"name": "ResetSceneItem",
|
||||||
"category": "sources",
|
"category": "sources",
|
||||||
"since": "unreleased",
|
"since": "4.2.0",
|
||||||
"params": [
|
"params": [
|
||||||
{
|
{
|
||||||
"type": "String (optional)",
|
"type": "String (optional)",
|
||||||
@ -2820,7 +2820,7 @@
|
|||||||
"sinces": [
|
"sinces": [
|
||||||
{
|
{
|
||||||
"name": "",
|
"name": "",
|
||||||
"description": "unreleased"
|
"description": "4.2.0"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"heading": {
|
"heading": {
|
||||||
@ -3248,7 +3248,7 @@
|
|||||||
"api": "requests",
|
"api": "requests",
|
||||||
"name": "StartStopReplayBuffer",
|
"name": "StartStopReplayBuffer",
|
||||||
"category": "replay buffer",
|
"category": "replay buffer",
|
||||||
"since": "unreleased",
|
"since": "4.2.0",
|
||||||
"names": [
|
"names": [
|
||||||
{
|
{
|
||||||
"name": "",
|
"name": "",
|
||||||
@ -3264,7 +3264,7 @@
|
|||||||
"sinces": [
|
"sinces": [
|
||||||
{
|
{
|
||||||
"name": "",
|
"name": "",
|
||||||
"description": "unreleased"
|
"description": "4.2.0"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"heading": {
|
"heading": {
|
||||||
@ -3281,7 +3281,7 @@
|
|||||||
"api": "requests",
|
"api": "requests",
|
||||||
"name": "StartReplayBuffer",
|
"name": "StartReplayBuffer",
|
||||||
"category": "replay buffer",
|
"category": "replay buffer",
|
||||||
"since": "unreleased",
|
"since": "4.2.0",
|
||||||
"names": [
|
"names": [
|
||||||
{
|
{
|
||||||
"name": "",
|
"name": "",
|
||||||
@ -3297,7 +3297,7 @@
|
|||||||
"sinces": [
|
"sinces": [
|
||||||
{
|
{
|
||||||
"name": "",
|
"name": "",
|
||||||
"description": "unreleased"
|
"description": "4.2.0"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"heading": {
|
"heading": {
|
||||||
@ -3314,7 +3314,7 @@
|
|||||||
"api": "requests",
|
"api": "requests",
|
||||||
"name": "StopReplayBuffer",
|
"name": "StopReplayBuffer",
|
||||||
"category": "replay buffer",
|
"category": "replay buffer",
|
||||||
"since": "unreleased",
|
"since": "4.2.0",
|
||||||
"names": [
|
"names": [
|
||||||
{
|
{
|
||||||
"name": "",
|
"name": "",
|
||||||
@ -3330,7 +3330,7 @@
|
|||||||
"sinces": [
|
"sinces": [
|
||||||
{
|
{
|
||||||
"name": "",
|
"name": "",
|
||||||
"description": "unreleased"
|
"description": "4.2.0"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"heading": {
|
"heading": {
|
||||||
@ -3347,7 +3347,7 @@
|
|||||||
"api": "requests",
|
"api": "requests",
|
||||||
"name": "SaveReplayBuffer",
|
"name": "SaveReplayBuffer",
|
||||||
"category": "replay buffer",
|
"category": "replay buffer",
|
||||||
"since": "unreleased",
|
"since": "4.2.0",
|
||||||
"names": [
|
"names": [
|
||||||
{
|
{
|
||||||
"name": "",
|
"name": "",
|
||||||
@ -3363,7 +3363,7 @@
|
|||||||
"sinces": [
|
"sinces": [
|
||||||
{
|
{
|
||||||
"name": "",
|
"name": "",
|
||||||
"description": "unreleased"
|
"description": "4.2.0"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"heading": {
|
"heading": {
|
||||||
|
@ -1,8 +1,8 @@
|
|||||||
<!-- This file was generated based on handlebars templates. Do not edit directly! -->
|
<!-- This file was generated based on handlebars templates. Do not edit directly! -->
|
||||||
|
|
||||||
# obs-websocket 4.2 protocol reference
|
# obs-websocket 4.2.0 protocol reference
|
||||||
|
|
||||||
**This is the reference for the latest version of obs-websocket. See the list below for older versions.**
|
**This is the reference for obs-websocket 4.2.0. See the list below for older versions.**
|
||||||
- [4.1.0 protocol reference](https://github.com/Palakis/obs-websocket/blob/4.1.0/PROTOCOL.md)
|
- [4.1.0 protocol reference](https://github.com/Palakis/obs-websocket/blob/4.1.0/PROTOCOL.md)
|
||||||
- [4.0.0 protocol reference](https://github.com/Palakis/obs-websocket/blob/4.0.0/PROTOCOL.md)
|
- [4.0.0 protocol reference](https://github.com/Palakis/obs-websocket/blob/4.0.0/PROTOCOL.md)
|
||||||
|
|
||||||
@ -447,7 +447,7 @@ _No additional response items._
|
|||||||
|
|
||||||
### ReplayStarting
|
### ReplayStarting
|
||||||
|
|
||||||
- Unreleased
|
- Added in v4.2.0
|
||||||
|
|
||||||
A request to start the replay buffer has been issued.
|
A request to start the replay buffer has been issued.
|
||||||
|
|
||||||
@ -459,7 +459,7 @@ _No additional response items._
|
|||||||
|
|
||||||
### ReplayStarted
|
### ReplayStarted
|
||||||
|
|
||||||
- Unreleased
|
- Added in v4.2.0
|
||||||
|
|
||||||
Replay Buffer started successfully
|
Replay Buffer started successfully
|
||||||
|
|
||||||
@ -471,7 +471,7 @@ _No additional response items._
|
|||||||
|
|
||||||
### ReplayStopping
|
### ReplayStopping
|
||||||
|
|
||||||
- Unreleased
|
- Added in v4.2.0
|
||||||
|
|
||||||
A request to start the replay buffer has been issued.
|
A request to start the replay buffer has been issued.
|
||||||
|
|
||||||
@ -483,7 +483,7 @@ _No additional response items._
|
|||||||
|
|
||||||
### ReplayStopped
|
### ReplayStopped
|
||||||
|
|
||||||
- Unreleased
|
- Added in v4.2.0
|
||||||
|
|
||||||
Replay Buffer stopped successfully
|
Replay Buffer stopped successfully
|
||||||
|
|
||||||
@ -879,7 +879,7 @@ Get the mute status of a specified source.
|
|||||||
|
|
||||||
### SetSyncOffset
|
### SetSyncOffset
|
||||||
|
|
||||||
- Unreleased
|
- Added in v4.2.0
|
||||||
|
|
||||||
Set the audio sync offset of a specified source.
|
Set the audio sync offset of a specified source.
|
||||||
|
|
||||||
@ -899,7 +899,7 @@ _No additional response items._
|
|||||||
|
|
||||||
### GetSyncOffset
|
### GetSyncOffset
|
||||||
|
|
||||||
- Unreleased
|
- Added in v4.2.0
|
||||||
|
|
||||||
Get the audio sync offset of a specified source.
|
Get the audio sync offset of a specified source.
|
||||||
|
|
||||||
@ -1147,7 +1147,7 @@ _No additional response items._
|
|||||||
|
|
||||||
### ResetSceneItem
|
### ResetSceneItem
|
||||||
|
|
||||||
- Unreleased
|
- Added in v4.2.0
|
||||||
|
|
||||||
Reset a source item.
|
Reset a source item.
|
||||||
|
|
||||||
@ -1345,7 +1345,7 @@ _No specified parameters._
|
|||||||
|
|
||||||
### StartStopReplayBuffer
|
### StartStopReplayBuffer
|
||||||
|
|
||||||
- Unreleased
|
- Added in v4.2.0
|
||||||
|
|
||||||
Toggle the Replay Buffer on/off.
|
Toggle the Replay Buffer on/off.
|
||||||
|
|
||||||
@ -1361,7 +1361,7 @@ _No additional response items._
|
|||||||
|
|
||||||
### StartReplayBuffer
|
### StartReplayBuffer
|
||||||
|
|
||||||
- Unreleased
|
- Added in v4.2.0
|
||||||
|
|
||||||
Start recording into the Replay Buffer.
|
Start recording into the Replay Buffer.
|
||||||
Will return an `error` if the Replay Buffer is already active or if the
|
Will return an `error` if the Replay Buffer is already active or if the
|
||||||
@ -1381,7 +1381,7 @@ _No additional response items._
|
|||||||
|
|
||||||
### StopReplayBuffer
|
### StopReplayBuffer
|
||||||
|
|
||||||
- Unreleased
|
- Added in v4.2.0
|
||||||
|
|
||||||
Stop recording into the Replay Buffer.
|
Stop recording into the Replay Buffer.
|
||||||
Will return an `error` if the Replay Buffer is not active.
|
Will return an `error` if the Replay Buffer is not active.
|
||||||
@ -1398,7 +1398,7 @@ _No additional response items._
|
|||||||
|
|
||||||
### SaveReplayBuffer
|
### SaveReplayBuffer
|
||||||
|
|
||||||
- Unreleased
|
- Added in v4.2.0
|
||||||
|
|
||||||
Save and flush the contents of the Replay Buffer to disk. This is
|
Save and flush the contents of the Replay Buffer to disk. This is
|
||||||
basically the same as triggering the "Save Replay Buffer" hotkey.
|
basically the same as triggering the "Save Replay Buffer" hotkey.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user