diff --git a/Cargo.toml b/Cargo.toml index 5ab7696d..da11b311 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "crabgrab" description = "A cross-platform screen/window capture crate" -version = "0.3.1" +version = "0.3.2" edition = "2021" authors = ["Augmend, Inc. ", "Liam Taylor ", "Tim Misiak "] documentation = "https://docs.rs/crabgrab" diff --git a/docs/macos_docs/crabgrab/all.html b/docs/macos_docs/crabgrab/all.html index b4d28ab5..fcae78c3 100644 --- a/docs/macos_docs/crabgrab/all.html +++ b/docs/macos_docs/crabgrab/all.html @@ -1,2 +1,2 @@ -List of all items in this crate +List of all items in this crate

List of all items

Structs

Enums

Traits

Functions

\ No newline at end of file diff --git a/docs/macos_docs/crabgrab/capturable_content/enum.CapturableContentError.html b/docs/macos_docs/crabgrab/capturable_content/enum.CapturableContentError.html index 61ea5f9b..42079534 100644 --- a/docs/macos_docs/crabgrab/capturable_content/enum.CapturableContentError.html +++ b/docs/macos_docs/crabgrab/capturable_content/enum.CapturableContentError.html @@ -1,8 +1,8 @@ -CapturableContentError in crabgrab::capturable_content - Rust +CapturableContentError in crabgrab::capturable_content - Rust
pub enum CapturableContentError {
     Other(String),
 }
Expand description

Represents an error that occurred when enumerating capturable content

-

Variants§

§

Other(String)

Trait Implementations§

source§

impl Clone for CapturableContentError

source§

fn clone(&self) -> CapturableContentError

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for CapturableContentError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for CapturableContentError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Error for CapturableContentError

source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where +

Variants§

§

Other(String)

Trait Implementations§

source§

impl Clone for CapturableContentError

source§

fn clone(&self) -> CapturableContentError

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for CapturableContentError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for CapturableContentError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Error for CapturableContentError

source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/docs/macos_docs/crabgrab/capturable_content/index.html b/docs/macos_docs/crabgrab/capturable_content/index.html index 83133394..8c91a8b2 100644 --- a/docs/macos_docs/crabgrab/capturable_content/index.html +++ b/docs/macos_docs/crabgrab/capturable_content/index.html @@ -1,3 +1,3 @@ -crabgrab::capturable_content - Rust +crabgrab::capturable_content - Rust
Expand description

Enumeration of capturable items

Structs§

Enums§

\ No newline at end of file diff --git a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableApplication.html b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableApplication.html index 45a24355..3c2fd7d7 100644 --- a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableApplication.html +++ b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableApplication.html @@ -1,4 +1,4 @@ -CapturableApplication in crabgrab::capturable_content - Rust +CapturableApplication in crabgrab::capturable_content - Rust
pub struct CapturableApplication { /* private fields */ }
Expand description

Represents an application with capturable windows

Implementations§

source§

impl CapturableApplication

source

pub fn identifier(&self) -> String

Gets the “identifier” of the application

On MacOS, this is the application bundle, and on windows, this is the application file name

diff --git a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableContent.html b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableContent.html index 8ff389c0..c163e8dc 100644 --- a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableContent.html +++ b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableContent.html @@ -1,4 +1,4 @@ -CapturableContent in crabgrab::capturable_content - Rust +CapturableContent in crabgrab::capturable_content - Rust
pub struct CapturableContent { /* private fields */ }
Expand description

A collection of capturable content (windows, screens)

Implementations§

source§

impl CapturableContent

source

