Header menu logo fable-electron-docs-api

Metadata Type

Constructors

Constructor Description

Metadata(?captureUpdateRect, ?regionCaptureRect, ?sourceSize, ?frameCount)

Full Usage: Metadata(?captureUpdateRect, ?regionCaptureRect, ?sourceSize, ?frameCount)

Parameters:
    ?captureUpdateRect : Rectangle - Updated area of frame, can be considered as the dirty area.
    ?regionCaptureRect : Rectangle - May reflect the frame's contents origin if region capture is used internally.
    ?sourceSize : Rectangle - Full size of the source frame.
    ?frameCount : float - The increasing count of captured frame. May contain gaps if frames are dropped between two consecutively received frames.

Returns: Metadata
?captureUpdateRect : Rectangle

Updated area of frame, can be considered as the dirty area.

?regionCaptureRect : Rectangle

May reflect the frame's contents origin if region capture is used internally.

?sourceSize : Rectangle

Full size of the source frame.

?frameCount : float

The increasing count of captured frame. May contain gaps if frames are dropped between two consecutively received frames.

Returns: Metadata

Instance members

Instance member Description

this.captureUpdateRect

Full Usage: this.captureUpdateRect

Updated area of frame, can be considered as the dirty area.

this.frameCount

Full Usage: this.frameCount

The increasing count of captured frame. May contain gaps if frames are dropped between two consecutively received frames.

this.regionCaptureRect

Full Usage: this.regionCaptureRect

May reflect the frame's contents origin if region capture is used internally.

this.sourceSize

Full Usage: this.sourceSize

Full size of the source frame.

Type something to start searching.