Struct SCVideoStreamAnalyzer 

pub struct SCVideoStreamAnalyzer { /* private fields */ }

Available on crate feature SCVideoStreamAnalyzer only.

Monitors a stream of video by analyzing frames for sensitive content.

Use this class to detect senstive content in a video stream, such as on a conference call that your app implements. The class detects senstive content in the video stream from either the device’s camera or the remote device(s) signed into the call, depending on how you configure the analyzer.

Create an instance of this class for each video stream in the call.

To begin analyzing the stream, pass it to either beginAnalysis(of:)-(AVCaptureDeviceInput) ( <doc ://com.apple.documentation/documentation/avfoundation/avcapturedeviceinput>) or beginAnalysis(of:)-(VTDecompressionSession) ( <doc ://com.apple.documentation/documentation/videotoolbox/vtdecompressionsession>), depending on your video playback implementation.

• Important: This class works only when the Communication Safety parental control in Screen Time is enabled, or when Sensitive Content Warnings is on in Settings. The initializers of this class throw an error if both settings are off.

React to sensitive content

When the framework detects sensitive content in the stream, it calls analysisChangedHandler immediately with an SCSensitivityAnalysis object that includes information about the detection.

You implement the analysisChangedHandler callback to inspect the detection results, which includes confirmation that content is sensitve as well as guidance on next steps your app can take. The framework offers your app suggestions in the handler, which include:

• Alerting the person to the presence of sensitive content (SCSensitivityAnalysis/shouldIndicateSensitivity)
• Interrupting video playback (SCSensitivityAnalysis/shouldInterruptVideo)
• Muting audio (SCSensitivityAnalysis/shouldMuteAudio)

To stop analyzing the stream, call endAnalysis(). If your app implements a custom stream decoder, you can analyze individual frames by passing pixel buffers to analyze(_:).

In the event of an error during analysis, the handler receives an error object that details what went wrong. For more information, see: SCVideoStreamAnalysisChangeHandler.

Add the app entitlement

To use this class, the system requires the <doc ://com.apple.documentation/documentation/bundleresources/entitlements/com.apple.developer.sensitivecontentanalysis.client> entitlement in your app’s code signature. Calls to the framework fail to return positive results without it. You can can add this entitlement to your app by enabling the Sensitive Content Analysis capability in Xcode; see <doc ://com.apple.documentation/documentation/xcode/adding-capabilities-to-your-app>.

For more information, see .

See also Apple’s documentation

Implementations

impl SCVideoStreamAnalyzer

pub unsafe fn analysis(&self) -> Option<Retained<SCSensitivityAnalysis>>

Available on crate feature SCSensitivityAnalysis only.

The results of the first detected sensitive video frame.

The analysis also includes suggestions for the app based on the nature of the sensitive content, specifically: SCSensitivityAnalysis/shouldInterruptVideo, SCSensitivityAnalysis/shouldIndicateSensitivity and SCSensitivityAnalysis/shouldMuteAudio.

pub unsafe fn analysisChangedHandler( &self, ) -> SCVideoStreamAnalysisChangeHandler

Available on crate features SCSensitivityAnalysis and block2 only.

A handler that your app provides to react to sensitive content detection.

The system invokes all analyzer handlers on the same conference call with the updated analysis or error.

Safety

• The returned block’s argument 1 must be a valid pointer or null.
• The returned block’s argument 2 must be a valid pointer or null.

pub unsafe fn setAnalysisChangedHandler( &self, analysis_changed_handler: SCVideoStreamAnalysisChangeHandler, )

Available on crate features SCSensitivityAnalysis and block2 only.

Setter for analysisChangedHandler.

This is [copied][objc2_foundation::NSCopying::copy] when set.

Safety

analysis_changed_handler must be a valid pointer or null.

pub unsafe fn initWithParticipantUUID_streamDirection_error( this: Allocated<Self>, participant_uuid: &NSString, stream_direction: SCVideoStreamAnalyzerStreamDirection, ) -> Result<Retained<Self>, Retained<NSError>>

Creates a video stream analyzer for the given call participant and stream option.

• parameter participantUUID: A unique identifier that you provide to distinguish among multiple individuals on a conference call. Set this argument to the same value per person on the call, if your app supports multiple streams per person.

• parameter streamDirection: An option that indicates whether the stream comes from the device’s camera or from a remote individual signed in to the call.

• parameter error: An error that occurs while intializing a video stream analyzer.

• Important: This class works only when the Communication Safety parental control in Screen Time is enabled, or when Sensitive Content Warnings is on in Settings. This method throws an error if both settings are off, or if the device doesn’t support analysis for the specified stream direction.

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

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

pub unsafe fn analyzePixelBuffer(&self, pixel_buffer: &CVPixelBuffer)

Available on crate feature objc2-core-video only.

Analyzes individual video-stream frames for sensitive content.

This method analyzes a specific video frame and updates analysis according to the results. If your app implements a custom stream decoder, you can call this method for each video frame.

impl SCVideoStreamAnalyzer

Methods declared on superclass NSObject.

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

impl SCVideoStreamAnalyzer

SessionManagement.

pub unsafe fn beginAnalysisOfDecompressionSession_error( &self, decompression_session: &VTDecompressionSession, ) -> Result<(), Retained<NSError>>

Available on crate feature objc2-video-toolbox only.

Analyzes video frames for the given decompression session.

• parameter decompressionSession: An object that provides video frames for your app to analyze for sensitive content.
• parameter error: An error object that describes an issue that occurs while providing the video decompression session.
• returns: YES if the method succeeds; otherwise, NO.

If the framework detects sensitive content in the video stream, the <doc ://com.apple.documentation/documentation/videotoolbox/vtdecompressionsession> produces blank frames to effectively censor the video stream on the person’s behalf. When your app is ready to show the video stream again, resume analysis by calling continueStream.

pub unsafe fn beginAnalysisOfCaptureDeviceInput_error( &self, capture_device_input: &AVCaptureDeviceInput, ) -> Result<(), Retained<NSError>>

Available on crate feature objc2-av-foundation only.

Analyzes video frames for the given capture device input.

• parameter captureDeviceInput: An object that contains information about the specific camera and its captured content in the video stream.
• parameter error: An error object that describes an issue that occurs while processing the capture device input.
• returns: YES if the method succeeds; otherwise, NO.

Call this method to begin analyzing a video stream from the given <doc ://com.apple.documentation/documentation/avfoundation/avcapturedeviceinput>. If the framework detects sensitive content in the video stream, the capture-device-input interrupts subsequent frames with the AVCaptureSessionInterruptionReasonSensitiveContentMitigationActivated interruption reason to effectively censor the video stream on the person’s behalf. When your app is ready to show the video stream again, resume analysis by calling continueStream.

pub unsafe fn endAnalysis(&self)

Stops stream analysis.

This method stops analyzing the video stream in reference to the most recent call to beginAnalysis.

pub unsafe fn continueStream(&self)

Indicates that your app is ready to resume video stream analysis.

When the framework detects sensitive content in the video stream, it pauses analysis and begins censoring the stream’s video frames. Call this method to resume analysis and stop censoring video frames when your app is ready to show the stream again.

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 SCVideoStreamAnalyzer

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for SCVideoStreamAnalyzer

fn as_ref(&self) -> &NSObject

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

impl AsRef<SCVideoStreamAnalyzer> for SCVideoStreamAnalyzer

fn as_ref(&self) -> &Self

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

impl Borrow<AnyObject> for SCVideoStreamAnalyzer

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for SCVideoStreamAnalyzer

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for SCVideoStreamAnalyzer

const NAME: &'static str = "SCVideoStreamAnalyzer"

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

type Super = NSObject

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for SCVideoStreamAnalyzer

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for SCVideoStreamAnalyzer

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 SCVideoStreamAnalyzer

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for SCVideoStreamAnalyzer

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 SCVideoStreamAnalyzer

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 SCVideoStreamAnalyzer

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

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

impl DowncastTarget for SCVideoStreamAnalyzer

impl Eq for SCVideoStreamAnalyzer