objc2_av_foundation/generated/

AVPlaybackCoordinator.rs

//! This file has been automatically generated by `objc2`'s `header-translator`.
//! DO NOT EDIT
use core::ffi::*;
use core::ptr::NonNull;
use objc2::__framework_prelude::*;
#[cfg(feature = "objc2-core-media")]
use objc2_core_media::*;
use objc2_foundation::*;

use crate::*;

/// Describes why an AVCoordinatedPlaybackParticipant is not currently available to participate in coordinated playback.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avcoordinatedplaybacksuspensionreason?language=objc)
// NS_TYPED_EXTENSIBLE_ENUM
pub type AVCoordinatedPlaybackSuspensionReason = NSString;

extern "C" {
    /// The participant's audio session was interrupted.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avcoordinatedplaybacksuspensionreasonaudiosessioninterrupted?language=objc)
    pub static AVCoordinatedPlaybackSuspensionReasonAudioSessionInterrupted:
        &'static AVCoordinatedPlaybackSuspensionReason;
}

extern "C" {
    /// The player is buffering data after a stall.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avcoordinatedplaybacksuspensionreasonstallrecovery?language=objc)
    pub static AVCoordinatedPlaybackSuspensionReasonStallRecovery:
        &'static AVCoordinatedPlaybackSuspensionReason;
}

extern "C" {
    /// The participant is presented with interstitial content instead of the main player.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avcoordinatedplaybacksuspensionreasonplayinginterstitial?language=objc)
    pub static AVCoordinatedPlaybackSuspensionReasonPlayingInterstitial:
        &'static AVCoordinatedPlaybackSuspensionReason;
}

extern "C" {
    /// The participant cannot participate in coordinated playback.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avcoordinatedplaybacksuspensionreasoncoordinatedplaybacknotpossible?language=objc)
    pub static AVCoordinatedPlaybackSuspensionReasonCoordinatedPlaybackNotPossible:
        &'static AVCoordinatedPlaybackSuspensionReason;
}

extern "C" {
    /// The participant's playback object is in a state that requires manual intervention by the user to resume playback.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avcoordinatedplaybacksuspensionreasonuseractionrequired?language=objc)
    pub static AVCoordinatedPlaybackSuspensionReasonUserActionRequired:
        &'static AVCoordinatedPlaybackSuspensionReason;
}

extern "C" {
    /// The participant is actively changing current time.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avcoordinatedplaybacksuspensionreasonuserischangingcurrenttime?language=objc)
    pub static AVCoordinatedPlaybackSuspensionReasonUserIsChangingCurrentTime:
        &'static AVCoordinatedPlaybackSuspensionReason;
}

extern_class!(
    /// A representation of a temporary break in participation.
    ///
    /// Note: See AVPlaybackCoordinator's beginSuspensionForReason: method for details on use.
    ///
    /// Subclasses of this type that are used from Swift must fulfill the requirements of a Sendable type.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avcoordinatedplaybacksuspension?language=objc)
    #[unsafe(super(NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct AVCoordinatedPlaybackSuspension;
);

unsafe impl NSObjectProtocol for AVCoordinatedPlaybackSuspension {}

impl AVCoordinatedPlaybackSuspension {
    extern_methods!(
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;

        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new() -> Retained<Self>;

        /// The reason for the suspension. This will be communicated to other participants while coordination is suspended.
        #[unsafe(method(reason))]
        #[unsafe(method_family = none)]
        pub unsafe fn reason(&self) -> Retained<AVCoordinatedPlaybackSuspensionReason>;

        /// The begin time of the suspension.
        #[unsafe(method(beginDate))]
        #[unsafe(method_family = none)]
        pub unsafe fn beginDate(&self) -> Retained<NSDate>;

        /// Ends the suspension.
        ///
        /// If this is the last suspension, the coordinator will adjust timing of its playback object to match the group.
        /// Also see endProposingNewTime: for a way to end a suspension and simultaneously proposing a new time to the group.
        #[unsafe(method(end))]
        #[unsafe(method_family = none)]
        pub unsafe fn end(&self);

        #[cfg(feature = "objc2-core-media")]
        /// Ends the suspension and proposes a new time that everyone should seek to.
        ///
        /// If this is the last suspension, the coordinator will propose the new time to the group without changing the groups playback rate.
        /// If this is not the last suspension, the time will be ignored.
        /// If the time is not numeric, this will behave like a call to [suspension end].
        #[unsafe(method(endProposingNewTime:))]
        #[unsafe(method_family = none)]
        pub unsafe fn endProposingNewTime(&self, time: CMTime);
    );
}

extern "C" {
    /// Posted by the playback coordinator when its otherParticipants property changes.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avplaybackcoordinatorotherparticipantsdidchangenotification?language=objc)
    pub static AVPlaybackCoordinatorOtherParticipantsDidChangeNotification:
        &'static NSNotificationName;
}

extern "C" {
    /// Posted by the playback coordinator when its suspensionReasons property changes.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avplaybackcoordinatorsuspensionreasonsdidchangenotification?language=objc)
    pub static AVPlaybackCoordinatorSuspensionReasonsDidChangeNotification:
        &'static NSNotificationName;
}

