Struct SCStreamConfiguration 

pub struct SCStreamConfiguration { /* private fields */ }

Available on crate feature SCStream only.

SCStreamConfiguration

SCStreamConfiguration is an object that encapsulates the SCStream properties such as output width, height, pixelformat and others.

See also Apple’s documentation

Implementations

impl SCStreamConfiguration

pub unsafe fn width(&self) -> usize

SCStreamProperty for output width as measured in pixels. Default is set to 1920.

pub unsafe fn setWidth(&self, width: usize)

Setter for width.

pub unsafe fn height(&self) -> usize

SCStreamProperty for output height as measured in pixels. Default is set to 1080.

pub unsafe fn setHeight(&self, height: usize)

Setter for height.

pub unsafe fn minimumFrameInterval(&self) -> CMTime

Available on crate feature objc2-core-media only.

SCStreamProperty that specifies the desired minimum time in seconds between frame updates, allowing you to throttle the rate at which updates are received. The default value is 1/60, meaning that updates are coming in at or up to 60fps. Set this to kCMTimeZero to capture at display’s native refresh rate.

pub unsafe fn setMinimumFrameInterval(&self, minimum_frame_interval: CMTime)

Available on crate feature objc2-core-media only.

Setter for minimumFrameInterval.

pub unsafe fn pixelFormat(&self) -> u32

SCStreamProperty for output pixel format. Supported pixel formats are: ‘BGRA’: Packed Little Endian ARGB8888 ‘l10r’: Packed Little Endian ARGB2101010 ‘420v’: 2-plane “video” range YCbCr 4:2:0 ‘420f’: 2-plane “full” range YCbCr 4:2:0 ‘xf44’: 2 plane “full” range YCbCr10 4:4:4 ‘RGhA’: 64 bit RGBA IEEE half-precision float, 16-bit little-endian See https://developer.apple.com/documentation/coregraphics/1455170-cgdisplaystreamcreate

pub unsafe fn setPixelFormat(&self, pixel_format: u32)

Setter for pixelFormat.

pub unsafe fn scalesToFit(&self) -> bool

SCStreamProperty for output to be always scaled to fit into the provided width and height. For use for independent window capture. When true, the output scales up and down. When false, the output only scales down.

pub unsafe fn setScalesToFit(&self, scales_to_fit: bool)

Setter for scalesToFit.

pub unsafe fn preservesAspectRatio(&self) -> bool

SCStreamProperty that specifies whether the stream preserves the aspect ratio of the source pixel data. By default the aspect ratio is preserved.

pub unsafe fn setPreservesAspectRatio(&self, preserves_aspect_ratio: bool)

Setter for preservesAspectRatio.

pub unsafe fn streamName(&self) -> Option<Retained<NSString>>

SCStreamProperty the name of the stream

pub unsafe fn setStreamName(&self, stream_name: Option<&NSString>)

Setter for streamName.

pub unsafe fn showsCursor(&self) -> bool

SCStreamProperty that specifies whether the cursor should appear in the stream. By default the cursor is visible.

pub unsafe fn setShowsCursor(&self, shows_cursor: bool)

Setter for showsCursor.

pub unsafe fn showMouseClicks(&self) -> bool

SCStreamProperty that specifies whether to draw a circle around the cursor click, default is NO. This property will not be affected by showsCursor. This property currently applies when pixelFormat is set to BGRA.

pub unsafe fn setShowMouseClicks(&self, show_mouse_clicks: bool)

Setter for showMouseClicks.

pub unsafe fn backgroundColor(&self) -> Retained<CGColor>

Available on crate feature objc2-core-graphics only.

SCStreamProperty for background color. By default the background color is clear.

Safety

This is not retained internally, you must ensure the object is still alive.

pub unsafe fn setBackgroundColor(&self, background_color: &CGColor)

Available on crate feature objc2-core-graphics only.

Setter for backgroundColor.

Safety

This is unretained, you must ensure the object is kept alive while in use.

pub unsafe fn sourceRect(&self) -> CGRect

Available on crate feature objc2-core-foundation only.

SCStreamProperty that specifies that the stream only samples a subset of the frame input. For display streams, if not set, then the entire display is streamed. For independent window streams, if not set, then the entire window is streamed. The rectangle is specified in points in the display’s logical coordinate system.

pub unsafe fn setSourceRect(&self, source_rect: CGRect)

Available on crate feature objc2-core-foundation only.

Setter for sourceRect.

