Molybden API
Loading...
Searching...
No Matches
molybden::AppOptions Struct Reference

The Molybden app options. More...

#include <app.hpp>

Public Attributes

std::string user_data_dir
 The absolute path to the directory where the user data such as cache, cookies, history, GPU cache, local storage, visited links, web data, spell checking dictionary files, etc.
 
UiLanguage ui_language = UiLanguage::kEnglishUs
 The language used on the default error pages and the message dialogs.
 
bool enable_remote_debugging_port = false
 Enables the remote debugging port in the production mode.
 
uint32_t remote_debugging_port = 0
 The remote debugging port number.
 
bool disable_sandbox = false
 Disables Chromium Sandbox.
 
bool disable_gpu = false
 Disables GPU rendering.
 
bool enable_autoplay = false
 Allows automatically starting video and audio playbacks on the web pages.
 
bool enable_incognito = false
 Enables the incognito mode for the default profile.
 
bool enable_h264 = false
 Enables support of the H.264 codec.
 
bool enable_aac = false
 Enables support of the AAC codec.
 
bool enable_widevine = false
 Enables support of the Widevine DRM decryption.
 
bool terminate_on_failed_check = false
 Enables the application termination in case of a failed internal check.
 
Logging logging
 Allows configuring the application logging.
 
bool warn_before_quitting = false
 Enables the warning on quitting the application via Cmd+Q.
 
bool quit_when_last_browser_closed = true
 Indicates if the app should quit when the last browser is closed.
 
bool disable_crash_reporter = false
 Indicates if the Chromium crash reporter is disabled on macOS.
 
PasswordStoreType password_store_type = PasswordStoreType::kBasic
 Configures the password store type that specifies which storage backend to use to encrypt cookies on Linux.
 
std::string user_agent
 A string used to override the default user agent with a custom one.
 
std::vector< std::string > schemes
 The schemes that will be intercepted.
 
std::unordered_set< std::string > switches
 The Chromium command line switches that will be passed to the Main Chromium process.
 

Detailed Description

The Molybden app options.

Member Data Documentation

◆ disable_crash_reporter

bool molybden::AppOptions::disable_crash_reporter = false

Indicates if the Chromium crash reporter is disabled on macOS.

The crash reporter is responsible for generating a crash dump in case the Chromium process experiences a crash.

Important: the crash reporter must be disabled before submitting the app to the Mac App Store to satisfy all requirements for the macOS app sandboxing.

Important: by default, the Chromium crash reporter is enabled and dumps are generated.

◆ disable_gpu

bool molybden::AppOptions::disable_gpu = false

Disables GPU rendering.

If software rendering is not in place, then the GPU process won't launch.

◆ disable_sandbox

bool molybden::AppOptions::disable_sandbox = false

Disables Chromium Sandbox.

Has the same effect as adding the --no-sandbox Chromium switch.

◆ enable_aac

bool molybden::AppOptions::enable_aac = false

Enables support of the AAC codec.

Important: AAC codec is a proprietary component. By enabling this codec you state that you are aware that AAC is a proprietary component and you should have a license in order to use it. For more information, you could contact patent holders: Via Licensing and MPEG LA. TeamDev shall not be responsible for your use of AAC codec.

◆ enable_h264

bool molybden::AppOptions::enable_h264 = false

Enables support of the H.264 codec.

Important: H.264 codec is a proprietary component. By enabling this codec you state that you are aware that H.264 is a proprietary component and you should have a license in order to use it. For more information, you could contact patent holders: Via Licensing and MPEG LA. TeamDev shall not be responsible for your use of H.264 codec.

◆ enable_incognito

bool molybden::AppOptions::enable_incognito = false

Enables the incognito mode for the default profile.

In the incognito mode the user data such as browsing history, cookies, site data, and the information entered in forms are stored in memory and released once you terminate the application.

The option affects the type of the default profile only.

◆ enable_widevine

bool molybden::AppOptions::enable_widevine = false

Enables support of the Widevine DRM decryption.

Important: Widevine is a Google proprietary component, governed by its own terms of use. For more information, see https://www.widevine.com/. TeamDev shall not be responsible for your use of Widevine.

◆ password_store_type

PasswordStoreType molybden::AppOptions::password_store_type = PasswordStoreType::kBasic

Configures the password store type that specifies which storage backend to use to encrypt cookies on Linux.

By default, the library does not use the native password stores on Linux since they may prompt for additional UI during startup.

◆ quit_when_last_browser_closed

bool molybden::AppOptions::quit_when_last_browser_closed = true

Indicates if the app should quit when the last browser is closed.

By default, the app will quit when the last browser closed.

◆ remote_debugging_port

uint32_t molybden::AppOptions::remote_debugging_port = 0

The remote debugging port number.

This option enables remote debugging over HTTP at the specific port. When remote debugging is enabled, you can load the chrome://inspect/#devices address in Google Chrome and debug the loaded web pages using Chrome DevTools.

◆ schemes

std::vector<std::string> molybden::AppOptions::schemes

The schemes that will be intercepted.

The following schemes cannot be intercepted:

  • about
  • blob
  • content
  • cid
  • data
  • file
  • filesystem
  • ftp
  • javascript
  • mailto
  • quic-transport
  • tel
  • ws
  • wss
  • devtools
  • chrome
  • chrome-error
  • chrome-distiller
  • chrome-untrusted
  • chrome-guest
  • chrome-search
  • chrome-extension
  • chrome-native
  • view-source
  • externalfile
  • googlechrome

◆ terminate_on_failed_check

bool molybden::AppOptions::terminate_on_failed_check = false

Enables the application termination in case of a failed internal check.

For example, in case when an empty string is passed to the Frame::loadUrl(const std::string&) method.

Important: by default, this option is disabled, and when a internal check fails only an error message is written to the log.

◆ user_data_dir

std::string molybden::AppOptions::user_data_dir

The absolute path to the directory where the user data such as cache, cookies, history, GPU cache, local storage, visited links, web data, spell checking dictionary files, etc.

is stored.

The directory must have write access. If it does not exist, it will be created programmatically.

The same user data directory cannot be used by multiple Molybden processes simultaneously.

◆ warn_before_quitting

bool molybden::AppOptions::warn_before_quitting = false

Enables the warning on quitting the application via Cmd+Q.

Only on Mac.

This option is applicable only at the first Chromium run. After, the user may uncheck the "Warn Before Quitting (Cmd+Q)" window menu item and Chromium will preserve it for the future runs.


The documentation for this struct was generated from the following file: