Struct SCContentFilter 

pub struct SCContentFilter { /* private fields */ }

Available on crate feature SCStream only.

SCContentFilter

SCContentFilter is a object that determines the exact content to be captured in the SCStream. It can be filtered through displays, windows, excluded windows or applications.

See also Apple’s documentation

Implementations

impl SCContentFilter

pub unsafe fn streamType(&self) -> SCStreamType

👎Deprecated: Use style instead

streamType type of stream

pub unsafe fn style(&self) -> SCShareableContentStyle

Available on crate feature SCShareableContent only.

style of stream

pub unsafe fn pointPixelScale(&self) -> c_float

Pixel to points scaling factor

pub unsafe fn contentRect(&self) -> CGRect

Available on crate feature objc2-core-foundation only.

Size and location of content in points

pub unsafe fn includeMenuBar(&self) -> bool

To include menu bar as part of the capture. This property has no effect for the desktop independent window filter. For content filters created with initWithDisplay:excluding, the default value is YES. Display excluding content filters contains the desktop and dock. For content filters created with initWithDisplay:including, the default value is NO. Display including content filters do not contain the desktop and dock

pub unsafe fn setIncludeMenuBar(&self, include_menu_bar: bool)

Setter for includeMenuBar.

pub unsafe fn includedDisplays(&self) -> Retained<NSArray<SCDisplay>>

Available on crate feature SCShareableContent only.

SCDisplays that are included in the content filter

pub unsafe fn includedApplications( &self, ) -> Retained<NSArray<SCRunningApplication>>

Available on crate feature SCShareableContent only.

Applications that are included in the content filter

pub unsafe fn includedWindows(&self) -> Retained<NSArray<SCWindow>>

Available on crate feature SCShareableContent only.

Windows that are included in the content filter

pub unsafe fn initWithDesktopIndependentWindow( this: Allocated<Self>, window: &SCWindow, ) -> Retained<Self>

Available on crate feature SCShareableContent only.

initWithDesktopIndependentWindow:

Parameter window: the independent SCWindow you wish to capture

this method will create a SCContentFilter that captures just the independent window passed in.

pub unsafe fn initWithDisplay_excludingWindows( this: Allocated<Self>, display: &SCDisplay, excluded: &NSArray<SCWindow>, ) -> Retained<Self>

Available on crate feature SCShareableContent only.

initWithDisplay:excludingWindows

Parameter display: the SCDisplay you wish to capture

Parameter excluded: the SCWindow(s) you wish to exclude from the passed in SCDisplay

This method will create a SCContentFilter that captures the SCDisplay, excluding the passed in excluded SCWindow(s). The desktop background and dock will be included with this content filter.

pub unsafe fn initWithDisplay_includingWindows( this: Allocated<Self>, display: &SCDisplay, included_windows: &NSArray<SCWindow>, ) -> Retained<Self>

Available on crate feature SCShareableContent only.

initWithDisplay:includingWindows

Parameter display: the SCDisplay you wish to capture

Parameter includedWindows: a set of SCWindows you wish to capture

This method will create a SCContentFilter that captures a group of SCWindows. The desktop background and dock will be excluded with this content filter.

pub unsafe fn initWithDisplay_includingApplications_exceptingWindows( this: Allocated<Self>, display: &SCDisplay, applications: &NSArray<SCRunningApplication>, excepting_windows: &NSArray<SCWindow>, ) -> Retained<Self>

Available on crate feature SCShareableContent only.

initWithDisplay:includingApplications:exceptingWindows

Parameter display: the SCDisplay you wish to capture

Parameter applications: the NSSet of SCRunningApplications that you wish to capture

Parameter exceptingWindows: the NSSet of SCWindows that you wish to be an exception to the filter

This method creates a SCContentFilter that captures all windows owned by the passed in SCRunningApplications. Any windows that are an exception to the filter will not be shown if their owning application is in the provided list and will be shown otherwise. The desktop background and dock will be excluded with this content filter.

pub unsafe fn initWithDisplay_excludingApplications_exceptingWindows( this: Allocated<Self>, display: &SCDisplay, applications: &NSArray<SCRunningApplication>, excepting_windows: &NSArray<SCWindow>, ) -> Retained<Self>

Available on crate feature SCShareableContent only.

initWithDisplay:excludingApplications:exceptingWindows

Parameter display: the SCDisplay you wish to capture

Parameter applications: the NSSet of SCRunningApplications that you do not wish to capture

Parameter exceptingWindows: the NSSet of SCWindows that you wish to be an exception to the filter

This method creates a SCContentFilter that captures all windows not owned by the passed in SCRunningApplications. Any windows that are an exception to the filter will be shown if their owning application is in the provided list and will not be shown otherwise. The desktop background and dock will be included with this content filter.

impl SCContentFilter

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 SCContentFilter

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for SCContentFilter

fn as_ref(&self) -> &NSObject

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

impl AsRef<SCContentFilter> for SCContentFilter

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for SCContentFilter

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for SCContentFilter

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for SCContentFilter

const NAME: &'static str = "SCContentFilter"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<SCContentFilter 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 SCContentFilter

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

Formats the value using the given formatter.

impl Deref for SCContentFilter

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for SCContentFilter

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 SCContentFilter

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for SCContentFilter

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 SCContentFilter

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 SCContentFilter

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

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

impl DowncastTarget for SCContentFilter

impl Eq for SCContentFilter