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 See the [architecture design doc](https://docs.google.com/document/d/11zIkKkLBoc
ofGgoTeeyibB2TZ_k7nR78v7kNelCatUE) |
| 9 for more information. |
| 10 |
8 ## Headless shell | 11 ## Headless shell |
9 | 12 |
10 The headless shell is a sample application which demonstrates the use of the | 13 The headless shell is a sample application which demonstrates the use of the |
11 headless API. To run it, first initialize a headless build configuration: | 14 headless API. To run it, first initialize a headless build configuration: |
12 | 15 |
13 ``` | 16 ``` |
14 $ mkdir -p out/Debug | 17 $ mkdir -p out/Debug |
15 $ echo 'import("//build/args/headless.gn")' > out/Debug/args.gn | 18 $ echo 'import("//build/args/headless.gn")' > out/Debug/args.gn |
16 $ gn gen out/Debug | 19 $ gn gen out/Debug |
17 ``` | 20 ``` |
(...skipping 34 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
52 - `SetProxyServer` - Configures an HTTP/HTTPS proxy server to be used for | 55 - `SetProxyServer` - Configures an HTTP/HTTPS proxy server to be used for |
53 accessing the network. | 56 accessing the network. |
54 | 57 |
55 ## Client API | 58 ## Client API |
56 | 59 |
57 The headless client API is used to drive the browser and interact with loaded | 60 The headless client API is used to drive the browser and interact with loaded |
58 web pages. Its main classes are: | 61 web pages. Its main classes are: |
59 | 62 |
60 - `HeadlessBrowser` - Represents the global headless browser instance. | 63 - `HeadlessBrowser` - Represents the global headless browser instance. |
61 - `HeadlessWebContents` - Represents a single "tab" within the browser. | 64 - `HeadlessWebContents` - Represents a single "tab" within the browser. |
OLD | NEW |