OLD | NEW |
1 # Headless Chromium | 1 # Headless Chromium |
2 | 2 |
3 Headless Chromium is a library for running Chromium in a headless/server | 3 Headless Chromium is a library for running Chromium in a headless/server |
4 environment. Expected use cases include loading web pages, extracting metadata | 4 environment. Expected use cases include loading web pages, extracting metadata |
5 (e.g., the DOM) and generating bitmaps from page contents -- using all the | 5 (e.g., the DOM) and generating bitmaps from page contents -- using all the |
6 modern web platform features provided by Chromium and Blink. | 6 modern web platform features provided by Chromium and Blink. |
7 | 7 |
8 ## Headless shell | 8 ## Headless shell |
9 | 9 |
10 The headless shell is a sample application which demonstrates the use of the | 10 The headless shell is a sample application which demonstrates the use of the |
(...skipping 34 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
45 points such as networking and the run loop. | 45 points such as networking and the run loop. |
46 | 46 |
47 The main embedder API classes are: | 47 The main embedder API classes are: |
48 | 48 |
49 - `HeadlessBrowser::Options::Builder` - Defines the embedding options, e.g.: | 49 - `HeadlessBrowser::Options::Builder` - Defines the embedding options, e.g.: |
50 - `SetMessagePump` - Replaces the default base message pump. See | 50 - `SetMessagePump` - Replaces the default base message pump. See |
51 `base::MessagePump`. | 51 `base::MessagePump`. |
52 - `SetProxyServer` - Configures an HTTP/HTTPS proxy server to be used for | 52 - `SetProxyServer` - Configures an HTTP/HTTPS proxy server to be used for |
53 accessing the network. | 53 accessing the network. |
54 | 54 |
55 ## Client API | 55 ## Client/DevTools API |
56 | 56 |
57 The headless client API is used to drive the browser and interact with loaded | 57 The headless client API is used to drive the browser and interact with loaded |
58 web pages. Its main classes are: | 58 web pages. Its main classes are: |
59 | 59 |
60 - `HeadlessBrowser` - Represents the global headless browser instance. | 60 - `HeadlessBrowser` - Represents the global headless browser instance. |
61 - `HeadlessWebContents` - Represents a single "tab" within the browser. | 61 - `HeadlessWebContents` - Represents a single "tab" within the browser. |
| 62 - `HeadlessDevToolsClient` - Provides a C++ interface for inspecting and |
| 63 controlling a tab. The API functions corresponds to [DevTools commands](https:
//developer.chrome.com/devtools/docs/debugger-protocol). |
| 64 See the [client API documentation](https://docs.google.com/document/d/1rlqcp8n
k-ZQvldNJWdbaMbwfDbJoOXvahPCDoPGOwhQ/edit#) |
| 65 for more information. |
OLD | NEW |