Struct CGDisplayStream

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

Available on crate feature CGDisplayStream only.

An opaque reference to a CGDisplayStream object

A CGDisplayStream provides a streaming API for capturing display updates in a realtime manner. It can also provide scaling and color space conversion services, as well as allow capturing sub regions of the display. Callbacks can be targetted at either a traditional CFRunLoop, or at a dispatch queue.

See also Apple’s documentation

Implementations

impl CGDisplayStream

pub unsafe fn new( display: CGDirectDisplayID, output_width: usize, output_height: usize, pixel_format: i32, properties: Option<&CFDictionary>, handler: CGDisplayStreamFrameAvailableHandler, ) -> Option<CFRetained<CGDisplayStream>>

👎Deprecated: Please use ScreenCaptureKit instead.

Available on crate feature CGDirectDisplay and crate feature block2 and crate feature objc2-io-surface and non-watchOS only.

Creates a new CGDisplayStream intended to be used with a CFRunLoop

This function creates a new CGDisplayStream that is to be used to get a stream of frame updates from a particular display.

Parameter display: The CGDirectDisplayID to use as the source for generated frames

Parameter outputWidth: The output width (in pixels, not points) of the frames to be generated. Must not be zero.

Parameter outputHeight: The output height (in pixels, not points) of the frames to be generated. Must not be zero.

Parameter pixelFormat: The desired CoreVideo/CoreMedia-style pixel format of the output IOSurfaces. The currently supported values 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

Parameter properties: Any optional properties of the CGDisplayStream

Parameter handler: A block that will be called for frame deliver.

Returns: The new CGDisplayStream object.

pub unsafe fn with_dispatch_queue( display: CGDirectDisplayID, output_width: usize, output_height: usize, pixel_format: i32, properties: Option<&CFDictionary>, queue: &DispatchQueue, handler: CGDisplayStreamFrameAvailableHandler, ) -> Option<CFRetained<CGDisplayStream>>

👎Deprecated: Please use ScreenCaptureKit instead.

Available on crate feature CGDirectDisplay and crate feature block2 and crate feature dispatch2 and crate feature objc2-io-surface and non-watchOS only.

Creates a new CGDisplayStream intended to be serviced by a block handler

This function creates a new CGDisplayStream that is to be used to get a stream of frame updates from a particular display.

Parameter display: The CGDirectDisplayID to use as the source for generated frames

Parameter outputWidth: The output width (in pixels, not points) of the frames to be generated. Must not be zero.

Parameter outputHeight: The output height (in pixels, not points) of the frames to be generated. Must not be zero.

Parameter pixelFormat: The desired CoreVideo/CoreMedia-style pixel format of the output IOSurfaces

Parameter properties: Any optional properties of the CGDisplayStream

Parameter queue: The dispatch_queue_t that will be used to invoke the callback handler.

Parameter handler: A block that will be called for frame deliver.

Returns: The new CGDisplayStream object.

pub unsafe fn start(display_stream: Option<&CGDisplayStream>) -> CGError

👎Deprecated: Please use ScreenCaptureKit instead.

Available on crate feature CGError only.

Begin delivering frame updates to the handler block.

Parameter displayStream: to be started

Returns: kCGErrorSuccess If the display stream was started, otherwise an error.

pub unsafe fn stop(display_stream: Option<&CGDisplayStream>) -> CGError

👎Deprecated: Please use ScreenCaptureKit instead.

Available on crate feature CGError only.

End delivery of frame updates to the handler block.

Parameter displayStream: to be stopped

Returns: kCGErrorSuccess If the display stream was stopped, otherwise an error.

After this call returns, the CGDisplayStream callback function will eventually be called with a status of kCGDisplayStreamFrameStatusStopped. After that point it is safe to release the CGDisplayStream. It is safe to call this function from within the handler block, but the previous caveat still applies.

pub unsafe fn run_loop_source( display_stream: Option<&CGDisplayStream>, ) -> Option<CFRetained<CFRunLoopSource>>

👎Deprecated: Please use ScreenCaptureKit instead.

Return the singleton CFRunLoopSourceRef for a CGDisplayStream.

Parameter displayStream: The CGDisplayStream object

Returns: The CFRunLoopSource for this displayStream. Note: This function will return NULL if the display stream was created via CGDisplayStreamCreateWithDispatchQueue().

Methods from Deref<Target = CFType>

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

where T: ConcreteType,

Attempt to downcast the type to that of type T.

This is the reference-variant. Use CFRetained::downcast if you want to convert a retained type. See also ConcreteType for more details on which types support being converted to.

pub fn retain_count(&self) -> usize

Get the reference count of the object.

This function may be useful for debugging. You normally do not use this function otherwise.

Beware that some things (like CFNumbers, small CFStrings etc.) may not have a normal retain count for optimization purposes, and can return usize::MAX in that case.

Trait Implementations

impl AsRef<AnyObject> for CGDisplayStream

fn as_ref(&self) -> &AnyObject

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

impl AsRef<CFType> for CGDisplayStream

fn as_ref(&self) -> &CFType

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

impl AsRef<CGDisplayStream> for CGDisplayStream

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for CGDisplayStream

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<CFType> for CGDisplayStream

fn borrow(&self) -> &CFType

Immutably borrows from an owned value.

impl ConcreteType for CGDisplayStream

fn type_id() -> CFTypeID

Returns the CF “class” ID for CGDisplayStream

Returns: The CFTypeID of the CGDisplayStream class.

impl Debug for CGDisplayStream

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

Formats the value using the given formatter.

impl Deref for CGDisplayStream

type Target = CFType

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for CGDisplayStream

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 CGDisplayStream

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

where Self: Sized,

Increment the reference count of the receiver.

impl PartialEq for CGDisplayStream

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 CGDisplayStream

const ENCODING_REF: Encoding

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

impl Type for CGDisplayStream

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

where Self: Sized,

Increment the reference count of the receiver.

fn as_concrete_TypeRef(&self) -> &Self

👎Deprecated: this is redundant

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_get_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::retain

Helper for easier transition from the core-foundation crate.

fn as_CFTypeRef(&self) -> &CFType

where Self: AsRef<CFType>,

👎Deprecated: this is redundant (CF types deref to CFType)

Helper for easier transition from the core-foundation crate.

unsafe fn wrap_under_create_rule(ptr: *const Self) -> CFRetained<Self>

where Self: Sized,

👎Deprecated: use CFRetained::from_raw

Helper for easier transition from the core-foundation crate.

impl Eq for CGDisplayStream