소스 검색

docs/sphinx: Add missing obs_frontend_open_projector

Andrew Woodward 5 년 전
부모
커밋
ae9b7eaa9a
1개의 변경된 파일9개의 추가작업 그리고 0개의 파일을 삭제
  1. 9 0
      docs/sphinx/reference-frontend-api.rst

+ 9 - 0
docs/sphinx/reference-frontend-api.rst

@@ -454,6 +454,15 @@ Functions
 
 ---------------------------------------
 
+.. function:: void obs_frontend_open_projector(const char *type, int monitor, const char *geometry, const char *name)
+
+   :param type:     "Preview", "Source", "Scene", "StudioProgram", or "Multiview" (case insensitive).
+   :param monitor:  Monitor to open the projector on. If -1, opens a window.
+   :param geometry: If *monitor* is -1, size and position of the projector window. Encoded in Base64 using Qt's geometry encoding.
+   :param name:     If *type* is "Source" or "Scene", name of the source or scene to be displayed.
+
+---------------------------------------
+
 .. function:: void obs_frontend_save(void)
 
    Saves the current scene collection.