objc2_av_foundation/generated/

AVSampleBufferRenderSynchronizer.rs

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

use crate::*;

extern "C" {
    /// A notification that fires whenever the value of the "rate" property changes.
    ///
    /// The rate can change as a result of setting the rate property, either by directly setting the property or calling -setRate:time:. The rate can also change at any time, without any action by the client of the render synchronizer. For example, on iOS if the app's playback is interrupted (e.g. by a phone call or another non-mixable app starting playback), the rate will automatically be set to zero. This notification will be sent in all of those cases.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avsamplebufferrendersynchronizerratedidchangenotification?language=objc)
    pub static AVSampleBufferRenderSynchronizerRateDidChangeNotification:
        &'static NSNotificationName;
}

extern_class!(
    /// AVSampleBufferRenderSynchronizer can synchronize multiple objects conforming to AVQueuedSampleBufferRendering to a single timebase.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/avfoundation/avsamplebufferrendersynchronizer?language=objc)
    #[unsafe(super(NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    pub struct AVSampleBufferRenderSynchronizer;
);

extern_conformance!(
    unsafe impl NSObjectProtocol for AVSampleBufferRenderSynchronizer {}
);

impl AVSampleBufferRenderSynchronizer {
    extern_methods!(
        #[cfg(feature = "objc2-core-media")]
        /// The synchronizer's rendering timebase, which governs how time stamps are interpreted.
        ///
        /// By default, this timebase will be driven by the clock of an added AVSampleBufferAudioRenderer.
        ///
        /// If no AVSampleBufferAudioRenderer has been added, the source clock will be the host time clock (mach_absolute_time with the appropriate timescale conversion; this is the same as Core Animation's CACurrentMediaTime).
        ///
        /// The timebase is a read-only timebase. Use the rate property and corresponding methods to adjust the timebase.
        #[unsafe(method(timebase))]
        #[unsafe(method_family = none)]
        pub unsafe fn timebase(&self) -> Retained<CMTimebase>;

        /// Playback rate.
        ///
        /// Indicates the current rate of rendering. A value of 0.0 means "stopped"; a value of 1.0 means "play at the natural rate of the media". Must be greater than or equal to 0.0.
        #[unsafe(method(rate))]
        #[unsafe(method_family = none)]
        pub unsafe fn rate(&self) -> c_float;

        /// Setter for [`rate`][Self::rate].
        #[unsafe(method(setRate:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setRate(&self, rate: c_float);

        #[cfg(feature = "objc2-core-media")]
        /// Returns the current time of the synchronizer.
        ///
        /// Returns the current time of the synchronizer. Not key-value observable; use -addPeriodicTimeObserverForInterval:queue:usingBlock: instead.
        ///
        /// - Returns: A CMTime
        #[unsafe(method(currentTime))]
        #[unsafe(method_family = none)]
        pub unsafe fn currentTime(&self) -> CMTime;

        #[cfg(feature = "objc2-core-media")]
        /// Sets the timebase's time and rate.
        ///
        /// Sets the timebase's time to time and then sets the rendering rate to rate. A rate value of 0.0 means "stopped"; a rate value of 1.0 means "play at the natural rate of the media". Use kCMTimeInvalid for time to not modify the timebase's time.
        /// Note that this method updates the rate property synchronously, but the timebase is updated asynchronously.
        ///
        /// - Parameter rate: A new timebase rate to set. Must be greater than or equal to 0.0
        /// - Parameter time: A new time to set. Must be greater than or equal to kCMTimeZero, or kCMTimeInvalid
        #[unsafe(method(setRate:time:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setRate_time(&self, rate: c_float, time: CMTime);

        #[cfg(feature = "objc2-core-media")]
        /// Simultaneously sets the playback rate and the relationship between the current time and host time.
        ///
        /// You can use this function to synchronize playback with an external activity.
        ///
        /// The timebase is adjusted so that its time will be (or was) time when host time is (or was) hostTime.
        /// In other words: if hostTime is in the past, the timebase's time will be interpolated as though the timebase has been running at the requested rate since that time. If hostTime is in the future, the timebase will immediately start running at the requested rate from an earlier time so that it will reach the requested time at the requested hostTime.
        /// It is a responsibility of the client to ensure that proper time and hostTime is set. This method will not attempt to validate improper time, hostTime values.
        /// In addition, it is also the caller’s responsibility to enqueue samples in the connected renderers that match the timeline defined here.
        /// Note that any buffers that are in the past of the defined timeline will still be processed by the renderers.
        ///
        /// The recommended approach is to use the output presentation time of the first buffer enqueued in the renderers as time and and an associated hostTime in the future.
        /// Example use:
        /// ```objc
        /// CMTime startTime = …;
        /// __block CMTime nextBufferTime = startTime;
        /// [renderer requestMediaDataWhenReadyOnQueue:queue usingBlock:^{
        /// …
        /// CMSampleBufferRef sampleBuffer = [self generateSampleBufferFor: nextBufferTime];
        /// [renderer enqueueSampleBuffer:sampleBuffer];
        /// ...
        /// }];
        /// CMTime inOneSecond = CMTimeAdd(CMClockGetTime(CMClockGetHostTimeClock()), CMTimeMake(1, 1));
        /// [synchronizer setRate:rate time:startTime atHostTime:inOneSecond];
        /// ```
        /// Also note that this method updates the rate property synchronously, but the timebase is updated asynchronously.
        ///
        /// - Parameter rate: A new timebase rate to set. Must be greater than or equal to 0.0
        /// - Parameter time: A new timebase time to set. Must be greater than or equal to kCMTimeZero, or kCMTimeInvalid
        /// - Parameter hostTime: A new hostTime to set. Must be greater than or equal to kCMTimeZero, or kCMTimeInvalid
        #[unsafe(method(setRate:time:atHostTime:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setRate_time_atHostTime(
            &self,
            rate: c_float,
            time: CMTime,
            host_time: CMTime,
        );