extern_class!(
    /// The playback coordinator negotiates playback state between a player, such as AVPlayer or a custom playback object represented by an implementation of the AVPlaybackCoordinatorPlaybackControlDelegate protocol, and a group of other connected players.
    ///
    /// AVPlaybackCoordinator will match rate and time of all connected players. This means that a local rate change or seek will be reflected in all connected players. Equally, a rate change or seek in any of the connected players will be reflected locally.
    /// AVPlaybackCoordinator does not manage the items in the play queue of the connected players, so it is up to player's owner to share and match the play queue across participants.
    /// The coordinator does, however, keep track of the identity of items enqueued in each player. This means that for one player's current time and rate to be applied on another player, both players must be playing the same item. If two players are playing different items, they each have independent playback states. When one of the two players transitions to the other's item later, it will match the time and rate of that other player.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avplaybackcoordinator?language=objc)
    #[unsafe(super(NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct AVPlaybackCoordinator;
);

unsafe impl NSObjectProtocol for AVPlaybackCoordinator {}

impl AVPlaybackCoordinator {
    extern_methods!(
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;

        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new() -> Retained<Self>;

        /// 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.
        #[unsafe(method(otherParticipants))]
        #[unsafe(method_family = none)]
        pub unsafe fn otherParticipants(
            &self,
        ) -> Retained<NSArray<AVCoordinatedPlaybackParticipant>>;

        /// 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.
        #[unsafe(method(suspensionReasons))]
        #[unsafe(method_family = none)]
        pub unsafe fn suspensionReasons(
            &self,
        ) -> Retained<NSArray<AVCoordinatedPlaybackSuspensionReason>>;

        /// 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.
        ///
        /// Note: See the description of AVPlaybackCoordinator subclasses for suspensions automatically begun on behalf of their playback objects, if any.
        ///
        /// 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.
        #[unsafe(method(beginSuspensionForReason:))]
        #[unsafe(method_family = none)]
        pub unsafe fn beginSuspensionForReason(
            &self,
            suspension_reason: &AVCoordinatedPlaybackSuspensionReason,
        ) -> Retained<AVCoordinatedPlaybackSuspension>;

        #[cfg(feature = "objc2-core-media")]
        /// 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.
        #[unsafe(method(expectedItemTimeAtHostTime:))]
        #[unsafe(method_family = none)]
        pub unsafe fn expectedItemTimeAtHostTime(&self, host_clock_time: CMTime) -> CMTime;
    );
}

extern_class!(
    /// A participant in a coordinated playback group connected through AVPlaybackCoordinator.
    ///
    /// Subclasses of this type that are used from Swift must fulfill the requirements of a Sendable type.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avcoordinatedplaybackparticipant?language=objc)
    #[unsafe(super(NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct AVCoordinatedPlaybackParticipant;
);

unsafe impl Send for AVCoordinatedPlaybackParticipant {}

unsafe impl Sync for AVCoordinatedPlaybackParticipant {}

unsafe impl NSObjectProtocol for AVCoordinatedPlaybackParticipant {}

impl AVCoordinatedPlaybackParticipant {
    extern_methods!(
        /// The reason, if any, this participant is currently not participating in coordinated playback.
        #[unsafe(method(suspensionReasons))]
        #[unsafe(method_family = none)]
        pub unsafe fn suspensionReasons(
            &self,
        ) -> Retained<NSArray<AVCoordinatedPlaybackSuspensionReason>>;

        /// YES if the participant is ready to play.
        #[unsafe(method(isReadyToPlay))]
        #[unsafe(method_family = none)]
        pub unsafe fn isReadyToPlay(&self) -> bool;

        /// A unique id for the participant.
        ///
        /// Use this identifier to distinguish participants.
        #[unsafe(method(identifier))]
        #[unsafe(method_family = none)]
        pub unsafe fn identifier(&self) -> Retained<NSUUID>;
    );
}

/// Methods declared on superclass `NSObject`.
impl AVCoordinatedPlaybackParticipant {
    extern_methods!(
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;

        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new() -> Retained<Self>;
    );
}

/// AVCoordinatedPlaybackPolicies.
/// Policies used by AVPlaybackCoordinator to determine how to interact with the group.
impl AVPlaybackCoordinator {
    extern_methods!(
        /// 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.
        #[unsafe(method(setParticipantLimit:forWaitingOutSuspensionsWithReason:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setParticipantLimit_forWaitingOutSuspensionsWithReason(
            &self,
            participant_limit: NSInteger,
            reason: &AVCoordinatedPlaybackSuspensionReason,
        );

        /// 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.
        #[unsafe(method(participantLimitForWaitingOutSuspensionsWithReason:))]
        #[unsafe(method_family = none)]
        pub unsafe fn participantLimitForWaitingOutSuspensionsWithReason(
            &self,
            reason: &AVCoordinatedPlaybackSuspensionReason,
        ) -> NSInteger;

        /// If the coordinator decides to delay playback to wait for others, it will wait out these reasons, but not others.
        #[unsafe(method(suspensionReasonsThatTriggerWaiting))]
        #[unsafe(method_family = none)]
        pub unsafe fn suspensionReasonsThatTriggerWaiting(
            &self,
        ) -> Retained<NSArray<AVCoordinatedPlaybackSuspensionReason>>;

