Struct RPBroadcastSampleHandler

Source

pub struct RPBroadcastSampleHandler { /* private fields */ }

Available on crate feature RPBroadcastExtension only.

Expand description

Subclass this class to handle CMSampleBuffer objects as they are captured by ReplayKit. To enable this mode of handling, set the RPBroadcastProcessMode in the extension’s info.plist to RPBroadcastProcessModeSampleBuffer.

Implementations§

Source §

impl RPBroadcastSampleHandler

Source

pub unsafe fn broadcastStartedWithSetupInfo( &self, setup_info: Option<&NSDictionary<NSString, NSObject>>, )

Method is called when the RPBroadcastController startBroadcast method is called from the broadcasting application.

Parameter setupInfo: Dictionary that can be supplied by the UI extension to the sample handler.

§Safety

setup_info generic should be of the correct type.

Source

pub unsafe fn broadcastPaused(&self)

Method is called when the RPBroadcastController pauseBroadcast method is called from the broadcasting application.

Source

pub unsafe fn broadcastResumed(&self)

Method is called when the RPBroadcastController resumeBroadcast method is called from the broadcasting application.

Source

pub unsafe fn broadcastFinished(&self)

Method is called when the RPBroadcastController finishBroadcast method is called from the broadcasting application.

Source

pub unsafe fn broadcastAnnotatedWithApplicationInfo( &self, application_info: &NSDictionary, )

Method is called when broadcast is started from Control Center and provides extension information about the first application opened or used during the broadcast.

Parameter applicationInfo: Dictionary that contains information about the first application opened or used buring the broadcast.

§Safety

application_info generic should be of the correct type.

Source

pub unsafe fn processSampleBuffer_withType( &self, sample_buffer: &CMSampleBuffer, sample_buffer_type: RPSampleBufferType, )

Available on crate feature objc2-core-media only.

Method is called as video and audio data become available during a broadcast session and is delivered as CMSampleBuffer objects.

Parameter sampleBuffer: CMSampleBuffer object which contains either video or audio data.

Parameter sampleBufferType: Determine’s the type of the sample buffer defined by the RPSampleBufferType enum.

Source

pub unsafe fn finishBroadcastWithError(&self, error: &NSError)

Method that should be called when broadcasting can not proceed due to an error. Calling this method will stop the broadcast and deliver the error back to the broadcasting app through RPBroadcastController’s delegate.

Parameter error: NSError object that will be passed back to the broadcasting app through RPBroadcastControllerDelegate’s broadcastController:didFinishWithError: method.

Source §

impl RPBroadcastSampleHandler

Methods declared on superclass NSObject.

Source

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

Source

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

Methods from Deref<Target = RPBroadcastHandler>§

Source

pub unsafe fn updateServiceInfo( &self, service_info: &NSDictionary<NSString, NSObject>, )

Call this method, supplying it with a dictionary defined by the service, to populate the serviceInfo property on RPBroadcastController. This can be used to communicate viewing stats or messages back to the broadcasting app.

Parameter serviceInfo: Dictionary that can be passed back to the broadcasting app that may contain information about the ongoing broadcast.

§Safety

service_info generic must implement NSCoding.

Source

pub unsafe fn updateBroadcastURL(&self, broadcast_url: &NSURL)

Call this method, supplying it with a URL to update the broadcastURL property on RPBroadcastController.

Parameter broadcastURL: URL of the resource where broadcast can be viewed which will be passed to the broadcasting app.

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