Skip to content

ElectronWebContents.beginFrameSubscription method

ElectronWebContents › beginFrameSubscription

Unofficial

Begins subscribing for presentation events and captured frames.

Signature:

beginFrameSubscription(onlyDirty: boolean, callback: (image: ElectronNativeImage, dirtyRect: ElectronRectangle) => void): void

Parameters:

Parameter Type Description
onlyDirty boolean Whether the captured image should contain only the repainted area.
callback (image: ElectronNativeImage, dirtyRect: ElectronRectangle) => void Called with the captured frame image and the repainted rect.

Returns: void


Unofficial

Begins subscribing for presentation events and captured frames.

Signature:

beginFrameSubscription(callback: (image: ElectronNativeImage, dirtyRect: ElectronRectangle) => void): void

Parameters:

Parameter Type Description
callback (image: ElectronNativeImage, dirtyRect: ElectronRectangle) => void Called with the captured frame image and the repainted rect.

Returns: void