        /// Setter for [`suspensionReasonsThatTriggerWaiting`][Self::suspensionReasonsThatTriggerWaiting].
        #[unsafe(method(setSuspensionReasonsThatTriggerWaiting:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setSuspensionReasonsThatTriggerWaiting(
            &self,
            suspension_reasons_that_trigger_waiting: &NSArray<
                AVCoordinatedPlaybackSuspensionReason,
            >,
        );

        /// 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.
        #[unsafe(method(pauseSnapsToMediaTimeOfOriginator))]
        #[unsafe(method_family = none)]
        pub unsafe fn pauseSnapsToMediaTimeOfOriginator(&self) -> bool;

        /// Setter for [`pauseSnapsToMediaTimeOfOriginator`][Self::pauseSnapsToMediaTimeOfOriginator].
        #[unsafe(method(setPauseSnapsToMediaTimeOfOriginator:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setPauseSnapsToMediaTimeOfOriginator(
            &self,
            pause_snaps_to_media_time_of_originator: bool,
        );
    );
}

extern_class!(
    /// 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](https://developer.apple.com/documentation/avfoundation/avplayerplaybackcoordinator?language=objc)
    #[unsafe(super(AVPlaybackCoordinator, NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct AVPlayerPlaybackCoordinator;
);

unsafe impl NSObjectProtocol for AVPlayerPlaybackCoordinator {}

impl AVPlayerPlaybackCoordinator {
    extern_methods!(
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;

        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new() -> Retained<Self>;

        #[cfg(feature = "AVPlayer")]
        /// The AVPlayer this coordinator is controlling.
        #[unsafe(method(player))]
        #[unsafe(method_family = none)]
        pub unsafe fn player(&self, mtm: MainThreadMarker) -> Option<Retained<AVPlayer>>;

        /// An object implementing the AVPlaybackCoordinatorDelegate protocol.
        #[unsafe(method(delegate))]
        #[unsafe(method_family = none)]
        pub unsafe fn delegate(
            &self,
        ) -> Option<Retained<ProtocolObject<dyn AVPlayerPlaybackCoordinatorDelegate>>>;

        /// This is a [weak property][objc2::topics::weak_property].
        /// Setter for [`delegate`][Self::delegate].
        #[unsafe(method(setDelegate:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setDelegate(
            &self,
            delegate: Option<&ProtocolObject<dyn AVPlayerPlaybackCoordinatorDelegate>>,
        );
    );
}

extern_protocol!(
    /// Delegate protocol for AVPlayerPlaybackCoordinator.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avplayerplaybackcoordinatordelegate?language=objc)
    pub unsafe trait AVPlayerPlaybackCoordinatorDelegate: NSObjectProtocol {
        #[cfg(feature = "AVPlayerItem")]
        /// Called by the coordinator to identify AVPlayerItems played by the coordinator's AVPlayer.
        ///
        /// Implementing this method allows the coordinator to establish identity of two items created from different URLs, e.g., because one participant is using a local cache and the other a remote URL.
        /// If the method is not implemented, the coordinator will derive the identifier from the item's asset.
        #[optional]
        #[unsafe(method(playbackCoordinator:identifierForPlayerItem:))]
        #[unsafe(method_family = none)]
        unsafe fn playbackCoordinator_identifierForPlayerItem(
            &self,
            coordinator: &AVPlayerPlaybackCoordinator,
            player_item: &AVPlayerItem,
        ) -> Retained<NSString>;

        #[cfg(feature = "AVPlayerItem")]
        /// Called by the coordinator to obtain time ranges in the AVPlayerItem that do not correspond to the primary content.
        ///
        /// Implement this method to provide the coordinator a list of sample accurate time ranges that represent interstitials in the player item.
        /// The coordinator would use this along with the waiting policy for the playingInterstitial suspension to coordinate playback across the group.
        /// If the playingInterstitial suspension is part of AVPlaybackCoordinator.suspensionReasonsThatTriggerWaiting, then the coordinator would wait for other participants to complete the interstitial before proceeding with playback.
        /// And if the playingInterstitial suspension is not a part of AVPlaybackCoordinator.suspensionReasonsThatTriggerWaiting then the coordinator will not wait for the participant playing the interstitial.
        /// Instead, that participant would jump to catch up with the rest of the group when they finish playing the interstitial.
        /// This delegate method is expected to return an array of NSValues with each value containing a CMTimeRange that represents the interstitial.
        /// If the method is not implemented, the coordinator would assume that the entire item corresponds to the primary content.
        #[optional]
        #[unsafe(method(playbackCoordinator:interstitialTimeRangesForPlayerItem:))]
        #[unsafe(method_family = none)]
        unsafe fn playbackCoordinator_interstitialTimeRangesForPlayerItem(
            &self,
            coordinator: &AVPlayerPlaybackCoordinator,
            player_item: &AVPlayerItem,
        ) -> Retained<NSArray<NSValue>>;
    }
);

