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: Document ObsMediaInputAction

Browse Source
This commit is contained in:
tt2468 2021-12-28 18:57:02 -08:00
parent 9385a2449e
commit 964e91bbd7
2 changed files with 64 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/process_comments.py
View File

@ -122,7 +122,7 @@ for comment in comments_raw:
enumValue = field_to_string(comment['enumValue']) enumValue = field_to_string(comment['enumValue'])
enum['enumValue'] = int(enumValue) if enumValue.isdigit() else enumValue enum['enumValue'] = int(enumValue) if enumValue.isdigit() else enumValue
else: else:
enum['enumValue'] = None enum['enumValue'] = enum['enumIdentifier']
if enumType not in enums_raw: if enumType not in enums_raw:
enums_raw[enumType] = {'enumIdentifiers': [enum]} enums_raw[enumType] = {'enumIdentifiers': [enum]}

63
src/utils/Obs.h
View File

@ -77,12 +77,75 @@ enum ObsOutputState {
}; };
enum ObsMediaInputAction { enum ObsMediaInputAction {
/**
* No action.
*
* @enumIdentifier OBS_WEBSOCKET_MEDIA_INPUT_ACTION_NONE
* @enumType ObsMediaInputAction
* @rpcVersion 1
* @initialVersion 5.0.0
* @api enums
*/
OBS_WEBSOCKET_MEDIA_INPUT_ACTION_NONE, OBS_WEBSOCKET_MEDIA_INPUT_ACTION_NONE,
/**
* Play the media input.
*
* @enumIdentifier OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PLAY
* @enumType ObsMediaInputAction
* @rpcVersion 1
* @initialVersion 5.0.0
* @api enums
*/
OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PLAY, OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PLAY,
/**
* Pause the media input.
*
* @enumIdentifier OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PAUSE
* @enumType ObsMediaInputAction
* @rpcVersion 1
* @initialVersion 5.0.0
* @api enums
*/
OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PAUSE, OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PAUSE,
/**
* Stop the media input.
*
* @enumIdentifier OBS_WEBSOCKET_MEDIA_INPUT_ACTION_STOP
* @enumType ObsMediaInputAction
* @rpcVersion 1
* @initialVersion 5.0.0
* @api enums
*/
OBS_WEBSOCKET_MEDIA_INPUT_ACTION_STOP, OBS_WEBSOCKET_MEDIA_INPUT_ACTION_STOP,
/**
* Restart the media input.
*
* @enumIdentifier OBS_WEBSOCKET_MEDIA_INPUT_ACTION_RESTART
* @enumType ObsMediaInputAction
* @rpcVersion 1
* @initialVersion 5.0.0
* @api enums
*/
OBS_WEBSOCKET_MEDIA_INPUT_ACTION_RESTART, OBS_WEBSOCKET_MEDIA_INPUT_ACTION_RESTART,
/**
* Go to the next playlist item.
*
* @enumIdentifier OBS_WEBSOCKET_MEDIA_INPUT_ACTION_NEXT
* @enumType ObsMediaInputAction
* @rpcVersion 1
* @initialVersion 5.0.0
* @api enums
*/
OBS_WEBSOCKET_MEDIA_INPUT_ACTION_NEXT, OBS_WEBSOCKET_MEDIA_INPUT_ACTION_NEXT,
/**
* Go to the previous playlist item.
*
* @enumIdentifier OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PREVIOUS
* @enumType ObsMediaInputAction
* @rpcVersion 1
* @initialVersion 5.0.0
* @api enums
*/
OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PREVIOUS, OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PREVIOUS,
}; };