Struct AVPlayerPlaybackCoordinator 

pub struct AVPlayerPlaybackCoordinator { /* private fields */ }

Available on crate feature AVPlaybackCoordinator only.

An AVPlaybackCoordinator subclass for controlling an AVPlayer

While the coordinator is connected to other participants, it will intercept rate changes and seeks issued to the player to share these with other participants if appropriate. Clients of AVPlayer can thus use the AVPlayer interfaces to modify the playback state of connected participants. When appropriate, the coordinator will also impose rate changes and seeks from other participants on the player. If this occurs, the corresponding notifications will carry an originating participant in their payload. See AVPlayer’s playbackCoordinator property for more details about player behavior changes. AVPlayerPlaybackCoordinator may begin suspensions on behalf of the player when the player’s timeControlStatus changes from AVPlayerTimeControlStatusPlaying to AVPlayerTimeControlStatusWaitingToPlayAtSpecifiedRate or AVPlayerTimeControlStatusPaused. These suspensions will end when the player’s timeControlStatus changes back to AVPlayerTimeControlStatusPlaying. This means that a suspension that begun because the player entered a waiting state, will end automatically when the player is done waiting. A suspension that begun because the player paused, will only end once the player’s rate changes back to non-zero.

See also Apple’s documentation

Implementations

impl AVPlayerPlaybackCoordinator

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

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

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

Available on crate feature AVPlayer only.

The AVPlayer this coordinator is controlling.

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

An object implementing the AVPlaybackCoordinatorDelegate protocol.

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

Setter for delegate.

This is a weak property.

impl AVPlayerPlaybackCoordinator

AVPlaybackCoordinationMediumSupport.

pub unsafe fn coordinateUsingCoordinationMedium_error( &self, coordination_medium: Option<&AVPlaybackCoordinationMedium>, ) -> Result<(), Retained<NSError>>

Available on crate feature AVPlaybackCoordinationMedium only.

Connects the playback coordinator to the coordination medium

This connects the playback coordinator to a coordination medium to enable sending and receiving messages from other connected playback coordinators. If the coordination medium is non-NULL, this will connect the playback coordinator to the specified coordination medium. If the coordination medium is set to NULL, this will disconnect the playback coordinator from the playback coordination medium. The player will no longer be coordinated with the other players connected to the coordination medium. The playback coordinator can either only coordinate with local players through an AVPlaybackCoordinationMedium or coordinate with a remote group session through the coordinateWithSession API. If the client attempts to connect to an AVPlaybackCoordinationMedium while already connected to a group session, this method will populate the outError parameter If the playback coordinator successfully connects to the coordination medium or disconnects from a coordination medium, the outError parameter will be nil. If the playback coordinator fails to connect to the specified coordination medium, the outError parameter will describe what went wrong.

• Parameter coordinationMedium: The coordination medium the playback coordinator connects to. If NULL, the playback coordinator disconnects from any existing coordination medium.
• Parameter outError: A pointer to an NSError object that will be populated with failure information if connecting to or disconnecting from the coordination medium fails.

pub unsafe fn playbackCoordinationMedium( &self, ) -> Option<Retained<AVPlaybackCoordinationMedium>>

Available on crate feature AVPlaybackCoordinationMedium only.

The AVPlaybackCoordinationMedium this playback coordinator is connected to.

This is the AVPlaybackCoordinationMedium the playback coordinator is connected to. If not NULL, the playback coordinator is connected to the specified coordination medium. The playback coordinator is not available to coordinate with a group session. If NULL, the playback coordinator is not connected to any playback coordination medium. The playback coordinator is available to coordinate with a group session through the coordinateWithSession API.

Methods from Deref<Target = AVPlaybackCoordinator>

pub unsafe fn otherParticipants( &self, ) -> Retained<NSArray<AVCoordinatedPlaybackParticipant>>

The playback states of the other participants in the group.

Use this property to create UI informing the local user about the state of other participants in the group.

• NOTE: The coordinator posts AVPlaybackCoordinatorOtherParticipantsDidChangeNotification when the contents of the array changes.

pub unsafe fn suspensionReasons( &self, ) -> Retained<NSArray<AVCoordinatedPlaybackSuspensionReason>>

Describes why the coordinator is currently not able to participate in group playback.

If the list of reasons is non-empty, the coordinator will not react to any changes of group playback state.

pub unsafe fn beginSuspensionForReason( &self, suspension_reason: &AVCoordinatedPlaybackSuspensionReason, ) -> Retained<AVCoordinatedPlaybackSuspension>