/// Configuration for a call to [AVDelegatingPlaybackCoordinator coordinateRateChangeToRate:options:].
///
///
/// Requests that the coordinator begin playback as soon as possible and ignore other participant's readiness and suspensions.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avdelegatingplaybackcoordinatorratechangeoptions?language=objc)
// NS_OPTIONS
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct AVDelegatingPlaybackCoordinatorRateChangeOptions(pub NSUInteger);
bitflags::bitflags! {
    impl AVDelegatingPlaybackCoordinatorRateChangeOptions: NSUInteger {
        #[doc(alias = "AVDelegatingPlaybackCoordinatorRateChangeOptionPlayImmediately")]
        const PlayImmediately = 1<<0;
    }
}

unsafe impl Encode for AVDelegatingPlaybackCoordinatorRateChangeOptions {
    const ENCODING: Encoding = NSUInteger::ENCODING;
}

unsafe impl RefEncode for AVDelegatingPlaybackCoordinatorRateChangeOptions {
    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}

/// Configuration for a call to [AVDelegatingPlaybackCoordinator coordinateSeekToTime:options:].
///
///
/// Requests that the coordinator resume playback as soon as possible after the seek is complete and ignore other participant's readiness and suspensions.
///
/// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avdelegatingplaybackcoordinatorseekoptions?language=objc)
// NS_OPTIONS
#[repr(transparent)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
pub struct AVDelegatingPlaybackCoordinatorSeekOptions(pub NSUInteger);
bitflags::bitflags! {
    impl AVDelegatingPlaybackCoordinatorSeekOptions: NSUInteger {
        #[doc(alias = "AVDelegatingPlaybackCoordinatorSeekOptionResumeImmediately")]
        const ResumeImmediately = 1<<0;
    }
}

unsafe impl Encode for AVDelegatingPlaybackCoordinatorSeekOptions {
    const ENCODING: Encoding = NSUInteger::ENCODING;
}

unsafe impl RefEncode for AVDelegatingPlaybackCoordinatorSeekOptions {
    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
}

extern_class!(
    /// An AVPlaybackCoordinator subclass for controlling a custom playback object.
    ///
    /// Note: Use AVPlayer's playbackCoordinator property to get an AVPlaybackCoordinator for an AVPlayer.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avdelegatingplaybackcoordinator?language=objc)
    #[unsafe(super(AVPlaybackCoordinator, NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct AVDelegatingPlaybackCoordinator;
);

unsafe impl NSObjectProtocol for AVDelegatingPlaybackCoordinator {}