        /// Indicates whether the playback should be started immediately on rate change request.
        ///
        /// If set to YES, playback will be delayed if the value of hasSufficientMediaDataForReliablePlaybackStart of any added renderer is NO. If set to NO, playback will attempt to start immediately regardless of the value of hasSufficientMediaDataForReliablePlaybackStart of added renderers. Default is YES.
        #[unsafe(method(delaysRateChangeUntilHasSufficientMediaData))]
        #[unsafe(method_family = none)]
        pub unsafe fn delaysRateChangeUntilHasSufficientMediaData(&self) -> bool;

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

/// Methods declared on superclass `NSObject`.
impl AVSampleBufferRenderSynchronizer {
    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>;
    );
}

/// AVSampleBufferRenderSynchronizerRendererManagement.
impl AVSampleBufferRenderSynchronizer {
    extern_methods!(
        #[cfg(feature = "AVQueuedSampleBufferRendering")]
        /// Array of id
        /// <AVQueuedSampleBufferRendering
        /// > currently attached to the synchronizer.
        ///
        /// A list of renderers added to and not removed from the synchronizer. The list also includes renderers that have been scheduled to be removed but have not yet been removed.
        ///
        /// This property is not KVO observable.
        #[unsafe(method(renderers))]
        #[unsafe(method_family = none)]
        pub unsafe fn renderers(
            &self,
        ) -> Retained<NSArray<ProtocolObject<dyn AVQueuedSampleBufferRendering>>>;

        #[cfg(feature = "AVQueuedSampleBufferRendering")]
        /// Adds a renderer to the list of renderers under the synchronizer's control.
        ///
        /// Adds a renderer to begin operating with the synchronizer's timebase.
        ///
        /// This method can be called while rate is non-0.0.
        ///
        /// - Parameter renderer: An object conforming to AVQueuedSampleBufferRendering to be synchronized by this synchronizer.
        #[unsafe(method(addRenderer:))]
        #[unsafe(method_family = none)]
        pub unsafe fn addRenderer(
            &self,
            renderer: &ProtocolObject<dyn AVQueuedSampleBufferRendering>,
        );

        #[cfg(all(
            feature = "AVQueuedSampleBufferRendering",
            feature = "block2",
            feature = "objc2-core-media"
        ))]
        /// Removes a renderer from the list of renderers under the synchronizer's control.
        ///
        /// This method can be called while rate is non-0.0.
        ///
        /// time is used to schedule future removals. If the time is in the past, the renderer will be removed immediately. kCMTimeInvalid can also be used to force immediate removal.
        ///
        /// This method removes the renderer asynchronously. The method can be called more than once, with a subsequent scheduled removal replacing a previously scheduled removal.
        ///
        /// Clients may provide an optional completionHandler block to be notified when the scheduled removal completes. If provided, completionHandler will always be called with the following values for didRemoveRenderer:
        ///
        /// - If the renderer has not been added to this synchronizer, completionHandler will be called and didRemoveRenderer will be NO.
        /// - If a removal of a particular renderer is scheduled after another removal of that same renderer has already been scheduled but not yet occurred, the previously-scheduled removal's completionHandler will be called and didRemoveRenderer will be NO. The new scheduled removal's completionHandler will not be called until it is replaced by another scheduled removal or the renderer is actually removed.
        /// - When the renderer is removed due to a scheduled removal, the completionHandler provided when that removal was scheduled will be called and didRemoveRenderer will be YES.
        ///
        /// - Parameter renderer: An object conforming to AVQueuedSampleBufferRendering currently synchronized by this synchronizer to no longer be synchronized by the synchronizer.
        /// - Parameter time: The time on the timebase's timeline at which the renderer should be removed.
        /// - Parameter completionHandler: Optional. A block called when the renderer is removed from the synchronizer. If provided, this block will always be called with didRemoveRenderer indicating whether the renderer was removed by this scheduled removal.
        ///
        /// # Safety
        ///
        /// `completion_handler` block must be sendable.
        #[unsafe(method(removeRenderer:atTime:completionHandler:))]
        #[unsafe(method_family = none)]
        pub unsafe fn removeRenderer_atTime_completionHandler(
            &self,
            renderer: &ProtocolObject<dyn AVQueuedSampleBufferRendering>,
            time: CMTime,
            completion_handler: Option<&block2::DynBlock<dyn Fn(Bool)>>,
        );
    );
}

