Struct windows_capture::capture::CaptureControl

pub struct CaptureControl<T: GraphicsCaptureApiHandler + Send + 'static + ?Sized, E> { /* private fields */ }

Used to control the capture session

Implementations

impl<T: GraphicsCaptureApiHandler + Send + 'static, E> CaptureControl<T, E>

pub fn new( thread_handle: JoinHandle<Result<(), GraphicsCaptureApiError<E>>>, halt_handle: Arc<AtomicBool>, callback: Arc<Mutex<T>> ) -> Self

Creates a new Capture Control struct.

Arguments

• thread_handle - The join handle for the capture thread.
• halt_handle - The atomic boolean used to pause the capture thread.
• callback - The mutex-protected callback struct used to call struct methods directly.

Returns

The newly created CaptureControl struct.

pub fn is_finished(&self) -> bool

Checks to see if the capture thread is finished.

Returns

true if the capture thread is finished, false otherwise.

pub fn into_thread_handle( self ) -> JoinHandle<Result<(), GraphicsCaptureApiError<E>>>

Gets the join handle for the capture thread.

Returns

The join handle for the capture thread.

pub fn halt_handle(&self) -> Arc<AtomicBool>

Gets the halt handle used to pause the capture thread.

Returns

The halt handle used to pause the capture thread.

pub fn callback(&self) -> Arc<Mutex<T>>

Gets the callback struct used to call struct methods directly.

Returns

The callback struct used to call struct methods directly.

pub fn wait(self) -> Result<(), CaptureControlError<E>>

Waits until the capturing thread stops.

Returns

Ok(()) if the capturing thread stops successfully, an error otherwise.

pub fn stop(self) -> Result<(), CaptureControlError<E>>

Gracefully stops the capture thread.

Returns

Ok(()) if the capture thread stops successfully, an error otherwise.