Skip to main content

Module prelude

Module prelude 

Source
Expand description

Prelude module for convenient imports

Import everything you need with:

use screencapturekit::prelude::*;

§What’s NOT in the prelude

The prelude intentionally only contains the always-available types — anything in a feature-gated module is omitted to avoid cargo doc warnings and conditional re-export complexity. To use the version-gated APIs, import them explicitly:

FeatureModule to import explicitly
macos_14_0screencapturekit::screenshot_manager, screencapturekit::content_sharing_picker
macos_15_0screencapturekit::recording_output
asyncscreencapturekit::async_api

Example:

use screencapturekit::prelude::*;
use screencapturekit::screenshot_manager::SCScreenshotManager;

Re-exports§

pub use crate::audio_devices::AudioInputDevice;
pub use crate::cm::CMSampleBufferExt;
pub use crate::cm::CMSampleBufferSCExt;
pub use crate::error::SCError;
pub use crate::error::SCResult;
pub use crate::shareable_content::SCDisplay;
pub use crate::shareable_content::SCRunningApplication;
pub use crate::shareable_content::SCShareableContent;
pub use crate::shareable_content::SCWindow;
pub use crate::stream::configuration::PixelFormat;
pub use crate::stream::configuration::SCStreamConfiguration;
pub use crate::stream::content_filter::SCContentFilter;
pub use crate::stream::delegate_trait::SCStreamDelegateTrait;
pub use crate::stream::output_trait::SCStreamOutputTrait;
pub use crate::stream::output_type::SCStreamOutputType;
pub use crate::stream::sc_stream::SCStream;
pub use crate::stream::ErrorHandler;

Structs§

CGPoint
CGPoint representation
CGRect
CGRect representation
CGSize
CGSize representation
CMSampleBuffer
Re-exported CMSampleBuffer — same opaque-pointer wrapper used across the doom-fish suite. Owned reference to a CoreMedia CMSampleBufferRef.
CMTime
CMTime representation matching Core Media’s CMTime
DispatchQueue
A wrapper around GCD DispatchQueue

Enums§

DispatchQoS
Quality of Service levels for dispatch queues