CrabGrab

https://docs.rs/crabgrab/0.4.0/crabgrab/
Admin
CrabGrab is a Rust library for capturing screen content and audio streams with support for multiple...
Tokens:35,716
Snippets:311
Trust Score:9.1
Update:6 months ago
Show doc for...
Tokens:
Raw
### Get Wgpu Device

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/feature/wgpu/trait.WgpuCaptureStreamExt.html

Retrieves a reference to the Wgpu device. This device is referenced by the device wrapper that was supplied to `CaptureConfig::with_wgpu_device(..)`. Returns an Option containing a reference to the `Device`.

```rust
fn get_wgpu_device(&self) -> Option<&Device>;
```

--------------------------------

### Get Wgpu Device Wrapper

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/feature/wgpu/trait.WgpuCaptureStreamExt.html

Retrieves the Wgpu device wrapper that was supplied to `CaptureConfig::with_wgpu_device(..)`. This method returns an Option containing an `Arc` to the device wrapper.

```rust
fn get_wgpu_device_wrapper(
        &self,
    ) -> Option<Arc<dyn AsRef<Device> + Send + Sync + 'static>>;
```

--------------------------------

### Create CapturableWindow from Handle (Windows)

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableWindow.html

Gets a capturable window from an HWND (window handle) on Windows systems. Returns a Result which may contain a CapturableWindow or a CapturableContentError.

```rust
fn from_window_handle(
    window_handle: HWND,
) -> Result<Self, CapturableContentError>
```

--------------------------------

### Get Owning Application

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableWindow.html

Retrieves the CapturableApplication that owns this window. This method returns a CapturableApplication object.

```rust
pub fn application(&self) -> CapturableApplication
```

--------------------------------

### Get Window Title

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableWindow.html

Retrieves the title of the capturable window. This method returns a String.

```rust
pub fn title(&self) -> String
```

--------------------------------

### Get Window Handle (Windows)

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableWindow.html

Gets the HWND (window handle) for this capturable window on Windows systems. This is part of the WindowsCapturableWindowExt trait.

```rust
fn get_window_handle(&self) -> HWND
```

--------------------------------

### CaptureConfig Initialization

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capture_stream/struct.CaptureConfig.html

Methods for creating a new CaptureConfig instance.

```APIDOC
## POST /capture/config/window

### Description
Create a capture configuration for a given capturable window.

### Method
POST

### Endpoint
/capture/config/window

### Parameters
#### Query Parameters
- **pixel_format** (CapturePixelFormat) - Required - The pixel format for the capture.

#### Request Body
- **window** (CapturableWindow) - Required - The window to capture.

### Response
#### Success Response (200)
- **CaptureConfig** (object) - The created capture configuration.

#### Response Example
```json
{
  "config": {
    "buffer_count": 1,
    "show_cursor": true,
    "output_size": null,
    "wgpu_device": null,
    "dxgi_adapter": null,
    "d3d11_device": null,
    "borderless": false
  }
}
```
```

```APIDOC
## POST /capture/config/display

### Description
Create a capture configuration for a given capturable display.

### Method
POST

### Endpoint
/capture/config/display

### Parameters
#### Query Parameters
- **pixel_format** (CapturePixelFormat) - Required - The pixel format for the capture.

#### Request Body
- **display** (CapturableDisplay) - Required - The display to capture.

### Response
#### Success Response (200)
- **CaptureConfig** (object) - The created capture configuration.

#### Response Example
```json
{
  "config": {
    "buffer_count": 1,
    "show_cursor": true,
    "output_size": null,
    "wgpu_device": null,
    "dxgi_adapter": null,
    "d3d11_device": null,
    "borderless": false
  }
}
```
```

--------------------------------

### Wgpu Module Overview

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/feature/wgpu/index.html

Overview of the available enums and traits for Wgpu integration within the crabgrab crate.

```APIDOC
## Wgpu Module

### Description
Provides functionality for Frame to Wgpu Texture conversion. Requires the `wgpu` feature flag to be enabled.

### Enums
- **WgpuVideoFrameError**: Represents an error getting the texture from a video frame.
- **WgpuVideoFramePlaneTexture**: Identifies planes of a video frame.

### Traits
- **WgpuCaptureConfigExt**: A capture config which can be supplied with a Wgpu device.
- **WgpuCaptureStreamExt**: A capture stream which may have had a Wgpu device instance supplied to it.
- **WgpuVideoFrameExt**: A video frame which can be used to create Wgpu textures.
```

--------------------------------

### Get Display Rectangle

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableDisplay.html

Gets the virtual screen rectangle of this display. Note: Currently on Windows, this is only evaluated at the time of display enumeration.

```rust
pub fn rect(&self) -> Rect
```

--------------------------------

### AudioBufferError Enum

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/frame/enum.AudioBufferError.html

Represents an error getting the data for an audio channel.

```APIDOC
## Enum AudioBufferError

### Description
Represents an error getting the data for an audio channel.

### Variants
- **UnsupportedFormat**: The audio format is not supported.
- **InvalidChannel**: The requested audio channel is invalid.
- **Other(String)**: An unspecified error occurred, containing a description string.
```

--------------------------------

### Capture Window Content with CrabGrab

Source: https://docs.rs/crabgrab

Demonstrates how to capture content from a specific window, such as Finder or Explorer. Requires capture access and involves setting up an async runtime. Ensure you have the necessary permissions before running.

