Struct rerun::sdk::web_viewer::WebViewerConfig

pub struct WebViewerConfig {
    pub bind_ip: String,
    pub web_port: WebViewerServerPort,
    pub source_url: Option<String>,
    pub force_wgpu_backend: Option<String>,
    pub video_decoder: Option<String>,
    pub open_browser: bool,
}

Helper to spawn an instance of the WebViewerServer and configure a webviewer url.

Fields

bind_ip: String

Ip to which the http server is bound.

Defaults to 0.0.0.0

web_port: WebViewerServerPort

The port to which the webviewer should bind.

Defaults to WebViewerServerPort::AUTO.

source_url: Option<String>

The url from which a spawned webviewer should source

This url could be a hosted RRD file or a ws:// url to a running re_ws_comms::RerunServer. Has no effect if Self::open_browser is false.

force_wgpu_backend: Option<String>

If set, adjusts the browser url to force a specific backend, either webgl or webgpu.

Has no effect if Self::open_browser is false.

video_decoder: Option<String>

If set, adjusts the browser url to set the video decoder setting, either auto, prefer_software or prefer_hardware.

Has no effect if Self::open_browser is false.

open_browser: bool

If set to true, opens the default browser after hosting the webviewer.

Defaults to true.

Implementations

impl WebViewerConfig

pub fn host_web_viewer(self) -> Result<WebViewerServer, WebViewerServerError>

Helper to spawn an instance of the WebViewerServer. This serves the HTTP+Wasm+JS files that make up the web-viewer.

The server will immediately start listening for incoming connections and stop doing so when the returned WebViewerServer is dropped.

Note: this does not include the websocket server.

Trait Implementations

impl Default for WebViewerConfig

fn default() -> WebViewerConfig

Returns the “default value” for a type.