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: more specific version number + tag unreleased methods/events

Browse Source
This commit is contained in:
Stéphane L 2017-09-08 21:42:13 +02:00
parent c3346f9192
commit 87b47689eb
3 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
WSEvents.cpp
View File

@ -534,7 +534,7 @@ void WSEvents::OnRecordingStopped() {
* @api events
* @name ReplayStarting
* @category replay buffer
* @since unreleased
* @since 4.2.0
*/
void WSEvents::OnReplayStarting() {
broadcastUpdate("ReplayStarting");
@ -546,7 +546,7 @@ void WSEvents::OnReplayStarting() {
* @api events
* @name ReplayStarted
* @category replay buffer
* @since unreleased
* @since 4.2.0
*/
void WSEvents::OnReplayStarted() {
broadcastUpdate("ReplayStarted");
@ -558,7 +558,7 @@ void WSEvents::OnReplayStarted() {
* @api events
* @name ReplayStopping
* @category replay buffer
* @since unreleased
* @since 4.2.0
*/
void WSEvents::OnReplayStopping() {
broadcastUpdate("ReplayStopping");
@ -570,7 +570,7 @@ void WSEvents::OnReplayStopping() {
* @api events
* @name ReplayStopped
* @category replay buffer
* @since unreleased
* @since 4.2.0
*/
void WSEvents::OnReplayStopped() {
broadcastUpdate("ReplayStopped");

14
WSRequestHandler.cpp
View File

@ -670,7 +670,7 @@ void WSRequestHandler::HandleStopRecording(WSRequestHandler* req) {
* @api requests
* @name StartStopReplayBuffer
* @category replay buffer
* @since unreleased
* @since 4.2.0
*/
void WSRequestHandler::HandleStartStopReplayBuffer(WSRequestHandler* req) {
if (obs_frontend_replay_buffer_active()) {
@ -695,7 +695,7 @@ void WSRequestHandler::HandleStartStopReplayBuffer(WSRequestHandler* req) {
* @api requests
* @name StartReplayBuffer
* @category replay buffer
* @since unreleased
* @since 4.2.0
*/
void WSRequestHandler::HandleStartReplayBuffer(WSRequestHandler* req) {
if (!Utils::ReplayBufferEnabled()) {
@ -724,7 +724,7 @@ void WSRequestHandler::HandleStartReplayBuffer(WSRequestHandler* req) {
* @api requests
* @name StopReplayBuffer
* @category replay buffer
* @since unreleased
* @since 4.2.0
*/
void WSRequestHandler::HandleStopReplayBuffer(WSRequestHandler* req) {
if (obs_frontend_replay_buffer_active() == true) {
@ -743,7 +743,7 @@ void WSRequestHandler::HandleStopReplayBuffer(WSRequestHandler* req) {
* @api requests
* @name SaveReplayBuffer
* @category replay buffer
* @since unreleased
* @since 4.2.0
*/
void WSRequestHandler::HandleSaveReplayBuffer(WSRequestHandler* req) {
if (!obs_frontend_replay_buffer_active()) {
@ -1091,7 +1091,7 @@ void WSRequestHandler::HandleGetMute(WSRequestHandler* req) {
* @api requests
* @name SetSyncOffset
* @category sources
* @since unreleased
* @since 4.2.0
*/
void WSRequestHandler::HandleSetSyncOffset(WSRequestHandler* req) {
if (!req->hasField("source") || !req->hasField("offset")) {
@ -1130,7 +1130,7 @@ void WSRequestHandler::HandleSetSyncOffset(WSRequestHandler* req) {
* @api requests
* @name GetSyncOffset
* @category sources
* @since unreleased
* @since 4.2.0
*/
void WSRequestHandler::HandleGetSyncOffset(WSRequestHandler* req) {
if (!req->hasField("source")) {
@ -2288,7 +2288,7 @@ void WSRequestHandler::HandleSetBrowserSourceProperties(WSRequestHandler* req) {
* @api requests
* @name ResetSceneItem
* @category sources
* @since unreleased
* @since 4.2.0
*/
void WSRequestHandler::HandleResetSceneItem(WSRequestHandler* req) {
if (!req->hasField("item")) {

4
docs/partials/introduction.md
View File

@ -1,6 +1,6 @@
# 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.0.0 protocol reference](https://github.com/Palakis/obs-websocket/blob/4.0.0/PROTOCOL.md)