ScreenCapture.NET/ScreenCapture/IScreenCapture.cs

using System;

namespace ScreenCapture
{
    /// <summary>
    /// Represents the duplication of a single display.
    /// </summary>
    public interface IScreenCapture : IDisposable
    {
        /// <summary>
        /// Gets the <see cref="Display"/> this capture is duplicating.
        /// </summary>
        Display Display { get; }

        /// <summary>
        /// Occurs when the <see cref="IScreenCapture"/> is updated.
        /// </summary>
        event EventHandler<ScreenCaptureUpdatedEventArgs>? Updated;

        /// <summary>
        /// Attemts to capture the current frame showed on the <see cref="Display"/>.
        /// </summary>
        /// <returns><c>true</c> if the current frame was captures successfully; otherwise, <c>false</c>.</returns>
        bool CaptureScreen();

        /// <summary>
        /// Creates a new <see cref="CaptureScreen"/> for this <see cref="IScreenCapture"/>.
        /// </summary>
        /// <param name="x">The x-location of the region to capture (must be &gt;= 0 and &lt; screen-width).</param>
        /// <param name="y">The x-location of the region to capture (must be &gt;= 0 and &lt; screen-height).</param>
        /// <param name="width">The width of the region to capture (must be &gt;= 0 and this + x must be &lt;= screen-width).</param>
        /// <param name="height">The height of the region to capture (must be &gt;= 0 and this + y must be &lt;= screen-height).</param>
        /// <param name="downscaleLevel">The level of downscaling applied to the image of this region before copying to local memory. The calculation is (width and height)/2^downscaleLevel.</param>
        /// <returns>The new <see cref="CaptureScreen"/>.</returns>
        CaptureZone RegisterCaptureZone(int x, int y, int width, int height, int downscaleLevel = 0);

        /// <summary>
        /// Removes the given <see cref="CaptureScreen"/> from the <see cref="IScreenCapture"/>.
        /// </summary>
        /// <param name="captureZone">The previosly registered <see cref="CaptureScreen"/>.</param>
        /// <returns><c>true</c> if the <see cref="CaptureScreen"/> was successfully removed; otherwise, <c>false</c>.</returns>
        bool UnregisterCaptureZone(CaptureZone captureZone);

        /// <summary>
        /// Restarts the <see cref="IScreenCapture"/>.
        /// </summary>
        void Restart();
    }
}