| /* |
| * Copyright (c) 2014 The WebRTC project authors. All Rights Reserved. |
| * |
| * Use of this source code is governed by a BSD-style license |
| * that can be found in the LICENSE file in the root of the source |
| * tree. An additional intellectual property rights grant can be found |
| * in the file PATENTS. All contributing project authors may |
| * be found in the AUTHORS file in the root of the source tree. |
| */ |
| |
| #ifndef MODULES_DESKTOP_CAPTURE_MAC_WINDOW_LIST_UTILS_H_ |
| #define MODULES_DESKTOP_CAPTURE_MAC_WINDOW_LIST_UTILS_H_ |
| |
| #include <ApplicationServices/ApplicationServices.h> |
| |
| #include <string> |
| #include "api/function_view.h" |
| #include "modules/desktop_capture/desktop_capture_types.h" |
| #include "modules/desktop_capture/desktop_capturer.h" |
| #include "modules/desktop_capture/desktop_geometry.h" |
| #include "modules/desktop_capture/mac/desktop_configuration.h" |
| |
| namespace webrtc { |
| |
| // Iterates all on-screen windows in decreasing z-order and sends them |
| // one-by-one to |on_window| function. If |on_window| returns false, this |
| // function returns immediately. GetWindowList() returns false if native APIs |
| // failed. Menus, dock (if |only_zero_layer|), minimized windows (if |
| // |ignore_minimized| is true) and any windows which do not have a valid window |
| // id or title will be ignored. |
| bool GetWindowList(rtc::FunctionView<bool(CFDictionaryRef)> on_window, |
| bool ignore_minimized, |
| bool only_zero_layer); |
| |
| // Another helper function to get the on-screen windows. |
| bool GetWindowList(DesktopCapturer::SourceList* windows, |
| bool ignore_minimized, |
| bool only_zero_layer); |
| |
| // Returns true if the window is occupying a full screen. |
| bool IsWindowFullScreen(const MacDesktopConfiguration& desktop_config, |
| CFDictionaryRef window); |
| |
| // Returns true if the window is occupying a full screen. |
| bool IsWindowFullScreen(const MacDesktopConfiguration& desktop_config, |
| CGWindowID id); |
| |
| // Returns true if the |window| is on screen. This function returns false if |
| // native APIs fail. |
| bool IsWindowOnScreen(CFDictionaryRef window); |
| |
| // Returns true if the window is on screen. This function returns false if |
| // native APIs fail or |id| cannot be found. |
| bool IsWindowOnScreen(CGWindowID id); |
| |
| // Returns utf-8 encoded title of |window|. If |window| is not a window or no |
| // valid title can be retrieved, this function returns an empty string. |
| std::string GetWindowTitle(CFDictionaryRef window); |
| |
| // Returns utf-8 encoded title of window |id|. If |id| cannot be found or no |
| // valid title can be retrieved, this function returns an empty string. |
| std::string GetWindowTitle(CGWindowID id); |
| |
| // Returns utf-8 encoded owner name of |window|. If |window| is not a window or |
| // if no valid owner name can be retrieved, returns an empty string. |
| std::string GetWindowOwnerName(CFDictionaryRef window); |
| |
| // Returns utf-8 encoded owner name of the given window |id|. If |id| cannot be |
| // found or if no valid owner name can be retrieved, returns an empty string. |
| std::string GetWindowOwnerName(CGWindowID id); |
| |
| // Returns id of |window|. If |window| is not a window or the window id cannot |
| // be retrieved, this function returns kNullWindowId. |
| WindowId GetWindowId(CFDictionaryRef window); |
| |
| // Returns the pid of the process owning |window|. Return 0 if |window| is not |
| // a window or no valid owner can be retrieved. |
| int GetWindowOwnerPid(CFDictionaryRef window); |
| |
| // Returns the pid of the process owning the window |id|. Return 0 if |id| |
| // cannot be found or no valid owner can be retrieved. |
| int GetWindowOwnerPid(CGWindowID id); |
| |
| // Returns the DIP to physical pixel scale at |position|. |position| is in |
| // *unscaled* system coordinate, i.e. it's device-independent and the primary |
| // monitor starts from (0, 0). If |position| is out of the system display, this |
| // function returns 1. |
| float GetScaleFactorAtPosition(const MacDesktopConfiguration& desktop_config, |
| DesktopVector position); |
| |
| // Returns the DIP to physical pixel scale factor of the window with |id|. |
| // The bounds of the window with |id| is in DIP coordinates and |size| is the |
| // CGImage size of the window with |id| in physical coordinates. Comparing them |
| // can give the current scale factor. |
| // If the window overlaps multiple monitors, OS will decide on which monitor the |
| // window is displayed and use its scale factor to the window. So this method |
| // still works. |
| float GetWindowScaleFactor(CGWindowID id, DesktopSize size); |
| |
| // Returns the bounds of |window|. If |window| is not a window or the bounds |
| // cannot be retrieved, this function returns an empty DesktopRect. The returned |
| // DesktopRect is in system coordinate, i.e. the primary monitor always starts |
| // from (0, 0). |
| // Deprecated: This function should be avoided in favor of the overload with |
| // MacDesktopConfiguration. |
| DesktopRect GetWindowBounds(CFDictionaryRef window); |
| |
| // Returns the bounds of window with |id|. If |id| does not represent a window |
| // or the bounds cannot be retrieved, this function returns an empty |
| // DesktopRect. The returned DesktopRect is in system coordinates. |
| // Deprecated: This function should be avoided in favor of the overload with |
| // MacDesktopConfiguration. |
| DesktopRect GetWindowBounds(CGWindowID id); |
| |
| } // namespace webrtc |
| |
| #endif // MODULES_DESKTOP_CAPTURE_MAC_WINDOW_LIST_UTILS_H_ |