/// AVSampleBufferRenderSynchronizerTimeObservation.
impl AVSampleBufferRenderSynchronizer {
    extern_methods!(
        #[cfg(all(
            feature = "block2",
            feature = "dispatch2",
            feature = "objc2-core-media"
        ))]
        /// Requests invocation of a block during rendering to report changing time.
        ///
        /// The block is invoked periodically at the interval specified, interpreted according to the timeline of the timebase. The block is also invoked whenever time jumps and whenever rendering starts or stops.
        ///
        /// If the interval corresponds to a very short interval in real time, the synchronizer may invoke the block less frequently than requested. Even so, the synchronizer will invoke the block sufficiently often for the client to update indications of the current time appropriately in its end-user interface.
        ///
        /// Each call to -addPeriodicTimeObserverForInterval:queue:usingBlock: should be paired with a corresponding call to -removeTimeObserver:. Releasing the observer object without a call to -removeTimeObserver: will result in undefined behavior.
        ///
        /// - Parameter interval: The interval of invocation of the block during normal rendering, according to progress of the current time of the timebase.
        /// - Parameter queue: The serial queue onto which block should be enqueued. If you pass NULL, the main queue (obtained using dispatch_get_main_queue()) will be used. Passing a concurrent queue to this method will result in undefined behavior.
        /// - Parameter block: The block to be invoked periodically.
        ///
        /// - Returns: An object conforming to the NSObject protocol.  You must retain this returned value as long as you want the time observer to be invoked by the synchronizer.  Pass this object to -removeTimeObserver: to cancel time observation.
        ///
        /// # Safety
        ///
        /// - `queue` possibly has additional threading requirements.
        /// - `block` block must be sendable.
        #[unsafe(method(addPeriodicTimeObserverForInterval:queue:usingBlock:))]
        #[unsafe(method_family = none)]
        pub unsafe fn addPeriodicTimeObserverForInterval_queue_usingBlock(
            &self,
            interval: CMTime,
            queue: Option<&DispatchQueue>,
            block: &block2::DynBlock<dyn Fn(CMTime)>,
        ) -> Retained<AnyObject>;

        #[cfg(all(feature = "block2", feature = "dispatch2"))]
        /// Requests invocation of a block when specified times are traversed during normal rendering.
        ///
        /// Each call to -addPeriodicTimeObserverForInterval:queue:usingBlock: should be paired with a corresponding call to -removeTimeObserver:. Releasing the observer object without a call to -removeTimeObserver: will result in undefined behavior.
        ///
        /// - Parameter times: The times for which the observer requests notification, supplied as an array of NSValues carrying CMTimes.
        /// - Parameter queue: The serial queue onto which block should be enqueued. If you pass NULL, the main queue (obtained using dispatch_get_main_queue()) will be used. Passing a concurrent queue to this method will result in undefined behavior.
        /// - Parameter block: The block to be invoked when any of the specified times is crossed during normal rendering.
        ///
        /// - Returns: An object conforming to the NSObject protocol.  You must retain this returned value as long as you want the time observer to be invoked by the synchronizer.  Pass this object to -removeTimeObserver: to cancel time observation.
        ///
        /// # Safety
        ///
        /// - `queue` possibly has additional threading requirements.
        /// - `block` block must be sendable.
        #[unsafe(method(addBoundaryTimeObserverForTimes:queue:usingBlock:))]
        #[unsafe(method_family = none)]
        pub unsafe fn addBoundaryTimeObserverForTimes_queue_usingBlock(
            &self,
            times: &NSArray<NSValue>,
            queue: Option<&DispatchQueue>,
            block: &block2::DynBlock<dyn Fn()>,
        ) -> Retained<AnyObject>;

        /// Cancels a previously registered time observer.
        ///
        /// Upon return, the caller is guaranteed that no new time observer blocks will begin executing. Depending on the calling thread and the queue used to add the time observer, an in-flight block may continue to execute after this method returns. You can guarantee synchronous time observer removal by enqueuing the call to -removeTimeObserver: on that queue. Alternatively, call dispatch_sync(queue, ^{}) after -removeTimeObserver: to wait for any in-flight blocks to finish executing. -removeTimeObserver: should be used to explicitly cancel each time observer added using -addPeriodicTimeObserverForInterval:queue:usingBlock: and -addBoundaryTimeObserverForTimes:queue:usingBlock:.
        ///
        /// This method throws an exception for any of the following reasons:
        /// - observer was added by another AVSampleBufferRenderSynchronizer
        /// - observer was not returned by either
        /// -addPeriodicTimeObserverForInterval:queue:usingBlock:
        /// -addBoundaryTimeObserverForTimes:queue:usingBlock:
        ///
        /// - Parameter observer: An object returned by a previous call to -addPeriodicTimeObserverForInterval:queue:usingBlock: or -addBoundaryTimeObserverForTimes:queue:usingBlock:.
        ///
        /// # Safety
        ///
        /// `observer` should be of the correct type.
        #[unsafe(method(removeTimeObserver:))]
        #[unsafe(method_family = none)]
        pub unsafe fn removeTimeObserver(&self, observer: &AnyObject);
    );
}

/// AVSampleBufferRenderSynchronizerSpatialAudioExperience.
impl AVSampleBufferRenderSynchronizer {
    extern_methods!();
}