impl AVDelegatingPlaybackCoordinator {
    extern_methods!(
        /// Creates an AVPlaybackCoordinator for a custom playback object.
        ///
        /// Use this to create an AVPlaybackCoordinator when playback is not driven by an AVPlayer.
        ///
        /// Parameter `playbackControlDelegate`: An object conforming to the AVPlaybackCoordinatorPlaybackControlDelegate protocol representing a custom playback object.
        /// The coordinator will only hold a weak reference to its delegate.
        ///
        /// Note: See AVPlayer's playbackCoordinator property to get an AVPlaybackCoordinator for an AVPlayer.
        #[unsafe(method(initWithPlaybackControlDelegate:))]
        #[unsafe(method_family = init)]
        pub unsafe fn initWithPlaybackControlDelegate(
            this: Allocated<Self>,
            playback_control_delegate: &ProtocolObject<
                dyn AVPlaybackCoordinatorPlaybackControlDelegate,
            >,
        ) -> Retained<Self>;

        /// The custom player implementation controlled by the coordinator.
        #[unsafe(method(playbackControlDelegate))]
        #[unsafe(method_family = none)]
        pub unsafe fn playbackControlDelegate(
            &self,
        ) -> Option<Retained<ProtocolObject<dyn AVPlaybackCoordinatorPlaybackControlDelegate>>>;

        /// Coordinaties a rate change across the group of connected participants, waiting for other participants to become ready if necessary.
        ///
        /// The coordinator will request a coordinated rate change from all other connected participants.
        /// When changing the rate from zero to non-zero, it may also wait out other participant's suspensions as configured by the suspensionReasonsThatTriggerWaiting property.
        ///
        /// This method should not be called when the rate change should not affect the group, or the group should not have control over local playback temporarily, e.g. a pause because of an audio session interruption.
        /// In those cases, the coordinator should be informed by beginning a suspension with the appropriate reason instead. If other participants pause is dependent on the coordinator's configuration.
        /// The suspension will stop the coordinator from issuing further commands to its playbackControlDelegate. After beginning the suspension, the playback object can be reconfigured as necessary.
        ///
        /// Note: Calling this method while the coordinator is suspended affects only the local playback object. The group state will not be affected, even after the suspension ends.
        ///
        /// Parameter `rate`: The playback rate the group should be using.
        ///
        /// Parameter `options`: Additional configuration of the rate change. For details see AVDelegatingPlaybackCoordinatorRateChangeOptions.
        #[unsafe(method(coordinateRateChangeToRate:options:))]
        #[unsafe(method_family = none)]
        pub unsafe fn coordinateRateChangeToRate_options(
            &self,
            rate: c_float,
            options: AVDelegatingPlaybackCoordinatorRateChangeOptions,
        );

        #[cfg(feature = "objc2-core-media")]
        /// Triggers a seek to the requested time for all connected participants.
        ///
        /// For behavior around resuming playback after the seek is complete and suspensions, see the discussion of coordinateRateChangeToRate:options.
        ///
        /// Note: Calling this method while the coordinator is suspended affects only the local playback object. The group state will not be affected, even after the suspension ends.
        /// To end a suspension and also affect the group timing see -[AVCoordinatedPlaybackSuspension endProposingNewTime:]
        ///
        /// Parameter `time`: The time the group should seek to when the command ends.
        ///
        /// Parameter `options`: Additional configuration of the seek. For details see AVDelegatingPlaybackCoordinatorSeekOptions.
        #[unsafe(method(coordinateSeekToTime:options:))]
        #[unsafe(method_family = none)]
        pub unsafe fn coordinateSeekToTime_options(
            &self,
            time: CMTime,
            options: AVDelegatingPlaybackCoordinatorSeekOptions,
        );

        #[cfg(feature = "objc2-core-media")]
        /// Informs the coordinator to transition to a new current item.
        ///
        /// The coordinator will stop sending commands for any previous item identifier and begin sending commands for the new identifier.
        /// The proposed timing will either be used as the new referece timing for the group, or it will be compared to an already existing reference timing.
        /// If the proposed timing doesn't match such an existing reference timing, the coordinator will use the playbackControlDelegate to issue appropriate commands to match up the timing.
        ///
        /// Note: This is not a way to affect the play queue of other participants. All other participants must do this independently, e.g. as a side-effect of an automatic item transition or an out-of-band communication requesting a similar item change.
        ///
        /// Parameter `itemIdentifier`: The identifier for the new current item. May be nil if nothing is playing.
        ///
        /// Parameter `snapshotTimebase`: A timebase used to communicate the initial playback state of the new item. If NULL, the coordinator will assume that playback is paused at kCMTimeZero.
        /// An appropriate timebase to pass to the completion handler may be retreived from AVFoundation playback objects such as AVSampleBufferRenderSynchronizer.
        /// It can also be created manually using CMTimebaseCreateWithSourceClock. The timebase will only be used to take a snapshot of its immediate timing. It will not be observed further.
        #[unsafe(method(transitionToItemWithIdentifier:proposingInitialTimingBasedOnTimebase:))]
        #[unsafe(method_family = none)]
        pub unsafe fn transitionToItemWithIdentifier_proposingInitialTimingBasedOnTimebase(
            &self,
            item_identifier: Option<&NSString>,
            snapshot_timebase: Option<&CMTimebase>,
        );

        /// The item identifier of the current item. Previously set by a call to transitionToItemWithIdentifier:proposingInitialTimingBasedOnTimebase:
        #[unsafe(method(currentItemIdentifier))]
        #[unsafe(method_family = none)]
        pub unsafe fn currentItemIdentifier(&self) -> Option<Retained<NSString>>;

        /// Instructs the coordinator to re-issue commands to synchronize the current item back to the state of the other participants.
        ///
        /// Use this method when the playback object is in a state that doesn't match the group for some reason and should be re-synchronized.
        #[unsafe(method(reapplyCurrentItemStateToPlaybackControlDelegate))]
        #[unsafe(method_family = none)]
        pub unsafe fn reapplyCurrentItemStateToPlaybackControlDelegate(&self);
    );
}

/// Methods declared on superclass `AVPlaybackCoordinator`.
impl AVDelegatingPlaybackCoordinator {
    extern_methods!(
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;

        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new() -> Retained<Self>;
    );
}

