Struct AVSpatialVideoConfiguration

Source

pub struct AVSpatialVideoConfiguration { /* private fields */ }

Available on crate feature AVSpatialVideoConfiguration only.

Expand description

An AVSpatialVideoConfiguration specifies spatial video properties.

Implementations§

Source §

impl AVSpatialVideoConfiguration

Source

pub unsafe fn cameraCalibrationDataLensCollection( &self, ) -> Option<Retained<NSArray<NSDictionary<NSString, AnyObject>>>>

Specifies intrinsic and extrinsic parameters for single or multiple lenses.

The property value is an array of dictionaries describing the camera calibration data for each lens. The camera calibration data includes intrinsics and extrinics with other parameters. This property is only applicable when the projection kind is kCMTagProjectionTypeParametricImmersive. Can be nil if the value is unknown.

Source

pub unsafe fn setCameraCalibrationDataLensCollection( &self, camera_calibration_data_lens_collection: Option<&NSArray<NSDictionary<NSString, AnyObject>>>, )

Setter for cameraCalibrationDataLensCollection.

This is copied when set.

§Safety

camera_calibration_data_lens_collection generic generic should be of the correct type.

Source

pub unsafe fn horizontalFieldOfView(&self) -> Option<Retained<NSNumber>>

Specifies horizontal field of view in thousandths of a degree. Can be nil if the value is unknown.

Source

pub unsafe fn setHorizontalFieldOfView( &self, horizontal_field_of_view: Option<&NSNumber>, )

Setter for horizontalFieldOfView.

This is copied when set.

Source

pub unsafe fn cameraSystemBaseline(&self) -> Option<Retained<NSNumber>>

Specifies the distance between centers of the lenses of the camera system that created the video.

The distance is in micrometers or thousandths of a millimeter. Can be nil if the value is unknown.

Source

pub unsafe fn setCameraSystemBaseline( &self, camera_system_baseline: Option<&NSNumber>, )

Setter for cameraSystemBaseline.

This is copied when set.

Source

pub unsafe fn disparityAdjustment(&self) -> Option<Retained<NSNumber>>

Specifies a relative shift of the left and right images, which changes the zero parallax plane.

The value is in normalized image space and measured over the range of -10000 to 10000 mapping to the uniform range [-1.0…1.0]. The interval of 0.0 to 1.0 or 0 to 10000 maps onto the stereo eye view image width. The negative interval 0.0 to -1.0 or 0 to -10000 similarly map onto the stereo eye view image width. Can be nil if the value is unknown.

Source

pub unsafe fn setDisparityAdjustment( &self, disparity_adjustment: Option<&NSNumber>, )

Setter for disparityAdjustment.

This is copied when set.

Source

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

Source

pub unsafe fn initWithFormatDescription( this: Allocated<Self>, format_description: &CMFormatDescription, ) -> Retained<Self>

Available on crate feature objc2-core-media only.

Initializes an AVSpatialVideoConfiguration with a format description.

The format description is not stored.

Parameter formatDescription: Format description to use to initialize the AVSpatialVideoConfiguration.
Returns: An instance of AVSpatialVideoConfiguration

Source §

impl AVSpatialVideoConfiguration

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