Package com.teamdev.jxbrowser.browser.callback

Class StartCaptureSessionCallback.Action

java.lang.Object

com.teamdev.jxbrowser.callback.AsyncCallbackAction<com.teamdev.jxbrowser.capture.internal.rpc.StartCaptureSession.Response>

com.teamdev.jxbrowser.browser.callback.StartCaptureSessionCallback.Action

Enclosing interface:

StartCaptureSessionCallback

public static final class StartCaptureSessionCallback.Action
extends AsyncCallbackAction<com.teamdev.jxbrowser.capture.internal.rpc.StartCaptureSession.Response>

An action to take in StartCaptureSessionCallback.

Constructor Summary

Constructors

Constructor	Description
Action(Consumer<com.teamdev.jxbrowser.capture.internal.rpc.StartCaptureSession.Response> consumer)

Method Summary

Modifier and Type	Method	Description
void	cancel()	Tells the browser that the capture session request should be canceled.
void	selectSource(Browser browser, AudioCaptureMode audioCaptureMode)	Tells the browser to use the given browser as the capture source.
void	selectSource(Browser browser, AudioCaptureMode audioCaptureMode, NotificationVisibility notificationVisibility)	Overloaded version of selectSource(Browser, AudioCaptureMode) that allows specifying whether to show a notification during capture.
void	selectSource(CaptureSource source, AudioCaptureMode audioCaptureMode)	Tells the browser to use the given capture source.
void	selectSource(CaptureSource source, AudioCaptureMode audioCaptureMode, NotificationVisibility notificationVisibility)	Overloaded version of selectSource(CaptureSource, AudioCaptureMode) that allows specifying whether to show a notification during capture.
void	showSelectSourceDialog()	Tells the browser to display the default dialog for choosing the capture source.

Methods inherited from class com.teamdev.jxbrowser.callback.AsyncCallbackAction

isClosed

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Action

public Action(Consumer<com.teamdev.jxbrowser.capture.internal.rpc.StartCaptureSession.Response> consumer)

Method Details

selectSource

public void selectSource(CaptureSource source,
 AudioCaptureMode audioCaptureMode)

Tells the browser to use the given capture source.

The source must be present in the capture sources received from the StartCaptureSessionCallback.Params.sources().

If the screen capture is forbidden by the system security permissions the request will be cancelled. This is usual for macOS where the screen or application window capture must be explicitly allowed in the System Preferences.

Parameters:

source - the content source to use for the capture

audioCaptureMode - the audio capture mode for the capture

selectSource

public void selectSource(CaptureSource source,
 AudioCaptureMode audioCaptureMode,
 NotificationVisibility notificationVisibility)

Overloaded version of selectSource(CaptureSource, AudioCaptureMode) that allows specifying whether to show a notification during capture.

Parameters:

source - the content source to use for the capture

audioCaptureMode - the audio capture mode for the capture

notificationVisibility - whether to show a capture notification while capturing is active

Since:

8.7.0

selectSource

public void selectSource(Browser browser,
 AudioCaptureMode audioCaptureMode)

Tells the browser to use the given browser as the capture source.

The passed browser instance and the browser instance requesting the capture session must be created by the same Engine instance. Otherwise, the content capture will be cancelled.

Parameters:

browser - the browser which contents will be captured

audioCaptureMode - the mode of capturing the audio from the browser

selectSource

public void selectSource(Browser browser,
 AudioCaptureMode audioCaptureMode,
 NotificationVisibility notificationVisibility)

Overloaded version of selectSource(Browser, AudioCaptureMode) that allows specifying whether to show a notification during capture.

Parameters:

browser - the browser which contents will be captured

audioCaptureMode - the mode of capturing the audio from the browser

notificationVisibility - whether to show a capture notification while capturing is active

Since:

8.7.0

cancel

public void cancel()

Tells the browser that the capture session request should be canceled.

showSelectSourceDialog

public void showSelectSourceDialog()

Tells the browser to display the default dialog for choosing the capture source.