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

Merge pull request #219 from christopher-dG/cdg/replaystopping

Browse Source 
docs: Fix ReplayStopping description
This commit is contained in:
Stéphane L 2018-05-27 18:33:16 +02:00 committed by Stéphane L
parent 7bd434e755
commit d03c4cc4b9
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/WSEvents.cpp
View File

@ -303,7 +303,7 @@ const char* WSEvents::GetRecordingTimecode() {
/** /**
* Indicates a scene change. * Indicates a scene change.
* *
* @return {String} `scene-name` The new scene. * @return {String} `scene-name` The new scene.
* @return {Array} `sources` List of sources in the new scene. * @return {Array} `sources` List of sources in the new scene.
* *
@ -334,7 +334,7 @@ void WSEvents::OnSceneChange() {
/** /**
* The scene list has been modified. * The scene list has been modified.
* Scenes have been added, removed, or renamed. * Scenes have been added, removed, or renamed.
* *
* @api events * @api events
* @name ScenesChanged * @name ScenesChanged
* @category scenes * @category scenes
@ -346,7 +346,7 @@ void WSEvents::OnSceneListChange() {
/** /**
* 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.
* *
* @api events * @api events
* @name SceneCollectionChanged * @name SceneCollectionChanged
* @category scenes * @category scenes
@ -367,7 +367,7 @@ void WSEvents::OnSceneCollectionChange() {
/** /**
* Triggered when a scene collection is created, added, renamed, or removed. * Triggered when a scene collection is created, added, renamed, or removed.
* *
* @api events * @api events
* @name SceneCollectionListChanged * @name SceneCollectionListChanged
* @category scenes * @category scenes
@ -468,7 +468,7 @@ void WSEvents::OnStreamStarted() {
/** /**
* A request to stop streaming has been issued. * A request to stop streaming has been issued.
* *
* @return {boolean} `preview-only` Always false (retrocompatibility). * @return {boolean} `preview-only` Always false (retrocompatibility).
* *
* @api events * @api events
@ -571,7 +571,7 @@ void WSEvents::OnReplayStarted() {
} }
/** /**
* A request to start the replay buffer has been issued. * A request to stop the replay buffer has been issued.
* *
* @api events * @api events
* @name ReplayStopping * @name ReplayStopping
@ -678,7 +678,7 @@ void WSEvents::StreamStatus() {
/** /**
* Emitted every 2 seconds after enabling it by calling SetHeartbeat. * Emitted every 2 seconds after enabling it by calling SetHeartbeat.
* *
* @return {boolean} `pulse` Toggles between every JSON meassage as an "I am alive" indicator. * @return {boolean} `pulse` Toggles between every JSON meassage as an "I am alive" indicator.
* @return {string (optional)} `current-profile` Current active profile. * @return {string (optional)} `current-profile` Current active profile.
* @return {string (optional)} `current-scene` Current active scene. * @return {string (optional)} `current-scene` Current active scene.
@ -690,7 +690,7 @@ void WSEvents::StreamStatus() {
* @return {int (optional)} `total-record-time` Total time (in seconds) since recording started. * @return {int (optional)} `total-record-time` Total time (in seconds) since recording started.
* @return {int (optional)} `total-record-bytes` Total bytes recorded since the recording started. * @return {int (optional)} `total-record-bytes` Total bytes recorded since the recording started.
* @return {int (optional)} `total-record-frames` Total frames recorded since the recording started. * @return {int (optional)} `total-record-frames` Total frames recorded since the recording started.
* *
* @api events * @api events
* @name Heartbeat * @name Heartbeat
* @category general * @category general