Mirrored_Repos/obs-websocket
1
0
Fork 0
mirror of https://github.com/Palakis/obs-websocket.git synced 2024-08-30 18:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(travis): Update protocol.md - 57bc0a2

Browse Source
This commit is contained in:
Travis CI 2017-10-27 08:32:34 +00:00 committed by Palakis
parent 57bc0a2b95
commit 11e2717809
2 changed files with 120 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/generated/comments.json
View File

@ -1669,6 +1669,7 @@
"name": "SetSourceRender", "name": "SetSourceRender",
"category": "sources", "category": "sources",
"since": "0.3", "since": "0.3",
"deprecated": "Since unreleased. Prefer the use of SetSceneItemProperties.",
"params": [ "params": [
{ {
"type": "String", "type": "String",
@ -1704,6 +1705,12 @@
"description": "0.3" "description": "0.3"
} }
], ],
"deprecateds": [
{
"name": "",
"description": "Since unreleased. Prefer the use of SetSceneItemProperties."
}
],
"heading": { "heading": {
"level": 2, "level": 2,
"text": "SetSourceRender" "text": "SetSourceRender"
@ -2090,6 +2097,7 @@
"name": "SetSceneItemPosition", "name": "SetSceneItemPosition",
"category": "sources", "category": "sources",
"since": "4.0.0", "since": "4.0.0",
"deprecated": "Since unreleased. Prefer the use of SetSceneItemProperties.",
"params": [ "params": [
{ {
"type": "String (optional)", "type": "String (optional)",
@ -2130,6 +2138,12 @@
"description": "4.0.0" "description": "4.0.0"
} }
], ],
"deprecateds": [
{
"name": "",
"description": "Since unreleased. Prefer the use of SetSceneItemProperties."
}
],
"heading": { "heading": {
"level": 2, "level": 2,
"text": "SetSceneItemPosition" "text": "SetSceneItemPosition"
@ -2152,6 +2166,7 @@
"name": "SetSceneItemTransform", "name": "SetSceneItemTransform",
"category": "sources", "category": "sources",
"since": "4.0.0", "since": "4.0.0",
"deprecated": "Since unreleased. Prefer the use of SetSceneItemProperties.",
"params": [ "params": [
{ {
"type": "String (optional)", "type": "String (optional)",
@ -2197,6 +2212,12 @@
"description": "4.0.0" "description": "4.0.0"
} }
], ],
"deprecateds": [
{
"name": "",
"description": "Since unreleased. Prefer the use of SetSceneItemProperties."
}
],
"heading": { "heading": {
"level": 2, "level": 2,
"text": "SetSceneItemTransform" "text": "SetSceneItemTransform"
@ -2220,6 +2241,7 @@
"name": "SetSceneItemCrop", "name": "SetSceneItemCrop",
"category": "sources", "category": "sources",
"since": "4.1.0", "since": "4.1.0",
"deprecated": "Since unreleased. Prefer the use of SetSceneItemProperties.",
"params": [ "params": [
{ {
"type": "String (optional)", "type": "String (optional)",
@ -2270,6 +2292,12 @@
"description": "4.1.0" "description": "4.1.0"
} }
], ],
"deprecateds": [
{
"name": "",
"description": "Since unreleased. Prefer the use of SetSceneItemProperties."
}
],
"heading": { "heading": {
"level": 2, "level": 2,
"text": "SetSceneItemCrop" "text": "SetSceneItemCrop"

93
docs/generated/protocol.md
View File

@ -179,6 +179,7 @@ Additional fields may be present in the event message depending on the event typ
### SwitchScenes ### SwitchScenes
- Added in v0.3 - Added in v0.3
Indicates a scene change. Indicates a scene change.
@ -195,6 +196,7 @@ Indicates a scene change.
### ScenesChanged ### ScenesChanged
- Added in v0.3 - Added in v0.3
The scene list has been modified. The scene list has been modified.
@ -208,6 +210,7 @@ _No additional response items._
### SceneCollectionChanged ### SceneCollectionChanged
- Added in v4.0.0 - Added in v4.0.0
Triggered when switching to another scene collection or when renaming the current scene collection. Triggered when switching to another scene collection or when renaming the current scene collection.
@ -220,6 +223,7 @@ _No additional response items._
### SceneCollectionListChanged ### SceneCollectionListChanged
- Added in v4.0.0 - Added in v4.0.0
Triggered when a scene collection is created, added, renamed, or removed. Triggered when a scene collection is created, added, renamed, or removed.
@ -234,6 +238,7 @@ _No additional response items._
### SwitchTransition ### SwitchTransition
- Added in v4.0.0 - Added in v4.0.0
The active transition has been changed. The active transition has been changed.
@ -249,6 +254,7 @@ The active transition has been changed.
### TransitionListChanged ### TransitionListChanged
- Added in v4.0.0 - Added in v4.0.0
The list of available transitions has been modified. The list of available transitions has been modified.
@ -262,6 +268,7 @@ _No additional response items._
### TransitionDurationChanged ### TransitionDurationChanged
- Added in v4.0.0 - Added in v4.0.0
The active transition duration has been changed. The active transition duration has been changed.
@ -277,6 +284,7 @@ The active transition duration has been changed.
### TransitionBegin ### TransitionBegin
- Added in v4.0.0 - Added in v4.0.0
A transition (other than "cut") has begun. A transition (other than "cut") has begun.
@ -295,6 +303,7 @@ A transition (other than "cut") has begun.
### ProfileChanged ### ProfileChanged
- Added in v4.0.0 - Added in v4.0.0
Triggered when switching to another profile or when renaming the current profile. Triggered when switching to another profile or when renaming the current profile.
@ -307,6 +316,7 @@ _No additional response items._
### ProfileListChanged ### ProfileListChanged
- Added in v4.0.0 - Added in v4.0.0
Triggered when a profile is created, added, renamed, or removed. Triggered when a profile is created, added, renamed, or removed.
@ -321,6 +331,7 @@ _No additional response items._
### StreamStarting ### StreamStarting
- Added in v0.3 - Added in v0.3
A request to start streaming has been issued. A request to start streaming has been issued.
@ -336,6 +347,7 @@ A request to start streaming has been issued.
### StreamStarted ### StreamStarted
- Added in v0.3 - Added in v0.3
Streaming started successfully. Streaming started successfully.
@ -348,6 +360,7 @@ _No additional response items._
### StreamStopping ### StreamStopping
- Added in v0.3 - Added in v0.3
A request to stop streaming has been issued. A request to stop streaming has been issued.
@ -363,6 +376,7 @@ A request to stop streaming has been issued.
### StreamStopped ### StreamStopped
- Added in v0.3 - Added in v0.3
Streaming stopped successfully. Streaming stopped successfully.
@ -375,6 +389,7 @@ _No additional response items._
### StreamStatus ### StreamStatus
- Added in v0.3 - Added in v0.3
Emit every 2 seconds. Emit every 2 seconds.
@ -401,6 +416,7 @@ Emit every 2 seconds.
### RecordingStarting ### RecordingStarting
- Added in v0.3 - Added in v0.3
A request to start recording has been issued. A request to start recording has been issued.
@ -413,6 +429,7 @@ _No additional response items._
### RecordingStarted ### RecordingStarted
- Added in v0.3 - Added in v0.3
Recording started successfully. Recording started successfully.
@ -425,6 +442,7 @@ _No additional response items._
### RecordingStopping ### RecordingStopping
- Added in v0.3 - Added in v0.3
A request to stop recording has been issued. A request to stop recording has been issued.
@ -437,6 +455,7 @@ _No additional response items._
### RecordingStopped ### RecordingStopped
- Added in v0.3 - Added in v0.3
Recording stopped successfully. Recording stopped successfully.
@ -451,6 +470,7 @@ _No additional response items._
### ReplayStarting ### ReplayStarting
- Added in v4.2.0 - 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.
@ -463,6 +483,7 @@ _No additional response items._
### ReplayStarted ### ReplayStarted
- Added in v4.2.0 - Added in v4.2.0
Replay Buffer started successfully Replay Buffer started successfully
@ -475,6 +496,7 @@ _No additional response items._
### ReplayStopping ### ReplayStopping
- Added in v4.2.0 - 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.
@ -487,6 +509,7 @@ _No additional response items._
### ReplayStopped ### ReplayStopped
- Added in v4.2.0 - Added in v4.2.0
Replay Buffer stopped successfully Replay Buffer stopped successfully
@ -501,6 +524,7 @@ _No additional response items._
### Exiting ### Exiting
- Added in v0.3 - Added in v0.3
OBS is exiting. OBS is exiting.
@ -515,6 +539,7 @@ _No additional response items._
### Heartbeat ### Heartbeat
- Added in v - Added in v
Emitted every 2 seconds after enabling it by calling SetHeartbeat. Emitted every 2 seconds after enabling it by calling SetHeartbeat.
@ -542,6 +567,7 @@ Emitted every 2 seconds after enabling it by calling SetHeartbeat.
### SourceOrderChanged ### SourceOrderChanged
- Added in v4.0.0 - Added in v4.0.0
Scene items have been reordered. Scene items have been reordered.
@ -557,6 +583,7 @@ Scene items have been reordered.
### SceneItemAdded ### SceneItemAdded
- Added in v4.0.0 - Added in v4.0.0
An item has been added to the current scene. An item has been added to the current scene.
@ -573,6 +600,7 @@ An item has been added to the current scene.
### SceneItemRemoved ### SceneItemRemoved
- Added in v4.0.0 - Added in v4.0.0
An item has been removed from the current scene. An item has been removed from the current scene.
@ -589,6 +617,7 @@ An item has been removed from the current scene.
### SceneItemVisibilityChanged ### SceneItemVisibilityChanged
- Added in v4.0.0 - Added in v4.0.0
An item's visibility has been toggled. An item's visibility has been toggled.
@ -608,6 +637,7 @@ An item's visibility has been toggled.
### PreviewSceneChanged ### PreviewSceneChanged
- Added in v4.1.0 - Added in v4.1.0
The selected preview scene has changed (only available in Studio Mode). The selected preview scene has changed (only available in Studio Mode).
@ -624,6 +654,7 @@ The selected preview scene has changed (only available in Studio Mode).
### StudioModeSwitched ### StudioModeSwitched
- Added in v4.1.0 - Added in v4.1.0
Studio Mode has been enabled or disabled. Studio Mode has been enabled or disabled.
@ -657,6 +688,7 @@ Additional information may be required/returned depending on the request type. S
### GetVersion ### GetVersion
- Added in v0.3 - Added in v0.3
Returns the latest version of the plugin and the API. Returns the latest version of the plugin and the API.
@ -679,6 +711,7 @@ _No specified parameters._
### GetAuthRequired ### GetAuthRequired
- Added in v0.3 - Added in v0.3
Tells the client if authentication is required. If so, returns authentication parameters `challenge` Tells the client if authentication is required. If so, returns authentication parameters `challenge`
@ -701,6 +734,7 @@ _No specified parameters._
### Authenticate ### Authenticate
- Added in v0.3 - Added in v0.3
Attempt to authenticate the client to the server. Attempt to authenticate the client to the server.
@ -720,6 +754,7 @@ _No additional response items._
### SetHeartbeat ### SetHeartbeat
- Added in v - Added in v
Enable/disable sending of the Heartbeat event Enable/disable sending of the Heartbeat event
@ -741,6 +776,7 @@ _No additional response items._
### SetCurrentScene ### SetCurrentScene
- Added in v0.3 - Added in v0.3
Switch to the specified scene. Switch to the specified scene.
@ -760,6 +796,7 @@ _No additional response items._
### GetCurrentScene ### GetCurrentScene
- Added in v0.3 - Added in v0.3
Get the current scene's name and source items. Get the current scene's name and source items.
@ -780,6 +817,7 @@ _No specified parameters._
### GetSceneList ### GetSceneList
- Added in v0.3 - Added in v0.3
Get a list of scenes in the currently active profile. Get a list of scenes in the currently active profile.
@ -802,6 +840,8 @@ _No specified parameters._
### SetSourceRender ### SetSourceRender
- **⚠️ Deprecated. Since unreleased. Prefer the use of SetSceneItemProperties. ⚠️**
- Added in v0.3 - Added in v0.3
Show or hide a specified source item in a specified scene. Show or hide a specified source item in a specified scene.
@ -823,6 +863,7 @@ _No additional response items._
### SetVolume ### SetVolume
- Added in v4.0.0 - Added in v4.0.0
Set the volume of the specified source. Set the volume of the specified source.
@ -843,6 +884,7 @@ _No additional response items._
### GetVolume ### GetVolume
- Added in v4.0.0 - Added in v4.0.0
Get the volume of the specified source. Get the volume of the specified source.
@ -867,6 +909,7 @@ Get the volume of the specified source.
### ToggleMute ### ToggleMute
- Added in v4.0.0 - Added in v4.0.0
Inverts the mute status of a specified source. Inverts the mute status of a specified source.
@ -886,6 +929,7 @@ _No additional response items._
### SetMute ### SetMute
- Added in v4.0.0 - Added in v4.0.0
Sets the mute status of a specified source. Sets the mute status of a specified source.
@ -906,6 +950,7 @@ _No additional response items._
### GetMute ### GetMute
- Added in v4.0.0 - Added in v4.0.0
Get the mute status of a specified source. Get the mute status of a specified source.
@ -929,6 +974,7 @@ Get the mute status of a specified source.
### SetSyncOffset ### SetSyncOffset
- Added in v4.2.0 - Added in v4.2.0
Set the audio sync offset of a specified source. Set the audio sync offset of a specified source.
@ -949,6 +995,7 @@ _No additional response items._
### GetSyncOffset ### GetSyncOffset
- Added in v4.2.0 - Added in v4.2.0
Get the audio sync offset of a specified source. Get the audio sync offset of a specified source.
@ -972,6 +1019,8 @@ Get the audio sync offset of a specified source.
### SetSceneItemPosition ### SetSceneItemPosition
- **⚠️ Deprecated. Since unreleased. Prefer the use of SetSceneItemProperties. ⚠️**
- Added in v4.0.0 - Added in v4.0.0
Sets the coordinates of a specified source item. Sets the coordinates of a specified source item.
@ -994,6 +1043,8 @@ _No additional response items._
### SetSceneItemTransform ### SetSceneItemTransform
- **⚠️ Deprecated. Since unreleased. Prefer the use of SetSceneItemProperties. ⚠️**
- Added in v4.0.0 - Added in v4.0.0
Set the transform of the specified source item. Set the transform of the specified source item.
@ -1017,6 +1068,8 @@ _No additional response items._
### SetSceneItemCrop ### SetSceneItemCrop
- **⚠️ Deprecated. Since unreleased. Prefer the use of SetSceneItemProperties. ⚠️**
- Added in v4.1.0 - Added in v4.1.0
Sets the crop coordinates of the specified source item. Sets the crop coordinates of the specified source item.
@ -1041,6 +1094,7 @@ _No additional response items._
### GetTextGDIPlusProperties ### GetTextGDIPlusProperties
- Added in v4.1.0 - Added in v4.1.0
Get the current properties of a Text GDI Plus source. Get the current properties of a Text GDI Plus source.
@ -1091,6 +1145,7 @@ Get the current properties of a Text GDI Plus source.
### SetTextGDIPlusProperties ### SetTextGDIPlusProperties
- Added in v4.1.0 - Added in v4.1.0
Get the current properties of a Text GDI Plus source. Get the current properties of a Text GDI Plus source.
@ -1139,6 +1194,7 @@ _No additional response items._
### GetBrowserSourceProperties ### GetBrowserSourceProperties
- Added in v4.1.0 - Added in v4.1.0
Get current properties for a Browser Source. Get current properties for a Browser Source.
@ -1169,6 +1225,7 @@ Get current properties for a Browser Source.
### SetBrowserSourceProperties ### SetBrowserSourceProperties
- Added in v4.1.0 - Added in v4.1.0
Set current properties for a Browser Source. Set current properties for a Browser Source.
@ -1197,6 +1254,7 @@ _No additional response items._
### ResetSceneItem ### ResetSceneItem
- Added in v4.2.0 - Added in v4.2.0
Reset a source item. Reset a source item.
@ -1219,6 +1277,7 @@ _No additional response items._
### GetStreamingStatus ### GetStreamingStatus
- Added in v0.3 - Added in v0.3
Get current streaming and recording status. Get current streaming and recording status.
@ -1242,6 +1301,7 @@ _No specified parameters._
### StartStopStreaming ### StartStopStreaming
- Added in v0.3 - Added in v0.3
Toggle streaming on or off. Toggle streaming on or off.
@ -1258,6 +1318,7 @@ _No additional response items._
### StartStreaming ### StartStreaming
- Added in v4.1.0 - Added in v4.1.0
Start streaming. Start streaming.
@ -1286,6 +1347,7 @@ _No additional response items._
### StopStreaming ### StopStreaming
- Added in v4.1.0 - Added in v4.1.0
Stop streaming. Stop streaming.
@ -1305,6 +1367,7 @@ _No additional response items._
### StartStopRecording ### StartStopRecording
- Added in v0.3 - Added in v0.3
Toggle recording on or off. Toggle recording on or off.
@ -1321,6 +1384,7 @@ _No additional response items._
### StartRecording ### StartRecording
- Added in v4.1.0 - Added in v4.1.0
Start recording. Start recording.
@ -1338,6 +1402,7 @@ _No additional response items._
### StopRecording ### StopRecording
- Added in v4.1.0 - Added in v4.1.0
Stop recording. Stop recording.
@ -1355,6 +1420,7 @@ _No additional response items._
### SetRecordingFolder ### SetRecordingFolder
- Added in v4.1.0 - Added in v4.1.0
Change the current recording folder. Change the current recording folder.
@ -1374,6 +1440,7 @@ _No additional response items._
### GetRecordingFolder ### GetRecordingFolder
- Added in v4.1.0 - Added in v4.1.0
Get the path of the current recording folder. Get the path of the current recording folder.
@ -1395,6 +1462,7 @@ _No specified parameters._
### StartStopReplayBuffer ### StartStopReplayBuffer
- Added in v4.2.0 - Added in v4.2.0
Toggle the Replay Buffer on/off. Toggle the Replay Buffer on/off.
@ -1411,6 +1479,7 @@ _No additional response items._
### StartReplayBuffer ### StartReplayBuffer
- Added in v4.2.0 - Added in v4.2.0
Start recording into the Replay Buffer. Start recording into the Replay Buffer.
@ -1431,6 +1500,7 @@ _No additional response items._
### StopReplayBuffer ### StopReplayBuffer
- Added in v4.2.0 - Added in v4.2.0
Stop recording into the Replay Buffer. Stop recording into the Replay Buffer.
@ -1448,6 +1518,7 @@ _No additional response items._
### SaveReplayBuffer ### SaveReplayBuffer
- Added in v4.2.0 - 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
@ -1468,6 +1539,7 @@ _No additional response items._
### GetTransitionList ### GetTransitionList
- Added in v4.1.0 - Added in v4.1.0
List of all transitions available in the frontend's dropdown menu. List of all transitions available in the frontend's dropdown menu.
@ -1489,6 +1561,7 @@ _No specified parameters._
### GetCurrentTransition ### GetCurrentTransition
- Added in v0.3 - Added in v0.3
Get the name of the currently selected transition in the frontend's dropdown menu. Get the name of the currently selected transition in the frontend's dropdown menu.
@ -1509,6 +1582,7 @@ _No specified parameters._
### SetCurrentTransition ### SetCurrentTransition
- Added in v0.3 - Added in v0.3
Set the active transition. Set the active transition.
@ -1528,6 +1602,7 @@ _No additional response items._
### SetTransitionDuration ### SetTransitionDuration
- Added in v4.0.0 - Added in v4.0.0
Set the duration of the currently selected transition if supported. Set the duration of the currently selected transition if supported.
@ -1547,6 +1622,7 @@ _No additional response items._
### GetTransitionDuration ### GetTransitionDuration
- Added in v4.1.0 - Added in v4.1.0
Get the duration of the currently selected transition if supported. Get the duration of the currently selected transition if supported.
@ -1568,6 +1644,7 @@ _No specified parameters._
### SetCurrentSceneCollection ### SetCurrentSceneCollection
- Added in v4.0.0 - Added in v4.0.0
Change the active scene collection. Change the active scene collection.
@ -1587,6 +1664,7 @@ _No additional response items._
### GetCurrentSceneCollection ### GetCurrentSceneCollection
- Added in v4.0.0 - Added in v4.0.0
Get the name of the current scene collection. Get the name of the current scene collection.
@ -1608,6 +1686,7 @@ _No specified parameters._
### SetCurrentProfile ### SetCurrentProfile
- Added in v4.0.0 - Added in v4.0.0
Set the currently active profile. Set the currently active profile.
@ -1627,6 +1706,7 @@ _No additional response items._
### GetCurrentProfile ### GetCurrentProfile
- Added in v4.0.0 - Added in v4.0.0
Get the name of the current profile. Get the name of the current profile.
@ -1646,6 +1726,7 @@ _No specified parameters._
### ListProfiles ### ListProfiles
- Added in v4.0.0 - Added in v4.0.0
Get a list of available profiles. Get a list of available profiles.
@ -1667,6 +1748,7 @@ _No specified parameters._
### SetStreamSettings ### SetStreamSettings
- Added in v4.1.0 - Added in v4.1.0
Sets one or more attributes of the current streaming server settings. Any options not passed will remain unchanged. Returns the updated settings in response. If 'type' is different than the current streaming service type, all settings are required. Returns the full settings of the stream (the same as GetStreamSettings). Sets one or more attributes of the current streaming server settings. Any options not passed will remain unchanged. Returns the updated settings in response. If 'type' is different than the current streaming service type, all settings are required. Returns the full settings of the stream (the same as GetStreamSettings).
@ -1693,6 +1775,7 @@ _No additional response items._
### GetStreamSettings ### GetStreamSettings
- Added in v4.1.0 - Added in v4.1.0
Get the current streaming server settings. Get the current streaming server settings.
@ -1718,6 +1801,7 @@ _No specified parameters._
### SaveStreamSettings ### SaveStreamSettings
- Added in v4.1.0 - Added in v4.1.0
Save the current streaming server settings to disk. Save the current streaming server settings to disk.
@ -1736,6 +1820,7 @@ _No additional response items._
### GetStudioModeStatus ### GetStudioModeStatus
- Added in v4.1.0 - Added in v4.1.0
Indicates if Studio Mode is currently enabled. Indicates if Studio Mode is currently enabled.
@ -1755,6 +1840,7 @@ _No specified parameters._
### GetPreviewScene ### GetPreviewScene
- Added in v4.1.0 - Added in v4.1.0
Get the name of the currently previewed scene and its list of sources. Get the name of the currently previewed scene and its list of sources.
@ -1776,6 +1862,7 @@ _No specified parameters._
### SetPreviewScene ### SetPreviewScene
- Added in v4.1.0 - Added in v4.1.0
Set the active preview scene. Set the active preview scene.
@ -1796,6 +1883,7 @@ _No additional response items._
### TransitionToProgram ### TransitionToProgram
- Added in v4.1.0 - Added in v4.1.0
Transitions the currently previewed scene to the main output. Transitions the currently previewed scene to the main output.
@ -1818,6 +1906,7 @@ _No additional response items._
### EnableStudioMode ### EnableStudioMode
- Added in v4.1.0 - Added in v4.1.0
Enables Studio Mode. Enables Studio Mode.
@ -1834,6 +1923,7 @@ _No additional response items._
### DisableStudioMode ### DisableStudioMode
- Added in v4.1.0 - Added in v4.1.0
Disables Studio Mode. Disables Studio Mode.
@ -1850,6 +1940,7 @@ _No additional response items._
### ToggleStudioMode ### ToggleStudioMode
- Added in v4.1.0 - Added in v4.1.0
Toggles Studio Mode. Toggles Studio Mode.
@ -1866,6 +1957,7 @@ _No additional response items._
### GetSpecialSources ### GetSpecialSources
- Added in v4.1.0 - Added in v4.1.0
Get configured special sources like Desktop Audio and Mic/Aux sources. Get configured special sources like Desktop Audio and Mic/Aux sources.
@ -1887,4 +1979,3 @@ _No specified parameters._
--- ---