```rust
use std::time::Duration;
use crabgrab::prelude::*;

// spin up the async runtime
let runtime = tokio::runtime::Builder::new_multi_thread().build().unwrap();
// run our capture code in an async context
let future = runtime.spawn(async {
    // ensure we have priveleges to capture content
    let token = match CaptureStream::test_access(false) {
        Some(token) => token,
        None => CaptureStream::request_access(false).await.expect("Expected capture access")
    };
    // filter to normal windows
    let filter = CapturableContentFilter::NORMAL_WINDOWS;
    // get capturable content matching the filter
    let content = CapturableContent::new(filter).await.unwrap();
    // find the window we want to capture
    let window = content.windows().filter(|window| {
        let app_identifier = window.application().identifier();
        app_identifier.to_lowercase().contains("finder") || app_identifier.to_lowercase().contains("explorer")
    }).next();
    match window {
        Some(window) => {
            println!("capturing window: {}", window.title()); 
            // create a captuere config using the first supported pixel format
            let config = CaptureConfig::with_window(window, CaptureStream::supported_pixel_formats()[0]).unwrap();
            // create a capture stream with an event handler callback
            let mut stream = CaptureStream::new(token, config, |stream_event| {
                match stream_event {
                    Ok(event) => {
                        match event {
                            StreamEvent::Video(frame) => {
                                println!("Got frame: {}", frame.frame_id());
                            },
                            _ => {}
                        }
                    },
                    Err(error) => {
                        println!("Stream error: {:?}", error);
                    }
                }
            }).unwrap();
            // wait for a while to capture some frames
            tokio::task::block_in_place(|| std::thread::sleep(Duration::from_millis(4000)));
            stream.stop().unwrap();
        },
        None => { println!("Failed to find window"); }
    }
});
// wait for the future to complete
runtime.block_on(future).unwrap();
// shutdown the async runtime
runtime.shutdown_timeout(Duration::from_millis(10000));

```

--------------------------------

### Create FrameBitmapPool with Initial Capacity

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/feature/bitmap/struct.FrameBitmapPool.html

Creates a new bitmap pool with specified initial capacity, resolution, maximum size, and pixel format. Use this when you need to pre-allocate resources.

```rust
pub fn new_with_initial_capacity( capacity: usize, initial_resolution: (usize, usize), max: usize, format: CapturePixelFormat, ) -> Self
```

--------------------------------

### Any Trait Implementation

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableDisplay.html

Provides a way to get the TypeId of a type, useful for downcasting and type introspection.

```rust
fn type_id(&self) -> TypeId
```

--------------------------------

### Create New AudioCaptureConfig

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capture_stream/struct.AudioCaptureConfig.html

Constructs a new AudioCaptureConfig with default settings. The default configuration includes a sample rate of 24000 Hz and mono audio.

```rust
pub fn new() -> Self
```

--------------------------------

### WgpuVideoFrameError Enum

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/feature/wgpu/enum.WgpuVideoFrameError.html

Represents an error getting the texture from a video frame in the crabgrab::feature::wgpu module.

```APIDOC
## WgpuVideoFrameError

### Description
Represents an error getting the texture from a video frame.

### Variants
- **NoBackendTexture** - The backend texture couldn’t be fetched.
- **InvalidVideoPlaneTexture** - The requested plane isn’t valid for this frame.
- **NoWgpuDevice** - No Wgpu device was supplied to the capture stream.
- **Other(String)** - An unspecified error occurred, containing a description string.
```

--------------------------------

### WgpuVideoFrameExt Trait

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/feature/wgpu/trait.WgpuVideoFrameExt.html

Documentation for the WgpuVideoFrameExt trait and its methods.

```APIDOC
## Trait WgpuVideoFrameExt

### Description
A video frame which can be used to create Wgpu textures.

### Methods

#### fn get_wgpu_texture

##### Description
Get the texture for the given plane of the video frame.

##### Parameters

- **plane** (WgpuVideoFramePlaneTexture) - Required - The plane of the video frame for which to get the texture.
- **label** (Option<&'static str>) - Optional - An optional label for the WGPU texture.

##### Returns

- Result<Texture, WgpuVideoFrameError> - A Result containing the WGPU Texture or a WgpuVideoFrameError.

### Implementors

- `VideoFrame`
```

--------------------------------

### AudioCaptureConfig::new

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capture_stream/struct.AudioCaptureConfig.html

Creates a new instance of AudioCaptureConfig with default settings (24000 Hz, Mono).

```APIDOC
## AudioCaptureConfig::new

### Description
Creates a new audio capture configuration object initialized with default values.

### Method
Constructor

### Response
- **AudioCaptureConfig** (struct) - A new instance configured with 24000 Hz sample rate and Mono channel settings.
```

--------------------------------

### FrameBitmapPool Blanket Implementations

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/feature/bitmap/struct.FrameBitmapPool.html

Details blanket implementations for FrameBitmapPool, including traits like Any, Borrow, From, Into, and TryFrom/TryInto.

```APIDOC
## Blanket Implementations

### impl<T> Any for T
#### fn type_id(&self) -> TypeId
Gets the `TypeId` of `self`.

### impl<T> Borrow<T> for T
#### fn borrow(&self) -> &T
Immutably borrows from an owned value.

### impl<T> BorrowMut<T> for T
#### fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value.

### impl<T> From<T> for T
#### fn from(t: T) -> T
Returns the argument unchanged.

### impl<T, U> Into<U> for T
#### fn into(self) -> U
Calls `U::from(self)`.

### impl<T, U> TryFrom<U> for T
#### type Error = Infallible
#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.

### impl<T, U> TryInto<U> for T
#### type Error = <U as TryFrom<T>>::Error
#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.

### impl<T> WasmNotSend for T
### impl<T> WasmNotSendSync for T
### impl<T> WasmNotSync for T
```

--------------------------------

### DXGI Module Overview

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/feature/dxgi/index.html

Overview of the available traits and error types for DXGI inter-operation within the crabgrab crate.

