Property

WebKit2WebView:display-capture-state

since: 2.34

Declaration

property display-capture-state: WebKit2.MediaCaptureState [ read, write ]

Description [src]

Capture state of the display device. Whenever the user grants a media-request sent by the web page, requesting screencasting capabilities (navigator.mediaDevices.getDisplayMedia() this property will be set toWEBKIT_MEDIA_CAPTURE_STATE_ACTIVE`.

The application can monitor this property and provide a visual indicator allowing to optionally deactivate or mute the capture device by setting this property respectively to WEBKIT_MEDIA_CAPTURE_STATE_NONE or WEBKIT_MEDIA_CAPTURE_STATE_MUTED.

If the capture state of the device is set to WEBKIT_MEDIA_CAPTURE_STATE_NONE the web-page can still re-request the permission to the user. Permission desision caching is left to the application.

Type: WebKitMediaCaptureState
Available since:2.34
Default valueWEBKIT_MEDIA_CAPTURE_STATE_NONE
Getter methodwebkit_web_view_get_display_capture_state()
Setter methodwebkit_web_view_set_display_capture_state()

Flags

Readableyes
Writableyes
Constructno
Construct onlyno