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

View File

@ -1,4 +1,5 @@
import logging import logging
from warnings import warn
from .baseclient import ObsClient from .baseclient import ObsClient
from .error import OBSSDKError, OBSSDKRequestError from .error import OBSSDKError, OBSSDKRequestError
@ -1938,3 +1939,55 @@ class ReqClient:
""" """
return self.send("GetMonitorList") return self.send("GetMonitorList")
def open_video_mix_projector(
self, video_mix_type, monitor_index=-1, projector_geometry=None
):
"""
Opens a projector for a specific output video mix.
:param videoMixType: Type of mix to open
:type videoMixType: str
:param monitorIndex: Monitor index, use GetMonitorList to obtain index
:type monitorIndex: int
:param projectorGeometry: Size/Position data for a windowed projector, in Qt Base64 encoded format. Mutually exclusive with monitorIndex
:type projectorGeometry: str
"""
warn(
"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.",
DeprecationWarning,
stacklevel=2,
)
payload = {
"videoMixType": video_mix_type,
"monitorIndex": monitor_index,
"projectorGeometry": projector_geometry,
}
self.send("OpenVideoMixProjector", payload)
def open_source_projector(
self, source_name, monitor_index=-1, projector_geometry=None
):
"""
Opens a projector for a source.
:param sourceName: Name of the source to open a projector for
:type sourceName: str
:param monitorIndex: Monitor index, use GetMonitorList to obtain index
:type monitorIndex: int
:param projectorGeometry: Size/Position data for a windowed projector, in Qt Base64 encoded format. Mutually exclusive with monitorIndex
:type projectorGeometry: str
"""
warn(
"open_source_projector request serves to provide feature parity with 4.x. It is very likely to be changed/deprecated in a future release.",
DeprecationWarning,
stacklevel=2,
)
payload = {
"sourceName": source_name,
"monitorIndex": monitor_index,
"projectorGeometry": projector_geometry,
}
self.send("OpenSourceProjector", payload)