```APIDOC
## DXGI Module

### Description
The `dxgi` module provides functionality for Frame to DXGI Surface conversion. This module is gated behind the `dxgi` feature flag.

### Enums
- **WindowsDxgiCaptureStreamError**: Errors related to DXGI capture streams.
- **WindowsDxgiVideoFrameError**: Errors related to DXGI video frames.

### Traits
- **WindowsDxgiCaptureStream**: A capture stream which can inter-operate with DXGI.
- **WindowsDxgiVideoFrame**: A video frame which can inter-operate with DXGI.
```

--------------------------------

### FrameBitmapPool::new_with_initial_capacity

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/feature/bitmap/struct.FrameBitmapPool.html

Creates a new bitmap pool with specified initial capacity, resolution, maximum size, and pixel format.

```APIDOC
## pub fn new_with_initial_capacity(
    capacity: usize,
    initial_resolution: (usize, usize),
    max: usize,
    format: CapturePixelFormat,
) -> Self

### Description
Create a new bitmap pool with an initial `capacity` and `resolution` for the given `format`, limited to `max` pooled bitmaps.

### Method
`new_with_initial_capacity`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- `Self` (FrameBitmapPool) - A new instance of FrameBitmapPool.

#### Response Example
None
```

--------------------------------

### WgpuCaptureConfigExt Trait Definition

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/feature/wgpu/trait.WgpuCaptureConfigExt.html

Defines the interface for capture configurations that support Wgpu device integration.

```rust
pub trait WgpuCaptureConfigExt: Sized {
    // Required method
    fn with_wgpu_device(
        self,
        device: Arc<dyn AsRef<Device> + Send + Sync + 'static>,
    ) -> Result<Self, String>;
}
```

--------------------------------

### DX11 Module Overview

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/feature/dx11/index.html

Overview of the DX11 module, including its purpose and feature requirements.

```APIDOC
## Module dx11

### Description
Provides DX11 Surface/Texture conversion. Requires the `dx11` feature flag.

### Enums

#### `WindowsDx11VideoFrameError`
An enum representing errors that can occur with DX11 video frames.

### Traits

#### `WindowsDx11CaptureStream`
A capture stream that can inter-operate with DX11.

#### `WindowsDx11VideoFrame`
A video frame that can yield a DX11 surface.
```

--------------------------------

### Initialize CapturableContent

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableContent.html

Requests capturable content from the OS using a filter. The returned content might be stale, meaning a window listed may have been closed before use, leading to an error when creating a stream.

```rust
pub async fn new( filter: CapturableContentFilter, ) -> Result<Self, CapturableContentError>
```

--------------------------------

### CloneToUninit Trait Implementation (Nightly)

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableDisplay.html

An experimental nightly-only API that performs copy-assignment from self to an uninitialized memory location.

```rust
unsafe fn clone_to_uninit(&self, dest: *mut u8)
```

--------------------------------

### Clone From AudioCaptureConfig

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capture_stream/struct.AudioCaptureConfig.html

Performs copy-assignment from a source AudioCaptureConfig to the current one. This allows for efficient updating of configuration.

```rust
fn clone_from(&mut self, source: &Self)
```

--------------------------------

### Bitmap Module Overview

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/feature/bitmap/index.html

Overview of the structs, enums, and traits available in the crabgrab::bitmap module for handling frame bitmap conversions.

```APIDOC
## Module: crabgrab::bitmap

### Description
Provides structures and traits for converting video frames to bitmaps. Requires the `bitmap` feature flag.

### Structs
- **FrameBitmapArgbUnormPacked2101010**: A Rgba1010102 format bitmap.
- **FrameBitmapBgraUnorm8x4**: A Bgra8888 format bitmap.
- **FrameBitmapPool**: A pool of frame bitmaps.
- **FrameBitmapRgbaF16x4**: A RgbaF16x4 format bitmap.
- **FrameBitmapYCbCr**: A YCbCr image (V420 or F420 pixel formats).
- **PooledBitmap**: A bitmap belonging to a BitmapPool, returned to the pool upon drop.

### Enums
- **FrameBitmap**: A bitmap image of the selected format.
- **VideoFrameBitmapError**: Error type for bitmap generation failures.
- **VideoRange**: Video range for YCbCr format bitmaps.

### Traits
- **BitmapDataArgbUnormPacked2101010**: Data in Argb2101010 format.
- **BitmapDataBgra8x4**: Data in Bgra8888 format.
- **BitmapDataChroma**: Data in CbCr Chroma/u8x2 format.
- **BitmapDataLuma**: Data in Luma/u8 format.
- **BitmapDataRgbaF16x4**: Data in RgbaF16x4 format.
- **VideoFrameBitmap**: Trait for video frames capable of producing a bitmap.
```

--------------------------------

### WindowsCaptureConfigExt Trait Methods

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/platform/windows/trait.WindowsCaptureConfigExt.html

Methods available for configuring capture settings on Windows platforms.

```APIDOC
## WindowsCaptureConfigExt Methods

### Description
Provides methods to extend CaptureConfig with Windows-specific hardware and display settings.

### Methods
- **with_dxgi_adapter(self, dxgi_adapter: IDXGIAdapter) -> Self**: Sets the DXGI adapter to be used for capture.
- **with_d3d11_device(self, d3d11_device: ID3D11Device) -> Self**: Sets the D3D11 device to be used for capture.
- **with_borderless(self, borderless: bool) -> Self**: Configures whether the capture should be borderless.

### Compatibility
This trait is not dyn compatible (not object safe).
```

--------------------------------

### Struct: Size

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/util/struct.Size.html

Represents a 2D size with width and height fields.

```APIDOC
## Struct: Size

### Description
Represents a 2D size.

### Fields
- **width** (f64) - The width dimension.
- **height** (f64) - The height dimension.

### Methods
- **scaled(scale: f64) -> Self** - Scales the size uniformly by the provided value.
- **scaled_2d(scale: (f64, f64)) -> Self** - Scales the size non-uniformly in x and y dimensions.
```