pub async fn new( filter: CapturableContentFilter diff --git a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableContentFilter.html b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableContentFilter.html index 52f349a4..020043f3 100644 --- a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableContentFilter.html +++ b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableContentFilter.html @@ -1,4 +1,4 @@ -CapturableContentFilter in crabgrab::capturable_content - Rust +CapturableContentFilter in crabgrab::capturable_content - Rust
pub struct CapturableContentFilter { /* private fields */ }
Expand description

Selects the kind of capturable content to enumerate

Implementations§

source§

impl CapturableContentFilter

source

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

Create a new content filter with the given filtering options

source

pub fn is_empty(&self) -> bool

Whether this filter allows any capturable content

diff --git a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableDisplay.html b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableDisplay.html index d1ad4c23..13b01d30 100644 --- a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableDisplay.html +++ b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableDisplay.html @@ -1,4 +1,4 @@ -CapturableDisplay in crabgrab::capturable_content - Rust +CapturableDisplay in crabgrab::capturable_content - Rust
pub struct CapturableDisplay { /* private fields */ }
Expand description

Represents a capturable display

Implementations§

source§

impl CapturableDisplay

source

pub fn rect(&self) -> Rect

Gets the virtual screen rectangle of this display

Note: Currently on windows, this is only evaluated at the time of display enumeration

diff --git a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableDisplayIterator.html b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableDisplayIterator.html index d3cf0667..c16991ec 100644 --- a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableDisplayIterator.html +++ b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableDisplayIterator.html @@ -1,4 +1,4 @@ -CapturableDisplayIterator in crabgrab::capturable_content - Rust +CapturableDisplayIterator in crabgrab::capturable_content - Rust
pub struct CapturableDisplayIterator<'content> { /* private fields */ }
Expand description

An iterator over capturable displays

Trait Implementations§

source§

impl ExactSizeIterator for CapturableDisplayIterator<'_>

source§

fn len(&self) -> usize

Returns the exact remaining length of the iterator. Read more
source§

fn is_empty(&self) -> bool

🔬This is a nightly-only experimental API. (exact_size_is_empty)
Returns true if the iterator is empty. Read more
source§

impl Iterator for CapturableDisplayIterator<'_>

§

type Item = CapturableDisplay

The type of the elements being iterated over.
source§

fn next(&mut self) -> Option<Self::Item>

Advances the iterator and returns the next value. Read more
source§

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the iterator. Read more
source§

fn next_chunk<const N: usize>( &mut self diff --git a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableWindow.html b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableWindow.html index e1b5e2f7..b255fa34 100644 --- a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableWindow.html +++ b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableWindow.html @@ -1,4 +1,4 @@ -CapturableWindow in crabgrab::capturable_content - Rust +CapturableWindow in crabgrab::capturable_content - Rust
pub struct CapturableWindow { /* private fields */ }
Expand description

Represents a capturable application window

Implementations§

source§

impl CapturableWindow

source

pub fn title(&self) -> String

Gets the title of the window

source

pub fn rect(&self) -> Rect

Gets the virtual screen rectangle of the window

diff --git a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableWindowFilter.html b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableWindowFilter.html index ad6709b2..e0222b4e 100644 --- a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableWindowFilter.html +++ b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableWindowFilter.html @@ -1,4 +1,4 @@ -CapturableWindowFilter in crabgrab::capturable_content - Rust +CapturableWindowFilter in crabgrab::capturable_content - Rust
pub struct CapturableWindowFilter {
     pub desktop_windows: bool,
     pub onscreen_only: bool,
diff --git a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableWindowIterator.html b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableWindowIterator.html
index 2aeff897..68620972 100644
--- a/docs/macos_docs/crabgrab/capturable_content/struct.CapturableWindowIterator.html
+++ b/docs/macos_docs/crabgrab/capturable_content/struct.CapturableWindowIterator.html
@@ -1,4 +1,4 @@
-CapturableWindowIterator in crabgrab::capturable_content - Rust
+CapturableWindowIterator in crabgrab::capturable_content - Rust
     
pub struct CapturableWindowIterator<'content> { /* private fields */ }
Expand description

An iterator over capturable windows

Trait Implementations§

source§

impl ExactSizeIterator for CapturableWindowIterator<'_>

1.0.0 · source§

fn len(&self) -> usize

Returns the exact remaining length of the iterator. Read more
source§

fn is_empty(&self) -> bool

🔬This is a nightly-only experimental API. (exact_size_is_empty)
Returns true if the iterator is empty. Read more
source§

impl Iterator for CapturableWindowIterator<'_>

§

type Item = CapturableWindow

The type of the elements being iterated over.
source§

fn next(&mut self) -> Option<Self::Item>

Advances the iterator and returns the next value. Read more
source§

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the iterator. Read more
source§

fn next_chunk<const N: usize>( &mut self diff --git a/docs/macos_docs/crabgrab/capture_stream/enum.CaptureConfigError.html b/docs/macos_docs/crabgrab/capture_stream/enum.CaptureConfigError.html index 4a67f776..f3b1f153 100644 --- a/docs/macos_docs/crabgrab/capture_stream/enum.CaptureConfigError.html +++ b/docs/macos_docs/crabgrab/capture_stream/enum.CaptureConfigError.html @@ -1,11 +1,11 @@ -CaptureConfigError in crabgrab::capture_stream - Rust +CaptureConfigError in crabgrab::capture_stream - Rust
pub enum CaptureConfigError {
     UnsupportedPixelFormat,
     InvalidBufferCount,
 }
Expand description

Represents an error creating the capture config

Variants§

§

UnsupportedPixelFormat

The pixel format is unsupported by the implementation

§

InvalidBufferCount

The buffer count is out of the valid range for the implementation

-

Trait Implementations§

source§

impl Clone for CaptureConfigError

source§

fn clone(&self) -> CaptureConfigError

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for CaptureConfigError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for CaptureConfigError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Error for CaptureConfigError

source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more
source§

impl Send for CaptureConfigError

source§

impl Sync for CaptureConfigError

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where +

Trait Implementations§

source§

impl Clone for CaptureConfigError

source§

fn clone(&self) -> CaptureConfigError

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for CaptureConfigError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for CaptureConfigError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Error for CaptureConfigError

source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more
source§

impl Send for CaptureConfigError

source§

impl Sync for CaptureConfigError

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/docs/macos_docs/crabgrab/capture_stream/enum.CapturePixelFormat.html b/docs/macos_docs/crabgrab/capture_stream/enum.CapturePixelFormat.html index a8fe2799..b73586fb 100644 --- a/docs/macos_docs/crabgrab/capture_stream/enum.CapturePixelFormat.html +++ b/docs/macos_docs/crabgrab/capture_stream/enum.CapturePixelFormat.html @@ -1,4 +1,4 @@ -CapturePixelFormat in crabgrab::capture_stream - Rust +CapturePixelFormat in crabgrab::capture_stream - Rust
#[non_exhaustive]
pub enum CapturePixelFormat { Bgra8888, Argb2101010, diff --git a/docs/macos_docs/crabgrab/capture_stream/enum.StreamCreateError.html b/docs/macos_docs/crabgrab/capture_stream/enum.StreamCreateError.html index 482927af..fcde879e 100644 --- a/docs/macos_docs/crabgrab/capture_stream/enum.StreamCreateError.html +++ b/docs/macos_docs/crabgrab/capture_stream/enum.StreamCreateError.html @@ -1,4 +1,4 @@ -StreamCreateError in crabgrab::capture_stream - Rust +StreamCreateError in crabgrab::capture_stream - Rust
pub enum StreamCreateError {
     Other(String),
     UnsupportedPixelFormat,
diff --git a/docs/macos_docs/crabgrab/capture_stream/enum.StreamError.html b/docs/macos_docs/crabgrab/capture_stream/enum.StreamError.html
index a7bff792..22c2ae1c 100644
--- a/docs/macos_docs/crabgrab/capture_stream/enum.StreamError.html
+++ b/docs/macos_docs/crabgrab/capture_stream/enum.StreamError.html
@@ -1,8 +1,8 @@
-StreamError in crabgrab::capture_stream - Rust
+StreamError in crabgrab::capture_stream - Rust
     
pub enum StreamError {
     Other(String),
 }
Expand description

This represents an error during a stream, for example a failure to retrieve a video or audio frame

-

Variants§

§

Other(String)

Trait Implementations§

source§

impl Clone for StreamError

source§

fn clone(&self) -> StreamError

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for StreamError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for StreamError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Error for StreamError

source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where +

Variants§

§

Other(String)

Trait Implementations§

source§

impl Clone for StreamError

source§

fn clone(&self) -> StreamError

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for StreamError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Display for StreamError

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Error for StreamError

source§

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any. Read more
source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type based access to context intended for error reports. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

diff --git a/docs/macos_docs/crabgrab/capture_stream/enum.StreamEvent.html b/docs/macos_docs/crabgrab/capture_stream/enum.StreamEvent.html index e950ce3c..9bbdc6cf 100644 --- a/docs/macos_docs/crabgrab/capture_stream/enum.StreamEvent.html +++ b/docs/macos_docs/crabgrab/capture_stream/enum.StreamEvent.html @@ -1,4 +1,4 @@ -StreamEvent in crabgrab::capture_stream - Rust +StreamEvent in crabgrab::capture_stream - Rust
pub enum StreamEvent {
     Audio(AudioFrame),
     Video(VideoFrame),
diff --git a/docs/macos_docs/crabgrab/capture_stream/enum.StreamStopError.html b/docs/macos_docs/crabgrab/capture_stream/enum.StreamStopError.html
index 9a5cdf67..b0956ec6 100644
--- a/docs/macos_docs/crabgrab/capture_stream/enum.StreamStopError.html
+++ b/docs/macos_docs/crabgrab/capture_stream/enum.StreamStopError.html
@@ -1,4 +1,4 @@
-StreamStopError in crabgrab::capture_stream - Rust
+StreamStopError in crabgrab::capture_stream - Rust
     
pub enum StreamStopError {
     Other(String),
     AlreadyStopped,
diff --git a/docs/macos_docs/crabgrab/capture_stream/index.html b/docs/macos_docs/crabgrab/capture_stream/index.html
index 9943f341..223a10a1 100644
--- a/docs/macos_docs/crabgrab/capture_stream/index.html
+++ b/docs/macos_docs/crabgrab/capture_stream/index.html
@@ -1,3 +1,3 @@
-crabgrab::capture_stream - Rust
+crabgrab::capture_stream - Rust
     
Expand description

The actual capture stream and related constructs

Structs§

Enums§

\ No newline at end of file diff --git a/docs/macos_docs/crabgrab/capture_stream/struct.AudioCaptureConfig.html b/docs/macos_docs/crabgrab/capture_stream/struct.AudioCaptureConfig.html index 8d8ceeeb..cc36980d 100644 --- a/docs/macos_docs/crabgrab/capture_stream/struct.AudioCaptureConfig.html +++ b/docs/macos_docs/crabgrab/capture_stream/struct.AudioCaptureConfig.html @@ -1,4 +1,4 @@ -AudioCaptureConfig in crabgrab::capture_stream - Rust +AudioCaptureConfig in crabgrab::capture_stream - Rust
pub struct AudioCaptureConfig { /* private fields */ }
Expand description

Configuration settings for audio streams

Implementations§

source§

impl AudioCaptureConfig

source

pub fn new() -> Self

Creates a new audio capture config with default settings: