Oxide QML Type

Global object for Oxide functions More...

Import Statement: import com.canonical.Oxide 1.15

Properties

Detailed Description

The Oxide object is a global object for accessing global functions exposed by Oxide.

Property Documentation

availableAudioCaptureDevices : list<variant>

A list of audio capture devices detected by Oxide. Each item of the list is a variant with the following properties:

This QML property was introduced in OxideQt 1.8.


availableVideoCaptureDevices : list<variant>

A list of video capture devices detected by Oxide. Each item of the list is a variant with the following properties:

This QML property was introduced in OxideQt 1.8.


chromiumVersion : string

The Chromium version that this Oxide build is based on, in the form x.x.x.x.

This QML property was introduced in OxideQt 1.15.


defaultWebContext : WebContext

The global default WebContext. The default WebContext will be used for WebView's that aren't created with an application supplied WebContext.

The default WebContext is also the only usable WebContext in single-process mode (processModel is Oxide.ProcessModelSingleProcess.

Accessing this for the first time will create the default WebContext if it hasn't been created already. Oxide retains ownership of the default WebContext - applications mustn't delete it.


maxRendererProcessCount : int

The maximum number of web content processes to run. Setting this to 0 will reset it to the default, which is system dependent.

This is not a hard limit, as there are cases where web content processes will not be shared (eg, web views in different web contexts, or incognito / non-incognito web views).

This must be called before Oxide is started up (in your applications main(), before using any other Oxide APIs). Calling it afterwards will have no effect.

This QML property was introduced in OxideQt 1.4.


oxideVersion : string

The current Oxide version, in the form 1.x.x.

This QML property was introduced in OxideQt 1.15.


processModel : enumeration

The process model to use. Setting this determines whether Oxide will run web content in sandboxed sub-processes or the application process. The default is Oxide.ProcessModelMultiProcess.

This must be called before Oxide is started up (in your applications main(), before using any other Oxide APIs). Calling it afterwards will have no effect.

Possible values are:

ConstantDescription
Oxide.ProcessModelMultiProcessMulti-process mode. In this mode, web content runs in sandboxed sub-processes rather than the application process. This mode provides the best level of security and fault tolerance.
Oxide.ProcessModelSingleProcessSingle process mode. In this mode, web content runs in the application process. Web content is not sandboxed, and crashes that would normally only affect a web content process in multi-process mode will result in an application crash in this mode.

This QML property was introduced in OxideQt 1.4.