--------------------------------

### Define AudioCaptureConfig Struct

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capture_stream/struct.AudioCaptureConfig.html

Defines the structure for audio capture configuration. It contains private fields and is used to hold settings for audio streams.

```rust
pub struct AudioCaptureConfig { /* private fields */ }
```

--------------------------------

### take_screenshot

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/feature/screenshot/fn.take_screenshot.html

Captures a screenshot of the capturable content based on the provided configuration.

```APIDOC
## take_screenshot

### Description
Take a screenshot of the capturable content given a configuration.

### Method
POST

### Endpoint
/websites/rs_crabgrab_0_4_0_crabgrab/feature/screenshot

### Parameters
#### Request Body
- **token** (CaptureAccessToken) - Required - Authentication token for capturing.
- **config** (CaptureConfig) - Required - Configuration for the screenshot capture.

### Response
#### Success Response (200)
- **VideoFrame** - The captured video frame.

#### Error Response
- **ScreenshotError** - An error occurred during the screenshot process.
```

--------------------------------

### product

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableDisplayIterator.html

Iterates over the entire iterator, multiplying all the elements.

```APIDOC
## fn product<P>(self) -> P

### Description
Iterates over the entire iterator, multiplying all the elements.

### Method
`product`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
`P`: The product of the elements in the iterator.

#### Response Example
None
```

--------------------------------

### CapturableApplication Methods

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableApplication.html

Methods available on the CapturableApplication struct to retrieve specific details about the application.

```APIDOC
## impl CapturableApplication

### `identifier()`

Gets the “identifier” of the application.
On MacOS, this is the application bundle, and on windows, this is the application file name.

#### Signature
```rust
pub fn identifier(&self) -> String
```

### `name()`

Gets the friendly name of the application.

#### Signature
```rust
pub fn name(&self) -> String
```

### `pid()`

Gets the process id of the application.

#### Signature
```rust
pub fn pid(&self) -> i32
```
```

--------------------------------

### AudioChannelDataSamples Methods

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/frame/struct.AudioChannelDataSamples.html

Methods available for interacting with the AudioChannelDataSamples struct to retrieve audio data.

```APIDOC
## AudioChannelDataSamples Methods

### Description
Provides access to audio samples within a channel buffer, handling data stride.

### Methods

#### get(n: usize) -> T
- **n** (usize) - The index of the sample to retrieve.
- **Returns** (T) - The nth sample for this channel data.

#### length() -> usize
- **Returns** (usize) - The total length of this sample buffer.
```

--------------------------------

### try_into Conversion Method

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capture_stream/enum.CapturePixelFormat.html

Performs a conversion from the current type into a target type U, returning a Result.

```APIDOC
## fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

### Description
Performs the conversion from the current type into the target type U.

### Returns
- **Result<U, <U as TryFrom<T>>::Error>** - The result of the conversion.
```

--------------------------------

### Clone AudioCaptureConfig

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capture_stream/struct.AudioCaptureConfig.html

Returns a duplicate of the AudioCaptureConfig value. This is useful for creating independent copies of the configuration.

```rust
fn clone(&self) -> AudioCaptureConfig
```

--------------------------------

### Trait Implementations for WgpuVideoFramePlaneTexture

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/feature/wgpu/enum.WgpuVideoFramePlaneTexture.html

Details the trait implementations available for the WgpuVideoFramePlaneTexture enum, including Clone, Debug, PartialEq, Copy, Eq, and StructuralPartialEq.

```APIDOC
### Trait Implementations for WgpuVideoFramePlaneTexture

#### `impl Clone for WgpuVideoFramePlaneTexture`

##### `fn clone(&self) -> WgpuVideoFramePlaneTexture`
Returns a duplicate of the value.

##### `fn clone_from(&mut self, source: &Self)`
Performs copy-assignment from `source`.

#### `impl Debug for WgpuVideoFramePlaneTexture`

##### `fn fmt(&self, f: &mut Formatter<'_>) -> Result`
Formats the value using the given formatter.

#### `impl PartialEq for WgpuVideoFramePlaneTexture`

##### `fn eq(&self, other: &WgpuVideoFramePlaneTexture) -> bool`
Tests for `self` and `other` values to be equal, and is used by `==`.

##### `fn ne(&self, other: &Rhs) -> bool`
Tests for `!=`.

#### `impl Copy for WgpuVideoFramePlaneTexture`

#### `impl Eq for WgpuVideoFramePlaneTexture`

#### `impl StructuralPartialEq for WgpuVideoFramePlaneTexture`
```

--------------------------------

### Create FrameBitmapPool

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/feature/bitmap/struct.FrameBitmapPool.html

Creates a new frame bitmap pool, limiting the number of pooled bitmaps to the specified maximum. This is a convenient constructor for basic pool creation.

```rust
pub fn new(max: usize) -> Self
```

--------------------------------

### Trait: WgpuCaptureConfigExt

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/feature/wgpu/trait.WgpuCaptureConfigExt.html

The WgpuCaptureConfigExt trait provides a method to associate a Wgpu device with a capture configuration.

```APIDOC
## Trait: WgpuCaptureConfigExt

### Description
A capture config which can be supplied with a Wgpu device.

### Required Methods
#### fn with_wgpu_device( self, device: Arc<dyn AsRef<Device> + Send + Sync + 'static>, ) -> Result<Self, String>

### Implementors
#### impl WgpuCaptureConfigExt for CaptureConfig
```

--------------------------------

### CapturableApplication Struct

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableApplication.html

Represents an application with capturable windows. This struct has private fields and is primarily interacted with through its methods.

```APIDOC
## Struct CapturableApplication

### Summary
```rust
pub struct CapturableApplication { /* private fields */ }
```

### Description
Represents an application with capturable windows.
```

--------------------------------

### Try Convert Into

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableWindow.html

This is a blanket implementation for the TryInto<U> for T trait where U: TryFrom<T>.

```rust
type Error = <U as TryFrom<T>>::Error
```

--------------------------------

### WindowsCapturableWindowExt for CapturableWindow

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableWindow.html

Provides Windows-specific extensions for CapturableWindow.

```APIDOC
## Trait Implementation: WindowsCapturableWindowExt for CapturableWindow

### Methods
#### `get_window_handle()`
- **Description**: Get the HWND for this capturable window.
- **Returns**: `HWND` - The window handle.

#### `from_window_handle(window_handle: HWND)`
- **Description**: Get a capturable window from an HWND.
- **Parameters**:
  - `window_handle` (HWND) - The window handle to create a CapturableWindow from.
- **Returns**: `Result<Self, CapturableContentError>` - A `CapturableWindow` if successful, or an error.

```

--------------------------------

### WgpuVideoFrameExt Trait Definition

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/feature/wgpu/trait.WgpuVideoFrameExt.html

Defines the interface for retrieving Wgpu textures from a video frame.

```rust
pub trait WgpuVideoFrameExt {
    // Required method
    fn get_wgpu_texture(
        &self,
        plane: WgpuVideoFramePlaneTexture,
        label: Option<&'static str>,
    ) -> Result<Texture, WgpuVideoFrameError>;
}
```

--------------------------------

### Create CapturableWindow from HWND

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/platform/windows/trait.WindowsCapturableWindowExt.html

Creates a CapturableWindow instance from a provided HWND. This method is part of the WindowsCapturableWindowExt trait and returns a Result.

```rust
fn from_window_handle(
        window_handle: HWND,
    ) -> Result<CapturableWindow, CapturableContentError>;
```

--------------------------------

### Capture a screenshot with take_screenshot

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/feature/screenshot/fn.take_screenshot.html

Captures a single frame from capturable content using the specified access token and configuration.

```rust
pub async fn take_screenshot(
    token: CaptureAccessToken,
    config: CaptureConfig,
) -> Result<VideoFrame, ScreenshotError>
```

--------------------------------

### Implement Display for WindowsDxgiVideoFrameError

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/feature/dxgi/enum.WindowsDxgiVideoFrameError.html

Provides a user-friendly string representation for the WindowsDxgiVideoFrameError enum, suitable for error messages.

```rust
impl Display for WindowsDxgiVideoFrameError
Source
#### fn fmt(&self, f: &mut Formatter<'_>) -> Result
```

--------------------------------

### FrameBitmapPool::new

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/feature/bitmap/struct.FrameBitmapPool.html

Creates a new frame bitmap pool with a specified maximum number of pooled bitmaps.

```APIDOC
## pub fn new(max: usize) -> Self

### Description
Create a new frame bitmap pool, limited to `max` pooled bitmaps.

### Method
`new`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- `Self` (FrameBitmapPool) - A new instance of FrameBitmapPool.

#### Response Example
None
```

--------------------------------

### Implement Clone for WindowsDxgiVideoFrameError

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/feature/dxgi/enum.WindowsDxgiVideoFrameError.html

Allows creating a duplicate of a WindowsDxgiVideoFrameError value. This is useful for error handling and propagation.

```rust
impl Clone for WindowsDxgiVideoFrameError
Source
#### fn clone(&self) -> WindowsDxgiVideoFrameError
```

--------------------------------

### CapturableWindow Struct

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableWindow.html

Represents a capturable application window and provides methods to retrieve its properties.

```APIDOC
## Struct CapturableWindow

### Summary
```
pub struct CapturableWindow { /* private fields */ }
```

### Description
Represents a capturable application window.

### Methods
#### `title()`
- **Description**: Gets the title of the window.
- **Returns**: `String` - The title of the window.

#### `rect()`
- **Description**: Gets the virtual screen rectangle of the window.
- **Returns**: `Rect` - The virtual screen rectangle of the window.

#### `application()`
- **Description**: Gets the application that owns this window.
- **Returns**: `CapturableApplication` - The application that owns this window.

#### `is_visible()`
- **Description**: Checks whether an application is visible (on-screen, not minimized).
- **Returns**: `bool` - `true` if the application is visible, `false` otherwise.

### Implementations
#### `impl CapturableWindow`
- `Clone` (fn clone, fn clone_from)
- `Debug` (fn fmt)
- `Hash` (fn hash, fn hash_slice)
- `PartialEq` (fn eq, fn ne)
- `WindowsCapturableWindowExt` (fn get_window_handle, fn from_window_handle)
- `Eq`
- `Send`
- `StructuralPartialEq`
- `Sync`
```

--------------------------------

### Implement Generic Traits for WindowsDxgiVideoFrameError

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/feature/dxgi/enum.WindowsDxgiVideoFrameError.html

Demonstrates blanket implementations of common traits like Send, Sync, Freeze, and RefUnwindSafe for WindowsDxgiVideoFrameError, indicating its thread-safety and memory safety characteristics.

```rust
impl Freeze for WindowsDxgiVideoFrameError
```

```rust
impl RefUnwindSafe for WindowsDxgiVideoFrameError
```

```rust
impl Send for WindowsDxgiVideoFrameError
```

```rust
impl Sync for WindowsDxgiVideoFrameError
```

```rust
impl Unpin for WindowsDxgiVideoFrameError
```

```rust
impl UnwindSafe for WindowsDxgiVideoFrameError
```

--------------------------------

### Clone Implementation for CapturableDisplay

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableDisplay.html

Provides methods for cloning CapturableDisplay instances. `clone` returns a duplicate, and `clone_from` performs copy-assignment.

```rust
fn clone(&self) -> CapturableDisplay
```

```rust
fn clone_from(&mut self, source: &Self)
```

--------------------------------

### WindowsCaptureConfigExt Trait Definition

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/platform/windows/trait.WindowsCaptureConfigExt.html

Defines methods for configuring Windows-specific capture settings. Use these methods to set the DXGI adapter, D3D11 device, or borderless capture mode.

```rust
pub trait WindowsCaptureConfigExt {
    // Required methods
    fn with_dxgi_adapter(self, dxgi_adapter: IDXGIAdapter) -> Self;
    fn with_d3d11_device(self, d3d11_device: ID3D11Device) -> Self;
    fn with_borderless(self, borderless: bool) -> Self;
}
```

--------------------------------

### Implement VideoFrameBitmap for VideoFrame

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/feature/bitmap/trait.VideoFrameBitmap.html

This section indicates that the VideoFrame type implements the VideoFrameBitmap trait, allowing VideoFrame instances to be used wherever VideoFrameBitmap is expected.

```rust
impl VideoFrameBitmap for VideoFrame
```

--------------------------------

### Check Window Visibility

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableWindow.html

Checks whether the application window is visible on-screen and not minimized. Returns a boolean value.

```rust
pub fn is_visible(&self) -> bool
```

--------------------------------

### Check Borderless Capture Capability

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capture_stream/struct.CaptureAccessToken.html

Implement the allows_borderless method for CaptureAccessToken to check if borderless capture is permitted.

```rust
pub fn allows_borderless(&self) -> bool
```

--------------------------------

### try_into Conversion Method

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableWindow.html

Performs a fallible conversion from the current type into a target type U.

```APIDOC
## fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

### Description
Performs the conversion from the current type into a target type U.

### Parameters
- **self** - Required - The instance to be converted.
```

--------------------------------

### Compare CapturableWindow for Equality

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableWindow.html

Tests if two CapturableWindow values are equal. This method is part of the PartialEq trait.

```rust
fn eq(&self, other: &CapturableWindow) -> bool
```

--------------------------------

### WgpuCaptureStreamExt Trait

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capture_stream/struct.CaptureStream.html

Methods for interacting with WGPU devices through the CaptureStream.

```APIDOC
## GET /capture_stream/{id}/wgpu_device

### Description
Gets the Wgpu device referenced by device wrapper supplied to `CaptureConfig::with_wgpu_device(..)`.

### Method
GET

### Endpoint
/capture_stream/{id}/wgpu_device

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the capture stream.

### Response
#### Success Response (200)
- **Option<&Device>** - An optional reference to the WGPU device.

### Response Example
```json
{
  "device": "wgpu_device_object"
}
```
```

```APIDOC
## GET /capture_stream/{id}/wgpu_device_wrapper

### Description
Gets the Wgpu device wrapper supplied to `CaptureConfig::with_wgpu_device(..)`.

### Method
GET

### Endpoint
/capture_stream/{id}/wgpu_device_wrapper

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the capture stream.

### Response
#### Success Response (200)
- **Option<Arc<dyn AsRef<Device> + Send + Sync + 'static>>** - An optional WGPU device wrapper.

### Response Example
```json
{
  "device_wrapper": "wgpu_device_wrapper_object"
}
```
```

--------------------------------

### CaptureAccessToken Methods

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capture_stream/struct.CaptureAccessToken.html

Details regarding the CaptureAccessToken struct and its available methods.

```APIDOC
## CaptureAccessToken

### Description
Represents programmatic capture access.

### Methods
- **allows_borderless**(&self) -> bool
  - Returns true if the capture access allows borderless mode.
```

--------------------------------

### Iterate Over Capturable Windows

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableContent.html

Provides an iterator over the capturable windows available on the system.

```rust
pub fn windows<'a>(&'a self) -> CapturableWindowIterator<'a>
```

--------------------------------

### FrameBitmapArgbUnormPacked2101010 Struct

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/feature/bitmap/struct.FrameBitmapArgbUnormPacked2101010.html

Represents a bitmap in Rgba1010102 format.

```APIDOC
## Struct FrameBitmapArgbUnormPacked2101010