pub unsafe fn destinationRect(&self) -> CGRect

Available on crate feature objc2-core-foundation only.

SCStreamProperty that specifies that the stream outputs the frame data into a subset of the output IOSurface object. For both display streams and independent window streams, if not set, then the entire output surface is used. The rectangle is specified in pixels in the display’s coordinate system.

pub unsafe fn setDestinationRect(&self, destination_rect: CGRect)

Available on crate feature objc2-core-foundation only.

Setter for destinationRect.

pub unsafe fn queueDepth(&self) -> NSInteger

SCStreamProperty that specifies the number of frames to keep in the queue. If not set the default value is 8 frames. Specifying more frames uses more memory, but may allow you to process frame data without stalling the display stream and should not exceed 8 frames.

pub unsafe fn setQueueDepth(&self, queue_depth: NSInteger)

Setter for queueDepth.

pub unsafe fn colorMatrix(&self) -> Retained<CFString>

Available on crate feature objc2-core-foundation only.

SCStreamProperty that specifies the YCbCr matrix applied to the output surface. The value must be one of the strings specified in https://developer.apple.com/documentation/coregraphics/quartz_display_services/display_stream_ycbcr_to_rgb_conversion_matrix_options. Should only be used if your pixel format is 420v or 420f.

Safety

This is not retained internally, you must ensure the object is still alive.

pub unsafe fn setColorMatrix(&self, color_matrix: &CFString)

Available on crate feature objc2-core-foundation only.

Setter for colorMatrix.

Safety

This is unretained, you must ensure the object is kept alive while in use.

pub unsafe fn colorSpaceName(&self) -> Retained<CFString>

Available on crate feature objc2-core-foundation only.

SCStreamProperty that specifies the color space of the output buffer. If not set the output buffer uses the same color space as the display. The value must be one of the strings specified in https://developer.apple.com/documentation/coregraphics/cgcolorspace/color_space_names.

Safety

This is not retained internally, you must ensure the object is still alive.

pub unsafe fn setColorSpaceName(&self, color_space_name: &CFString)

Available on crate feature objc2-core-foundation only.

Setter for colorSpaceName.

Safety

This is unretained, you must ensure the object is kept alive while in use.

pub unsafe fn capturesAudio(&self) -> bool

SCStreamProperty that specifies whether the audio will be captured. By default audio is not captured.

pub unsafe fn setCapturesAudio(&self, captures_audio: bool)

Setter for capturesAudio.

pub unsafe fn sampleRate(&self) -> NSInteger

SCStreamProperty to specify the sample rate for audio. Default is set to 48000.

pub unsafe fn setSampleRate(&self, sample_rate: NSInteger)

Setter for sampleRate.

pub unsafe fn channelCount(&self) -> NSInteger

SCStreamProperty to specify channel count. Default is set to two.

pub unsafe fn setChannelCount(&self, channel_count: NSInteger)

Setter for channelCount.

pub unsafe fn excludesCurrentProcessAudio(&self) -> bool

SCAudioProperty whether to exclude audio from current process. Default is set to NO.

pub unsafe fn setExcludesCurrentProcessAudio( &self, excludes_current_process_audio: bool, )

Setter for excludesCurrentProcessAudio.

pub unsafe fn ignoreShadowsDisplay(&self) -> bool

SCStreamProperty to ignore framing on windows in the display sharing case (will ignore shadows).

pub unsafe fn setIgnoreShadowsDisplay(&self, ignore_shadows_display: bool)

Setter for ignoreShadowsDisplay.

pub unsafe fn ignoreShadowsSingleWindow(&self) -> bool

SCStreamProperty to ignore framing on windows in the single window sharing case (will ignore shadows).

pub unsafe fn setIgnoreShadowsSingleWindow( &self, ignore_shadows_single_window: bool, )

Setter for ignoreShadowsSingleWindow.

pub unsafe fn captureResolution(&self) -> SCCaptureResolutionType

captureResolution Choose between automatic, best, and nominal.

pub unsafe fn setCaptureResolution( &self, capture_resolution: SCCaptureResolutionType, )

Setter for captureResolution.

pub unsafe fn capturesShadowsOnly(&self) -> bool

SCStreamProperty to capture only the shadows of windows.

pub unsafe fn setCapturesShadowsOnly(&self, captures_shadows_only: bool)

Setter for capturesShadowsOnly.

pub unsafe fn shouldBeOpaque(&self) -> bool

