Compare commits

..

3 Commits

Author SHA1 Message Date
dc7bec3ed0 fix docstring. 2023-10-08 14:47:40 +01:00
e4a87609ee fix desc 2023-10-08 03:55:29 +01:00
79a056a5c8 adds projector methods with deprecation warning 2023-10-08 03:53:47 +01:00
3 changed files with 19 additions and 32 deletions

View File

@ -1946,24 +1946,16 @@ class ReqClient:
""" """
Opens a projector for a specific output video mix. Opens a projector for a specific output video mix.
The available mix types are: :param videoMixType: Type of mix to open
OBS_WEBSOCKET_VIDEO_MIX_TYPE_PREVIEW :type videoMixType: str
OBS_WEBSOCKET_VIDEO_MIX_TYPE_PROGRAM :param monitorIndex: Monitor index, use GetMonitorList to obtain index
OBS_WEBSOCKET_VIDEO_MIX_TYPE_MULTIVIEW :type monitorIndex: int
:param projectorGeometry: Size/Position data for a windowed projector, in Qt Base64 encoded format. Mutually exclusive with monitorIndex
:param video_mix_type: Type of mix to open. :type projectorGeometry: str
:type video_mix_type: str
:param monitor_index: Monitor index, use GetMonitorList to obtain index
:type monitor_index: int
:param projector_geometry:
Size/Position data for a windowed projector, in Qt Base64 encoded format.
Mutually exclusive with monitorIndex
:type projector_geometry: str
""" """
warn( warn(
"open_video_mix_projector request serves to provide feature parity with 4.x. " "open_video_mix_projector request serves to provide feature parity with 4.x. It is very likely to be changed/deprecated in a future release.",
"It is very likely to be changed/deprecated in a future release.",
DeprecationWarning, DeprecationWarning,
stacklevel=2, stacklevel=2,
) )
@ -1980,19 +1972,16 @@ class ReqClient:
""" """
Opens a projector for a source. Opens a projector for a source.
:param source_name: Name of the source to open a projector for :param sourceName: Name of the source to open a projector for
:type source_name: str :type sourceName: str
:param monitor_index: Monitor index, use GetMonitorList to obtain index :param monitorIndex: Monitor index, use GetMonitorList to obtain index
:type monitor_index: int :type monitorIndex: int
:param projector_geometry: :param projectorGeometry: Size/Position data for a windowed projector, in Qt Base64 encoded format. Mutually exclusive with monitorIndex
Size/Position data for a windowed projector, in Qt Base64 encoded format. :type projectorGeometry: str
Mutually exclusive with monitorIndex
:type projector_geometry: str
""" """
warn( warn(
"open_source_projector request serves to provide feature parity with 4.x. " "open_source_projector request serves to provide feature parity with 4.x. It is very likely to be changed/deprecated in a future release.",
"It is very likely to be changed/deprecated in a future release.",
DeprecationWarning, DeprecationWarning,
stacklevel=2, stacklevel=2,
) )

View File

@ -1 +1 @@
version = "1.6.1" version = "1.6.0"

View File

@ -15,9 +15,9 @@ class TestRequests:
resp = req_cl.get_hot_key_list() resp = req_cl.get_hot_key_list()
obsbasic_hotkey_list = [ obsbasic_hotkey_list = [
"OBSBasic.SelectScene", "OBSBasic.SelectScene",
"OBSBasic.QuickTransition.1", "OBSBasic.SelectScene",
"OBSBasic.QuickTransition.2", "OBSBasic.SelectScene",
"OBSBasic.QuickTransition.3", "OBSBasic.SelectScene",
"OBSBasic.StartStreaming", "OBSBasic.StartStreaming",
"OBSBasic.StopStreaming", "OBSBasic.StopStreaming",
"OBSBasic.ForceStopStreaming", "OBSBasic.ForceStopStreaming",
@ -25,17 +25,15 @@ class TestRequests:
"OBSBasic.StopRecording", "OBSBasic.StopRecording",
"OBSBasic.PauseRecording", "OBSBasic.PauseRecording",
"OBSBasic.UnpauseRecording", "OBSBasic.UnpauseRecording",
"OBSBasic.SplitFile",
"OBSBasic.StartReplayBuffer", "OBSBasic.StartReplayBuffer",
"OBSBasic.StopReplayBuffer", "OBSBasic.StopReplayBuffer",
"OBSBasic.StartVirtualCam", "OBSBasic.StartVirtualCam",
"OBSBasic.StopVirtualCam", "OBSBasic.StopVirtualCam",
"OBSBasic.EnablePreview", "OBSBasic.EnablePreview",
"OBSBasic.DisablePreview", "OBSBasic.DisablePreview",
"OBSBasic.EnablePreviewProgram",
"OBSBasic.DisablePreviewProgram",
"OBSBasic.ShowContextBar", "OBSBasic.ShowContextBar",
"OBSBasic.HideContextBar", "OBSBasic.HideContextBar",
"OBSBasic.TogglePreviewProgram",
"OBSBasic.Transition", "OBSBasic.Transition",
"OBSBasic.ResetStats", "OBSBasic.ResetStats",
"OBSBasic.Screenshot", "OBSBasic.Screenshot",