### Description
A Rgba1010102 format bitmap.

### Fields
- **data** (Data) - The bitmap data.
- **width** (usize) - The width of the bitmap.
- **height** (usize) - The height of the bitmap.

### Auto Trait Implementations
- **Freeze**
- **RefUnwindSafe**
- **Send**
- **Sync**
- **Unpin**
- **UnwindSafe**

### Blanket Implementations
- **Any**
  - `type_id(&self) -> TypeId`
- **Borrow<T>**
  - `borrow(&self) -> &T`
- **BorrowMut<T>**
  - `borrow_mut(&mut self) -> &mut T`
- **From<T>**
  - `from(t: T) -> T`
- **Into<U>**
  - `into(self) -> U`
- **TryFrom<U>**
  - `try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`
- **TryInto<U>**
  - `try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`
- **WasmNotSend**
- **WasmNotSendSync**
- **WasmNotSync
```

--------------------------------

### AudioFrame Methods

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/frame/struct.AudioFrame.html

Methods available on the AudioFrame struct to retrieve audio properties and channel data.

```APIDOC
## AudioFrame Methods

### sample_rate()
- **Description**: Get the sample rate of the captured audio.
- **Returns**: AudioSampleRate

### channel_count()
- **Description**: Get the channel count of the captured audio.
- **Returns**: AudioChannelCount

### audio_channel_buffer(channel: usize)
- **Description**: Get the data buffer for the captured audio channel.
- **Parameters**: 
  - **channel** (usize) - Required - The index of the audio channel.
- **Returns**: Result<AudioChannelData<'_>, AudioBufferError>

