Struct RPScreenRecorder

Source

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

Available on crate feature RPScreenRecorder only.

Expand description

Singleton class used to control app recording.

Implementations§

Source §

pub unsafe fn startRecordingWithMicrophoneEnabled_handler( &self, microphone_enabled: bool, handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

👎Deprecated: Use microphoneEnabled property

Available on crate feature block2 only.

Deprecated. Use startRecordingWithHandler: instead.

Starts app recording with a completion handler. Note that before recording actually starts, the user may be prompted with UI to confirm recording.

Parameter microphoneEnabled: Determines whether the microphone input should be included in the recorded movie audio.

handler Called after user interactions are complete. Will be passed an optional NSError in the RPRecordingErrorDomain domain if there was an issue starting the recording.

Source

pub unsafe fn startRecordingWithHandler( &self, handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

Starts app recording with a completion handler. Note that before recording actually starts, the user may be prompted with UI to confirm recording.

handler Called after user interactions are complete. Will be passed an optional NSError in the RPRecordingErrorDomain domain if there was an issue starting the recording.

Source

pub unsafe fn stopRecordingWithHandler( &self, handler: Option<&DynBlock<dyn Fn(mut RPPreviewViewController, mut NSError)>>, )

Available on crate feature RPPreviewViewController and crate feature block2 and crate feature objc2-app-kit and macOS only.

Stops app recording with a completion handler.

handler Called when the movie is ready. Will return an instance of RPPreviewViewController on success which should be presented using [UIViewController presentViewController:animated:completion:]. Will be passed an optional NSError in the RPRecordingErrorDomain domain if there was an issue stopping the recording.

Source

pub unsafe fn stopRecordingWithOutputURL_completionHandler( &self, url: &NSURL, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

Stops app recording with output URL and completion handler.

Parameter url: Output URL for app recording movie.

handler Called when movie is written to specified output URL. Will be passed an optional NSError in the RPRecordingErrorDomain domain if there was an issue stopping the recording and writing the output URL.

Source

pub unsafe fn discardRecordingWithHandler(&self, handler: &DynBlock<dyn Fn()>)

Available on crate feature block2 only.

Discards the current recording. This can only be called after the handler block in stopRecordingWithHandler: is executed.

Source

pub unsafe fn startCaptureWithHandler_completionHandler( &self, capture_handler: Option<&DynBlock<dyn Fn(NonNull<CMSampleBuffer>, RPSampleBufferType, mut NSError)>>, completion_handler: Option<&DynBlock<dyn Fn(mut NSError)>>, )

Available on crate features RPBroadcastExtension and block2 and objc2-core-media only.

Starts screen and audio capture and continually calls the supplied handler with the current sampleBuffer and bufferType and passed it back to the application. Note that before recording actually starts, the user may be prompted with UI to confirm recording.

handler Called continually with sampleBuffers and the bufferType. Will be passed an optional NSError in the RPRecordingErrorDomain domain if there was an issue starting the capture.

Source

pub unsafe fn stopCaptureWithHandler( &self, handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

Stops screen capture with a completion handler

handler Called after the screen capture has stopped. Will be passed an optional NSError in the RPRecordingErrorDomain domain if there was an issue stopping the capture

Source

pub unsafe fn startClipBufferingWithCompletionHandler( &self, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

Start clip recording buffering with a completion handler. Note that before recording actually starts, the user may be prompted with UI to confirm recording.

handler Called after clip recording is started. Will be passed an optional NSError in the RPRecordingErrorDomain domain if there was an issue starting clip record buffering.

Source

pub unsafe fn stopClipBufferingWithCompletionHandler( &self, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

Stop clip recording buffering with a completion handler.

handler Called after clip recording session is stopped. Will be passed an optional NSError in the RPRecordingErrorDomain domain if there was an issue stopping clip record buffering.

Source

pub unsafe fn exportClipToURL_duration_completionHandler( &self, url: &NSURL, duration: NSTimeInterval, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

Exports clip recording

Parameter url: URL containing absolute path for where to save the clip

Parameter duration: Length of time in seconds for clip recording, capped at either the elapsed time, or a maximum of 15 seconds, depending on which is the shorter amount of time

Must be called after startClipBufferingWithCompletionHandler:, otherwise this will return an error. Exports clip recording from newest samples in buffer for duration. handler Will be called after asset is finished writing to output path. Will be passed an optional NSError in the RPRecordingErrorDomain domain if there was an issue generating the clip recording.

Source

pub unsafe fn delegate( &self, ) -> Option<Retained<ProtocolObject<dyn RPScreenRecorderDelegate>>>

Source

pub unsafe fn setDelegate( &self, delegate: Option<&ProtocolObject<dyn RPScreenRecorderDelegate>>, )

This is a weak property. Setter for delegate.

Source

pub unsafe fn isAvailable(&self) -> bool

Source

pub unsafe fn isRecording(&self) -> bool

Source

pub unsafe fn isMicrophoneEnabled(&self) -> bool

Source

pub unsafe fn setMicrophoneEnabled(&self, microphone_enabled: bool)

Setter for isMicrophoneEnabled.

Source

pub unsafe fn isCameraEnabled(&self) -> bool

Source

pub unsafe fn setCameraEnabled(&self, camera_enabled: bool)

Setter for isCameraEnabled.

Source

pub unsafe fn cameraPosition(&self) -> RPCameraPosition

Source

pub unsafe fn setCameraPosition(&self, camera_position: RPCameraPosition)

Setter for cameraPosition.

Source

pub unsafe fn cameraPreviewView( &self, mtm: MainThreadMarker, ) -> Option<Retained<NSView>>

Available on crate feature objc2-app-kit and macOS only.

Source §

impl RPScreenRecorder

Methods declared on superclass NSObject.

Source

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

Methods from Deref<Target = NSObject>§

Source

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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());

Source

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.

Source

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`
    }
}