extern_protocol!(
    /// A custom player implementation
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avplaybackcoordinatorplaybackcontroldelegate?language=objc)
    pub unsafe trait AVPlaybackCoordinatorPlaybackControlDelegate: NSObjectProtocol {
        #[cfg(feature = "block2")]
        /// Called by the coordinator to match the playback rate of the control delegate to the group, when the target rate is non-zero.
        ///
        /// The coordinator issues this command when the desired playback timeline has changed. This may mean that the rate has changed, but it can also mean that the anchor time has changed.
        /// Play commands are only issued when the desired playback rate is non-zero.
        ///
        /// Parameter `coordinator`: The coordinator requesting a change in playback rate.
        ///
        /// Parameter `playCommand`: A play command object. See AVDelegatingPlaybackCoordinatorPlayCommand.
        /// The receiver should verify that the command is still valid by inspecting the expectedCurrentItemIdentifier property before applying the command.
        ///
        /// Parameter `completionHandler`: The receiver must call the completion handler when done, either when the command has been handled succesfully or when the receiver has indicated its inability
        /// to handle the command by beginning a suspension with an appropriate reason.
        #[unsafe(method(playbackCoordinator:didIssuePlayCommand:completionHandler:))]
        #[unsafe(method_family = none)]
        unsafe fn playbackCoordinator_didIssuePlayCommand_completionHandler(
            &self,
            coordinator: &AVDelegatingPlaybackCoordinator,
            play_command: &AVDelegatingPlaybackCoordinatorPlayCommand,
            completion_handler: &block2::Block<dyn Fn()>,
        );

        #[cfg(feature = "block2")]
        /// Called by the coordinator to pause playback.
        ///
        /// Parameter `coordinator`: The coordinator requesting playback to pause.
        ///
        /// Parameter `pauseCommand`: A pause command object. See AVDelegatingPlaybackCoordinatorPauseCommand.
        /// The receiver should verify that the command is still valid by inspecting the expectedCurrentItemIdentifier property before applying the command.
        ///
        /// Parameter `completionHandler`: The receiver must call the completion handler when done, either when the command has been handled succesfully or when the receiver has indicated its inability
        /// to handle the command by beginning a suspension with an appropriate reason.
        /// If the command's shouldBufferInAnticipationOfPlayback is YES, the completion handler should also only be called once the playback object is ready to receive a subsequent play command.
        #[unsafe(method(playbackCoordinator:didIssuePauseCommand:completionHandler:))]
        #[unsafe(method_family = none)]
        unsafe fn playbackCoordinator_didIssuePauseCommand_completionHandler(
            &self,
            coordinator: &AVDelegatingPlaybackCoordinator,
            pause_command: &AVDelegatingPlaybackCoordinatorPauseCommand,
            completion_handler: &block2::Block<dyn Fn()>,
        );

        #[cfg(feature = "block2")]
        /// Called by the coordinator to seek to a new time.
        ///
        /// The coordinator issues this command when the playback object current time changes, potentially also pausing playback.
        ///
        /// Parameter `coordinator`: The coordinator requesting the seek.
        ///
        /// Parameter `seekCommand`: A seek command object. See AVDelegatingPlaybackCoordinatorSeekCommand.
        /// The receiver should verify that the command is still valid by inspecting the expectedCurrentItemIdentifier property before applying the command.
        ///
        /// Parameter `completionHandler`: The receiver must call the completion handler when done, either when the command has been handled succesfully or when the receiver has indicated its inability
        /// to handle the command by beginning a suspension with an appropriate reason.
        /// If the command's shouldBufferInAnticipationOfPlayback is YES, the completion handler should also only be called once the playback object is ready to receive a subsequent play command.
        #[unsafe(method(playbackCoordinator:didIssueSeekCommand:completionHandler:))]
        #[unsafe(method_family = none)]
        unsafe fn playbackCoordinator_didIssueSeekCommand_completionHandler(
            &self,
            coordinator: &AVDelegatingPlaybackCoordinator,
            seek_command: &AVDelegatingPlaybackCoordinatorSeekCommand,
            completion_handler: &block2::Block<dyn Fn()>,
        );

        #[cfg(feature = "block2")]
        /// Called by the coordinator to indicate that playback is expected to begin soon and the playback object should begin buffering.
        ///
        /// The coordinator issues this command when playback is currently paused and the coordinator is expecting playback to start soon.
        /// In response to this command, it is appropriate to update playback UI to indicate playback in a waiting state.
        /// The expected start can be cancelled by calling -[AVDelegatingPlaybackCoordinator coordinateRateChangeTo:0].
        ///
        /// Parameter `coordinator`: The coordinator requesting buffering to begin.
        ///
        /// Parameter `bufferingCommand`: A buffering command object. See AVDelegatingPlaybackCoordinatorBufferingCommand.
        /// The receiver should verify that the command is still valid by inspecting the expectedCurrentItemIdentifier property before applying the command.
        ///
        /// Parameter `completionHandler`: The receiver must call the completion handler when done, either when the command has been handled succesfully or when the receiver has indicated its inability
        /// to handle the command by beginning a suspension with an appropriate reason.
        /// For buffering commands, the command should only be considered complete once the playback object is ready to receive a subsequent play command.
        #[unsafe(method(playbackCoordinator:didIssueBufferingCommand:completionHandler:))]
        #[unsafe(method_family = none)]
        unsafe fn playbackCoordinator_didIssueBufferingCommand_completionHandler(
            &self,
            coordinator: &AVDelegatingPlaybackCoordinator,
            buffering_command: &AVDelegatingPlaybackCoordinatorBufferingCommand,
            completion_handler: &block2::Block<dyn Fn()>,
        );
    }
);

extern_class!(
    /// Abstract superclass for playback commands
    ///
    /// Subclasses of this type that are used from Swift must fulfill the requirements of a Sendable type.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avdelegatingplaybackcoordinatorplaybackcontrolcommand?language=objc)
    #[unsafe(super(NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct AVDelegatingPlaybackCoordinatorPlaybackControlCommand;
);

unsafe impl Send for AVDelegatingPlaybackCoordinatorPlaybackControlCommand {}

unsafe impl Sync for AVDelegatingPlaybackCoordinatorPlaybackControlCommand {}

unsafe impl NSObjectProtocol for AVDelegatingPlaybackCoordinatorPlaybackControlCommand {}