### duration()
- **Description**: Get the duration of this audio frame.
- **Returns**: Duration

### origin_time()
- **Description**: Get the time since the start of the stream that this audio frame begins at.
- **Returns**: Duration

### frame_id()
- **Description**: Get the sequence id of this frame (monotonically increasing).
- **Returns**: u64
```

--------------------------------

### CapturableContentFilter::new

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableContentFilter.html

Creates a new content filter with specified options for including displays and filtering windows. Pass `true` for `displays` to include them, and an `Option<CapturableWindowFilter>` for window filtering.

```rust
pub fn new(displays: bool, windows: Option<CapturableWindowFilter>) -> Self
```

--------------------------------

### feature::screenshot::take_screenshot

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/all.html

Captures a screenshot using the platform-specific implementation.

```APIDOC
## Function take_screenshot

### Description
Captures a screenshot of the current display or selected content.

### Parameters
- This function is part of the `feature::screenshot` module.

### Response
- **Result** (Result<FrameBitmap, ScreenshotError>) - Returns a bitmap of the captured frame or a ScreenshotError if the operation fails.
```

--------------------------------

### Clone AudioSampleRate

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/frame/enum.AudioSampleRate.html

Allows creating a duplicate of an AudioSampleRate value. This is useful for passing sample rates around without moving ownership.

```rust
fn clone(&self) -> AudioSampleRate
```

--------------------------------

### CapturableContent::new

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableContent.html

Requests a new collection of capturable content from the OS based on a filter.

```APIDOC
## pub async fn new(filter: CapturableContentFilter) -> Result<Self, CapturableContentError>

### Description
Requests capturable content from the OS. Note that the returned content may be stale; windows enumerated here may close before they are used to open a stream.

### Parameters
#### Request Body
- **filter** (CapturableContentFilter) - Required - The filter criteria for the requested content.

### Response
#### Success Response (200)
- **CapturableContent** (Struct) - A collection of capturable windows and displays.
```

--------------------------------

### Screenshot Utility API

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/feature/screenshot/index.html

Provides functions for taking screenshots, requiring the 'screenshot' feature to be enabled.

```APIDOC
## Module screenshot

crabgrab::feature

### Summary

Screenshot utility function (requires `screenshot` feature)

## Enums

### ScreenshotError

#### Description

Represents an error while taking a screenshot.

## Functions

### take_screenshot

#### Description

Take a screenshot of the capturable content given a configuration.

### Method

(Not specified in the provided text, assuming a function call within the Rust ecosystem)

### Endpoint

(Not applicable for a Rust function)

### Parameters

(Parameters are not explicitly detailed in the provided text, but a 'configuration' is mentioned.)

### Request Example

(Not applicable for a Rust function)

### Response

#### Success Response