Informs the coordinator that its playback object is detached from the group for some reason and should not receive any playback commands from the coordinator.

Use this to tell the coordinator that its player cannot, or should not, participate in coordinated playback temporarily. The coordinator will not respond to playback commands coming from the group and it will also not send any commands to the group. To resume in group playback, end a suspension by calling one of the suspension’s end methods.

• Parameter suspensionReason: Indicates the reason for the suspension that is shared with other participants. Can be a system-defined reason (see AVCoordinatedPlaybackSuspensionReason*) or a custom string.

• NOTE: See the description of AVPlaybackCoordinator subclasses for suspensions automatically begun on behalf of their playback objects, if any.

pub unsafe fn expectedItemTimeAtHostTime( &self, host_clock_time: CMTime, ) -> CMTime

Available on crate feature objc2-core-media only.

Returns the item time (for the current item) that the coordinator expects to be playing at a given host clock time.

This method is useful to decide if it is appropriate to end a suspension, e.g. a suspension with AVCoordinatedPlaybackSuspensionReasonStallRecovery, while other participants are continuing playback.

pub unsafe fn setParticipantLimit_forWaitingOutSuspensionsWithReason( &self, participant_limit: NSInteger, reason: &AVCoordinatedPlaybackSuspensionReason, )

Sets the amount of participants that can join a group before the coordinator stops waiting for this particular suspension reason.

This allows additional configuration for suspension reasons in the suspensionReasonsThatTriggerWaiting array. When the coordinator decides whether one participant’s suspensions should cause others to wait, it will also consider this limit of participants currently in the group.

pub unsafe fn participantLimitForWaitingOutSuspensionsWithReason( &self, reason: &AVCoordinatedPlaybackSuspensionReason, ) -> NSInteger

Returns the maximum number of participants that can be in a group before the coordinator stops waiting out this particular suspensions reason. Default value is NSIntegerMax.

pub unsafe fn suspensionReasonsThatTriggerWaiting( &self, ) -> Retained<NSArray<AVCoordinatedPlaybackSuspensionReason>>

If the coordinator decides to delay playback to wait for others, it will wait out these reasons, but not others.

pub unsafe fn setSuspensionReasonsThatTriggerWaiting( &self, suspension_reasons_that_trigger_waiting: &NSArray<AVCoordinatedPlaybackSuspensionReason>, )

Setter for suspensionReasonsThatTriggerWaiting.

This is copied when set.

pub unsafe fn pauseSnapsToMediaTimeOfOriginator(&self) -> bool

Determines if participants should mirror the originator’s stop time when pausing.

If YES, all participants will seek to the originator’s stop time after they pause. Use this if it is desirable to counteract any network delay incurred by communicating the originator’s pause to the other participants. If NO, it’s acceptable for participants to stop at slightly different offsets and a pause will not cause other participants’ time to jump back.

pub unsafe fn setPauseSnapsToMediaTimeOfOriginator( &self, pause_snaps_to_media_time_of_originator: bool, )

Setter for pauseSnapsToMediaTimeOfOriginator.

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<AVPlaybackCoordinator> for AVPlayerPlaybackCoordinator

fn as_ref(&self) -> &AVPlaybackCoordinator

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

impl AsRef<AVPlayerPlaybackCoordinator> for AVPlayerPlaybackCoordinator

fn as_ref(&self) -> &Self

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

impl AsRef<AnyObject> for AVPlayerPlaybackCoordinator

fn as_ref(&self) -> &AnyObject

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

impl AsRef<NSObject> for AVPlayerPlaybackCoordinator

fn as_ref(&self) -> &NSObject

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

impl Borrow<AVPlaybackCoordinator> for AVPlayerPlaybackCoordinator

fn borrow(&self) -> &AVPlaybackCoordinator

Immutably borrows from an owned value.

impl Borrow<AnyObject> for AVPlayerPlaybackCoordinator

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for AVPlayerPlaybackCoordinator

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for AVPlayerPlaybackCoordinator

const NAME: &'static str = "AVPlayerPlaybackCoordinator"

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

type Super = AVPlaybackCoordinator

The superclass of this class.

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

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

Formats the value using the given formatter.

impl Deref for AVPlayerPlaybackCoordinator

type Target = AVPlaybackCoordinator

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for AVPlayerPlaybackCoordinator

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 AVPlayerPlaybackCoordinator

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for AVPlayerPlaybackCoordinator

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 AVPlayerPlaybackCoordinator

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 AVPlayerPlaybackCoordinator

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

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

impl DowncastTarget for AVPlayerPlaybackCoordinator

impl Eq for AVPlayerPlaybackCoordinator