impl AVDelegatingPlaybackCoordinatorPlaybackControlCommand {
    extern_methods!(
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;

        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new() -> Retained<Self>;

        /// The participant causing this command to be issued.
        ///
        /// Only commands issued on behalf of another participant will contain an originator.
        /// Commands caused by local requests, e.g., requests to coordinate a rate change, will not contain an originator.
        /// Similarly, re-application of older commands, e.g., in response to a call to [AVDelegatingPlaybackCoordinator reapplyCurrentItemStateToPlaybackControlDelegate], will not contain an originator.
        /// If the originator is non-nil, it may be appropriate to show UI indicating someone else's action.
        #[unsafe(method(originator))]
        #[unsafe(method_family = none)]
        pub unsafe fn originator(&self) -> Option<Retained<AVCoordinatedPlaybackParticipant>>;

        /// Indicates the item this command was issued for.
        ///
        /// Commands are always meant for the current item. A command handler should verify that the identifier of its current item matches this identifier.
        /// If it doesn't this command is obsolete and should be ignored. Note that any completion handler of the delegate method issuing the command must still be invoked.
        #[unsafe(method(expectedCurrentItemIdentifier))]
        #[unsafe(method_family = none)]
        pub unsafe fn expectedCurrentItemIdentifier(&self) -> Retained<NSString>;
    );
}

extern_class!(
    /// A playback command requesting playback with specific timing.
    ///
    /// Subclasses of this type that are used from Swift must fulfill the requirements of a Sendable type.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avdelegatingplaybackcoordinatorplaycommand?language=objc)
    #[unsafe(super(AVDelegatingPlaybackCoordinatorPlaybackControlCommand, NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct AVDelegatingPlaybackCoordinatorPlayCommand;
);

unsafe impl Send for AVDelegatingPlaybackCoordinatorPlayCommand {}

unsafe impl Sync for AVDelegatingPlaybackCoordinatorPlayCommand {}

unsafe impl NSObjectProtocol for AVDelegatingPlaybackCoordinatorPlayCommand {}

impl AVDelegatingPlaybackCoordinatorPlayCommand {
    extern_methods!(
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;

        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new() -> Retained<Self>;

        /// Playback rate. Will always be non-zero.
        #[unsafe(method(rate))]
        #[unsafe(method_family = none)]
        pub unsafe fn rate(&self) -> c_float;

        #[cfg(feature = "objc2-core-media")]
        /// The itemTime that playback should begin at.
        ///
        /// The receiver of this command should verify that data is loaded for the requested time and potentially begin loading it before beginning playback.
        /// It is not important to load data for time exactly. If data "similar" to time is already loaded, it is acceptable to start playback with the loaded data. Playback should still start with the requested timing.
        /// Should the receiver be unable to start with the exact requested timing, playback will be out of sync with the group.
        /// If data for the requested time cannot be loaded, or playback stalls later, the command handler may want to indicate this to the coordinator by beginning a suspension with AVCoordinatedPlaybackSuspensionReasonStallRecovery.
        #[unsafe(method(itemTime))]
        #[unsafe(method_family = none)]
        pub unsafe fn itemTime(&self) -> CMTime;

        #[cfg(feature = "objc2-core-media")]
        /// This is the host clock time (see CMClockGetHostTimeClock()) defining when playback should start (or should have started) at the given itemTime.
        #[unsafe(method(hostClockTime))]
        #[unsafe(method_family = none)]
        pub unsafe fn hostClockTime(&self) -> CMTime;
    );
}

extern_class!(
    /// A playback command requesting buffering in anticipation of playback.
    ///
    /// Receiving this command should be reflected to the user as playback in a buffering state.
    /// To cancel the group intent to begin playback and move back into a paused state, call [AVDelegatingPlaybackCoordinator coordinateRateChangeToRate:0 options: 0]
    ///
    /// Subclasses of this type that are used from Swift must fulfill the requirements of a Sendable type.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avdelegatingplaybackcoordinatorbufferingcommand?language=objc)
    #[unsafe(super(AVDelegatingPlaybackCoordinatorPlaybackControlCommand, NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct AVDelegatingPlaybackCoordinatorBufferingCommand;
);

unsafe impl Send for AVDelegatingPlaybackCoordinatorBufferingCommand {}

unsafe impl Sync for AVDelegatingPlaybackCoordinatorBufferingCommand {}

unsafe impl NSObjectProtocol for AVDelegatingPlaybackCoordinatorBufferingCommand {}

impl AVDelegatingPlaybackCoordinatorBufferingCommand {
    extern_methods!(
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;

        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new() -> Retained<Self>;

        /// The rate to prepare playback for.
        ///
        /// The command should only be considered complete once the player is ready to receive an AVDelegatingPlaybackCoordinatorPlayCommand with the indicated rate.
        #[unsafe(method(anticipatedPlaybackRate))]
        #[unsafe(method_family = none)]
        pub unsafe fn anticipatedPlaybackRate(&self) -> c_float;

        /// Communicates when the coordinator expects the command's completion handler at the latest.
        ///
        /// A receiver of a buffering command should fire the completion handler by this date at the latest. This is useful in buffering situations where the receiver
        /// has not yet buffered enough data to be considered ready to play by the due date. The receiver should then decide to either complete the command as is
        /// to try and keep up with the group, or alternatively begin a stall recovery suspension to communicate the situation to the other participants.
        /// Completing the command after this date means that the coordinator will likely send a play command for a later time than the receiver buffered for.
        #[unsafe(method(completionDueDate))]
        #[unsafe(method_family = none)]
        pub unsafe fn completionDueDate(&self) -> Option<Retained<NSDate>>;
    );
}