(The return type is not explicitly detailed, but it's implied to be a successful screenshot operation.)

#### Response Example

(Not applicable for a Rust function)
```

--------------------------------

### Borrow and BorrowMut Implementations

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableDisplay.html

Allows borrowing the value immutably or mutably, enabling access to the underlying data without taking ownership.

```rust
fn borrow(&self) -> &T
```

```rust
fn borrow_mut(&mut self) -> &mut T
```

--------------------------------

### CapturableContent::windows

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableContent.html

Retrieves an iterator over the windows available for capture.

```APIDOC
## pub fn windows<'a>(&'a self) -> CapturableWindowIterator<'a>

### Description
Get an iterator over the capturable windows currently available in the collection.

### Response
#### Success Response (200)
- **CapturableWindowIterator** (Iterator) - An iterator yielding capturable windows.
```

--------------------------------

### From and Into Trait Implementations

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableDisplay.html

Facilitates conversions between types. `from` creates a new instance, and `into` converts an owned value into another type.

```rust
fn from(t: T) -> T
```

```rust
fn into(self) -> U
```

--------------------------------

### Iterator Adapters

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableDisplayIterator.html

This section covers common iterator adapter methods for transforming and consuming iterators.

```APIDOC
## Iterator Adapters

This section details various methods available on Rust iterators for transforming and consuming their elements.

### `map_while<B, P>`

- **Description**: Creates an iterator that both yields elements based on a predicate and maps them. It stops yielding elements once the predicate returns `None`.
- **Method**: (Implicitly called on an iterator)
- **Endpoint**: N/A (Method on Iterator trait)

### `skip(n: usize)`

- **Description**: Creates an iterator that skips the first `n` elements of the underlying iterator.
- **Method**: (Implicitly called on an iterator)
- **Endpoint**: N/A (Method on Iterator trait)

### `take(n: usize)`

- **Description**: Creates an iterator that yields the first `n` elements, or fewer if the underlying iterator ends sooner.
- **Method**: (Implicitly called on an iterator)
- **Endpoint**: N/A (Method on Iterator trait)

### `scan<St, B, F>`

- **Description**: An iterator adapter which holds internal state and produces a new iterator. It applies a closure `f` to an internal state and each item, yielding the result of the closure if it's `Some`.
- **Method**: (Implicitly called on an iterator)
- **Endpoint**: N/A (Method on Iterator trait)

### `flat_map<U, F>`

- **Description**: Creates an iterator that works like `map`, but flattens nested structures. It applies a closure `f` to each item, and the closure must return an `IntoIterator`, whose elements are then yielded by the resulting iterator.
- **Method**: (Implicitly called on an iterator)
- **Endpoint**: N/A (Method on Iterator trait)

### `map_windows<F, R, const N: usize>`

- **Description**: 🔬 Nightly-only experimental API. Calls the given function `f` for each contiguous window of size `N` over `self` and returns an iterator over the outputs of `f`. The windows overlap.
- **Method**: (Implicitly called on an iterator)
- **Endpoint**: N/A (Method on Iterator trait)

### `fuse()`

- **Description**: Creates an iterator which ends after the first `None` is encountered.
- **Method**: (Implicitly called on an iterator)
- **Endpoint**: N/A (Method on Iterator trait)

### `inspect<F>`

- **Description**: Does something with each element of an iterator, passing the value on without consuming it.
- **Method**: (Implicitly called on an iterator)
- **Endpoint**: N/A (Method on Iterator trait)

### `by_ref()`

- **Description**: Creates a “by reference” adapter for this instance of `Iterator`, allowing mutable borrowing of the iterator itself.
- **Method**: (Implicitly called on an iterator)
- **Endpoint**: N/A (Method on Iterator trait)

### `collect<B>()`

- **Description**: Transforms an iterator into a collection. The type `B` must implement `FromIterator` for the iterator's item type.
- **Method**: (Implicitly called on an iterator)
- **Endpoint**: N/A (Method on Iterator trait)

### `collect_into<E>(collection: &mut E)`

- **Description**: 🔬 Nightly-only experimental API. Collects all the items from an iterator into a mutable collection.
- **Method**: (Implicitly called on an iterator)
- **Endpoint**: N/A (Method on Iterator trait)

### `partition<B, F>(f: F)`

- **Description**: Consumes an iterator, creating two collections from it based on a predicate `f`. Elements for which `f` returns `true` go into the first collection, and the rest into the second.
- **Method**: (Implicitly called on an iterator)
- **Endpoint**: N/A (Method on Iterator trait)

### `is_partitioned<P>(predicate: P)`

- **Description**: 🔬 Nightly-only experimental API. Checks if the elements of this iterator are partitioned according to the given predicate, such that all elements returning `true` precede all elements returning `false`.
- **Method**: (Implicitly called on an iterator)
- **Endpoint**: N/A (Method on Iterator trait)

### `try_fold<B, F, R>(&mut self, init: B, f: F)`

- **Description**: An iterator method that applies a fallible function `f` as long as it returns successfully, producing a single, final value. It stops at the first error.
- **Method**: (Implicitly called on an iterator)
- **Endpoint**: N/A (Method on Iterator trait)

### `try_for_each<F, R>(&mut self, f: F)`

- **Description**: An iterator method that applies a fallible function `f` to each item in the iterator, stopping at the first error and returning that error.
- **Method**: (Implicitly called on an iterator)
- **Endpoint**: N/A (Method on Iterator trait)

### `fold<B, F>(init: B, f: F)`

- **Description**: Folds every element into an accumulator by applying an operation defined by `f`, returning the final result.
- **Method**: (Implicitly called on an iterator)
- **Endpoint**: N/A (Method on Iterator trait)

### `reduce<F>(f: F)`

- **Description**: Reduces the elements of an iterator to a single one by repeatedly applying a reducing operation defined by `f`.
- **Method**: (Implicitly called on an iterator)
- **Endpoint**: N/A (Method on Iterator trait)

### `try_reduce<R>(&mut self, f: impl FnMut(Self::Item, Self::Item) -> R)`

- **Description**: 🔬 Nightly-only experimental API. Reduces the elements to a single one by repeatedly applying a reducing operation. If the closure returns a failure, the failure is propagated back to the caller immediately.
- **Method**: (Implicitly called on an iterator)
- **Endpoint**: N/A (Method on Iterator trait)

### `all<F>(&mut self, f: F)`

- **Description**: Tests if every element of the iterator matches a predicate `f`.
- **Method**: (Implicitly called on an iterator)
- **Endpoint**: N/A (Method on Iterator trait)

### `any<F>(&mut self, f: F)`

- **Description**: Tests if any element of the iterator matches a predicate `f`.
- **Method**: (Implicitly called on an iterator)
- **Endpoint**: N/A (Method on Iterator trait)

### `find<P>(&mut self, predicate: P)`

- **Description**: Searches for an element of an iterator that satisfies a predicate `P` and returns the first one found.
- **Method**: (Implicitly called on an iterator)
- **Endpoint**: N/A (Method on Iterator trait)

```

--------------------------------

### Implement Sync for CapturableContent

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableContent.html

Indicates that CapturableContent can be safely shared between threads.

```rust
impl Sync for CapturableContent
```

--------------------------------

### Clone Implementation for Size

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/util/struct.Size.html

Provides methods to duplicate and copy-assign Size values. This is an auto-implemented trait for structs with Clone.

```rust
fn clone(&self) -> Size
```

```rust
fn clone_from(&mut self, source: &Self)
```

--------------------------------

### Compare CapturableWindow for Inequality

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableWindow.html

Tests if two CapturableWindow values are not equal. This method is part of the PartialEq trait.

```rust
fn ne(&self, other: &Rhs) -> bool
```

--------------------------------

### VideoFrame Methods

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/frame/struct.VideoFrame.html

Methods to retrieve metadata and properties of a captured video frame.

```APIDOC
## VideoFrame Metadata Access

### Description
Methods to retrieve frame sequence IDs, timing, size, and DPI information.

### Methods
- **frame_id() -> u64**: Get the monotonically increasing sequence id of this video frame.
- **capture_time() -> Instant**: Get the Instant that this frame was delivered to the application.
- **origin_time() -> Duration**: Get the time since the start of the stream that this frame was generated.
- **size() -> Size**: Get the raw size of the frame.
- **dpi() -> f64**: Get the dpi of the contents of the frame.
- **content_rect() -> Rect**: Get the rectangle of the frame representing containing the captured contents.
```

--------------------------------

### Implement From for T

Source: https://docs.rs/crabgrab/0.4.0/crabgrab/capturable_content/struct.CapturableContent.html

A blanket implementation of the From trait for any type T.

```rust
impl<T> From<T> for T
```
Tokens:
Raw