Struct objc2_screen_capture_kit::SCStreamConfiguration

#[repr(C)]
pub struct SCStreamConfiguration { /* private fields */ }

Available on crate feature SCStream only.

Implementations

impl SCStreamConfiguration

pub unsafe fn width(&self) -> usize

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

pub unsafe fn height(&self) -> usize

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

pub unsafe fn pixelFormat(&self) -> OSType

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

pub unsafe fn scalesToFit(&self) -> bool

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

pub unsafe fn preservesAspectRatio(&self) -> bool

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

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

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

pub unsafe fn showsCursor(&self) -> bool

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

pub unsafe fn sourceRect(&self) -> CGRect

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

pub unsafe fn destinationRect(&self) -> CGRect

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

pub unsafe fn queueDepth(&self) -> NSInteger

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

pub unsafe fn capturesAudio(&self) -> bool

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

pub unsafe fn sampleRate(&self) -> NSInteger

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

pub unsafe fn channelCount(&self) -> NSInteger

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

pub unsafe fn excludesCurrentProcessAudio(&self) -> bool

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

pub unsafe fn ignoreShadowsDisplay(&self) -> bool

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

pub unsafe fn ignoreShadowsSingleWindow(&self) -> bool

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

pub unsafe fn captureResolution(&self) -> SCCaptureResolutionType

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

pub unsafe fn capturesShadowsOnly(&self) -> bool

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

pub unsafe fn shouldBeOpaque(&self) -> bool

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

pub unsafe fn ignoreGlobalClipDisplay(&self) -> bool

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

pub unsafe fn ignoreGlobalClipSingleWindow(&self) -> bool

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

pub unsafe fn presenterOverlayPrivacyAlertSetting( &self ) -> SCPresenterOverlayAlertSetting

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

pub unsafe fn includeChildWindows(&self) -> bool

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

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.

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 unsafe fn get_mut_ivar<T>(&mut self, name: &str) -> &mut T

where T: Encode,

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

Use Ivar::load_mut 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.

Trait Implementations

impl AsMut<AnyObject> for SCStreamConfiguration

fn as_mut(&mut self) -> &mut AnyObject

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

impl AsMut<NSObject> for SCStreamConfiguration

fn as_mut(&mut self) -> &mut NSObject

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

impl AsMut<SCStreamConfiguration> for SCStreamConfiguration

fn as_mut(&mut self) -> &mut Self

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

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 BorrowMut<AnyObject> for SCStreamConfiguration

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

Mutably borrows from an owned value.

impl BorrowMut<NSObject> for SCStreamConfiguration

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

Mutably borrows from an owned value.

impl ClassType for SCStreamConfiguration

type Super = NSObject

The superclass of this class.

type Mutability = InteriorMutable

Whether the type is mutable or immutable.

const NAME: &'static str = "SCStreamConfiguration"

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

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.

fn as_super_mut(&mut self) -> &mut Self::Super

Get a mutable reference to the superclass.

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

where Self: IsRetainable + Sized,

Increment the reference count of the receiver.

fn alloc() -> Allocated<Self>

where Self: Sized + IsAllocableAnyThread,

Allocate a new instance of the class.

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 DerefMut for SCStreamConfiguration

fn deref_mut(&mut self) -> &mut Self::Target

Mutably 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 NSObjectProtocol for SCStreamConfiguration

fn isEqual(&self, other: &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,

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: &SCStreamConfiguration) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method 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 Eq for SCStreamConfiguration

impl Message for SCStreamConfiguration

impl StructuralPartialEq for SCStreamConfiguration