extern_class!(
    /// A playback command requesting a pause
    ///
    /// Subclasses of this type that are used from Swift must fulfill the requirements of a Sendable type.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avdelegatingplaybackcoordinatorpausecommand?language=objc)
    #[unsafe(super(AVDelegatingPlaybackCoordinatorPlaybackControlCommand, NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct AVDelegatingPlaybackCoordinatorPauseCommand;
);

unsafe impl Send for AVDelegatingPlaybackCoordinatorPauseCommand {}

unsafe impl Sync for AVDelegatingPlaybackCoordinatorPauseCommand {}

unsafe impl NSObjectProtocol for AVDelegatingPlaybackCoordinatorPauseCommand {}

impl AVDelegatingPlaybackCoordinatorPauseCommand {
    extern_methods!(
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;

        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new() -> Retained<Self>;

        /// Indicates that playback is anticipated and the player should begin buffering if necessary.
        ///
        /// When shouldBufferInAnticipationOfPlayback is YES, some participant wants to resume playback at the rate indicated by the anticipatedPlaybackRate property.
        /// This should be treated similar to receiving a separate AVDelegatingPlaybackCoordinatorBufferingCommand.
        /// If YES, the command should only be considered complete once the player is ready to receive an AVDelegatingPlaybackCoordinatorPlayCommand with the indicated rate.
        #[unsafe(method(shouldBufferInAnticipationOfPlayback))]
        #[unsafe(method_family = none)]
        pub unsafe fn shouldBufferInAnticipationOfPlayback(&self) -> bool;

        /// The rate to prepare for if shouldBufferInAnticipationOfPlayback is YES.
        #[unsafe(method(anticipatedPlaybackRate))]
        #[unsafe(method_family = none)]
        pub unsafe fn anticipatedPlaybackRate(&self) -> c_float;
    );
}

extern_class!(
    /// A playback command requesting a seek.
    ///
    /// If the current playback rate is non-zero, playback should not automatically resume after the seek. Instead the delegate should pause and wait for the coordinator to issue another PlayCommand.
    ///
    /// Subclasses of this type that are used from Swift must fulfill the requirements of a Sendable type.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avdelegatingplaybackcoordinatorseekcommand?language=objc)
    #[unsafe(super(AVDelegatingPlaybackCoordinatorPlaybackControlCommand, NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct AVDelegatingPlaybackCoordinatorSeekCommand;
);

unsafe impl Send for AVDelegatingPlaybackCoordinatorSeekCommand {}

unsafe impl Sync for AVDelegatingPlaybackCoordinatorSeekCommand {}

unsafe impl NSObjectProtocol for AVDelegatingPlaybackCoordinatorSeekCommand {}

impl AVDelegatingPlaybackCoordinatorSeekCommand {
    extern_methods!(
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;

        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new() -> Retained<Self>;

        #[cfg(feature = "objc2-core-media")]
        /// The time to seek the currentItem to.
        ///
        /// Playback should never automatically resume after seeking to this time. The coordinator will issue a new PlayCommand when everyone else is ready to resume.
        #[unsafe(method(itemTime))]
        #[unsafe(method_family = none)]
        pub unsafe fn itemTime(&self) -> CMTime;

        /// Indicates that playback is anticipated and the player should begin buffering if necessary.
        ///
        /// When shouldBufferInAnticipationOfPlayback, playback is expected to eventually resume at the rate indicated by the anticipatedPlaybackRate property.
        /// This should be treated similar to receiving a separate AVDelegatingPlaybackCoordinatorBufferingCommand.
        /// If YES, the command should only be considered complete once the player is ready to receive an AVDelegatingPlaybackCoordinatorPlayCommand with the indicated rate.
        #[unsafe(method(shouldBufferInAnticipationOfPlayback))]
        #[unsafe(method_family = none)]
        pub unsafe fn shouldBufferInAnticipationOfPlayback(&self) -> bool;

        /// The rate to prepare for if shouldBufferInAnticipationOfPlayback is YES.
        #[unsafe(method(anticipatedPlaybackRate))]
        #[unsafe(method_family = none)]
        pub unsafe fn anticipatedPlaybackRate(&self) -> c_float;

        /// Communicates when the coordinator expects the command's completion handler at the latest.
        ///
        /// A seek command expecting buffering in anticipation of playback does expect the receiver to fire the completion handler by this date at the latest.
        /// This is useful in buffering situations where the receiver has not yet buffered enough data to be considered ready to play by the due date.
        /// The receiver should then decide to either complete the command as is to try and keep up with the group, or alternatively begin a stall recovery
        /// suspension to communicate the situation to the other participants.
        /// Completing the command after this date means that the coordinator will likely send a play command for a later time than the receiver buffered for.
        #[unsafe(method(completionDueDate))]
        #[unsafe(method_family = none)]
        pub unsafe fn completionDueDate(&self) -> Option<Retained<NSDate>>;
    );
}