Struct AVCustomRoutingController

Source

pub struct AVCustomRoutingController { /* private fields */ }

Available on crate feature AVCustomRoutingController only.

Expand description

An object that manages the connection from a device to a destination.

A routing controller also informs its AVCustomRoutingController/delegate object about which routes the user previously authorized, so it can reconnect, if appropriate.

Implementations§

Source §

impl AVCustomRoutingController

Source

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

A delegate object for a routing controller.

Source

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

Setter for delegate.

This is a weak property.

Source

pub unsafe fn authorizedRoutes(&self) -> Retained<NSArray<AVCustomDeviceRoute>>

Available on crate feature AVCustomDeviceRoute only.

A list of authorized routes.

After a user activates a route, it remains authorized for a certain amount of time even if the connection to the route is temporarily unavailable. Your app may reactivate any one of these routes when appropriate, but it needs to inform the system by calling AVCustomRoutingController/setActive:forRoute:.

Source

pub unsafe fn knownRouteIPs( &self, ) -> Retained<NSArray<AVCustomRoutingPartialIP>>

An array of route addresses known to be on the local network.

Source

pub unsafe fn setKnownRouteIPs( &self, known_route_i_ps: &NSArray<AVCustomRoutingPartialIP>, )

Setter for knownRouteIPs.

Source

pub unsafe fn customActionItems( &self, ) -> Retained<NSArray<AVCustomRoutingActionItem>>

Available on crate feature AVCustomRoutingActionItem only.

An array of custom action items to add to a route picker.

Source

pub unsafe fn setCustomActionItems( &self, custom_action_items: &NSArray<AVCustomRoutingActionItem>, )

Available on crate feature AVCustomRoutingActionItem only.

Setter for customActionItems.

Source

pub unsafe fn invalidateAuthorizationForRoute( &self, route: &AVCustomDeviceRoute, )

Available on crate feature AVCustomDeviceRoute only.

Revokes an app’s authorization to connect to a route.

The route only becomes authorized again if the user selects it using the route picker.

Parameters:
route: The route to invalidate authorization for.

Source

pub unsafe fn setActive_forRoute( &self, active: bool, route: &AVCustomDeviceRoute, )

Available on crate feature AVCustomDeviceRoute only.

Sets the active state of a route.

Set the value to <doc ://com.apple.documentation/documentation/objectivec/no> if the connection to the route becomes unavailable, and set it to <doc ://com.apple.documentation/documentation/objectivec/yes> after you reestablish the connection.

Parameters:
active: A Boolean value that indicates whether the route is active.
route: A route to change the active state for.

Source

pub unsafe fn isRouteActive(&self, route: &AVCustomDeviceRoute) -> bool

Available on crate feature AVCustomDeviceRoute only.

Returns a Boolean value that indicates whether a route is active.

Parameters:
route: A route for determining its active state.
Returns: <doc ://com.apple.documentation/documentation/objectivec/yes> if the route is in an active state; otherwise, <doc ://com.apple.documentation/documentation/objectivec/no>.

Source §

impl AVCustomRoutingController

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