SCStreamProperty to ensure partially transparent areas on windows are backed by a solid white color so that the resulting image is fully opaque.

pub unsafe fn setShouldBeOpaque(&self, should_be_opaque: bool)

Setter for shouldBeOpaque.

pub unsafe fn ignoreGlobalClipDisplay(&self) -> bool

SCStreamProperty to ignore framing on windows in the display sharing case (will ignore shadows).

pub unsafe fn setIgnoreGlobalClipDisplay( &self, ignore_global_clip_display: bool, )

Setter for ignoreGlobalClipDisplay.

pub unsafe fn ignoreGlobalClipSingleWindow(&self) -> bool

SCStreamProperty to ignore global clipping when on single window share. When set to true, single window captures that are partially off the screen will not be clipped. (will ignore window placement in display context).

pub unsafe fn setIgnoreGlobalClipSingleWindow( &self, ignore_global_clip_single_window: bool, )

Setter for ignoreGlobalClipSingleWindow.

pub unsafe fn presenterOverlayPrivacyAlertSetting( &self, ) -> SCPresenterOverlayAlertSetting

SCStreamProperty that informs the system if a privacy alert should be shown when using presenter overlay for a stream. Defaults to SCPresenterOverlayAlertSettingSystem;

pub unsafe fn setPresenterOverlayPrivacyAlertSetting( &self, presenter_overlay_privacy_alert_setting: SCPresenterOverlayAlertSetting, )

Setter for presenterOverlayPrivacyAlertSetting.

pub unsafe fn includeChildWindows(&self) -> bool

SCStreamProperty to show the child windows in display bound windows and applications sharing. Child windows are included by default.

pub unsafe fn setIncludeChildWindows(&self, include_child_windows: bool)

Setter for includeChildWindows.

pub unsafe fn captureMicrophone(&self) -> bool

SCStreamProperty that specifies whether the microphone audio will be captured. By default microphone is not captured.

pub unsafe fn setCaptureMicrophone(&self, capture_microphone: bool)

Setter for captureMicrophone.

pub unsafe fn microphoneCaptureDeviceID(&self) -> Option<Retained<NSString>>

SCStreamProperty that specifies which microphone device to capture. This deviceID is the uniqueID from AVCaptureDevice for the microphone. System Default Microphone will be used if not specified by client. For Mac Catalyst apps, the System Default Microphone will be captured.

pub unsafe fn setMicrophoneCaptureDeviceID( &self, microphone_capture_device_id: Option<&NSString>, )

Setter for microphoneCaptureDeviceID.

pub unsafe fn captureDynamicRange(&self) -> SCCaptureDynamicRange

SCStreamProperty client will choose captureDynamicRange between SCCaptureDynamicRangeSDR, SCCaptureDynamicRangeHDRLocalDisplay, SCCaptureDynamicRangeHDRCanonicalDisplay. By default, the stream is capturing with SCCaptureDynamicRangeSDR. HDR capture is only supported with Apple Silicon Mac, setting this property on Intel Mac will have no effect. HDR recording is not support yet, adding a recording output to a stream with SCCaptureDynamicRangeHDR set will fail.

pub unsafe fn setCaptureDynamicRange( &self, capture_dynamic_range: SCCaptureDynamicRange, )

Setter for captureDynamicRange.

pub unsafe fn streamConfigurationWithPreset( preset: SCStreamConfigurationPreset, ) -> Retained<Self>

Returns an instance of SCStreamConfiguration corresponding to the given preset

Parameter preset: The enum identifier for the desired preset

The SCStreamConfiguration of the returned object can be used as a guide for creating and configuring an SCStream. If all the suggested properties are respected in creating the SCStream, the resulting capture result will conform to the criteria implied by the preset.

impl SCStreamConfiguration

Methods declared on superclass NSObject.

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

pub unsafe fn new() -> Retained<Self>

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for SCStreamConfiguration

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for SCStreamConfiguration

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<SCStreamConfiguration> for SCStreamConfiguration

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for SCStreamConfiguration

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for SCStreamConfiguration

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for SCStreamConfiguration

const NAME: &'static str = "SCStreamConfiguration"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = <<SCStreamConfiguration as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for SCStreamConfiguration

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

Formats the value using the given formatter.

impl Deref for SCStreamConfiguration

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for SCStreamConfiguration

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for SCStreamConfiguration

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for SCStreamConfiguration

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for SCStreamConfiguration

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for SCStreamConfiguration

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for SCStreamConfiguration

impl Eq for SCStreamConfiguration