objc2-home-kit 0.3.2

Bindings to the HomeKit framework
Documentation
//! 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::*;
use objc2_foundation::*;

use crate::*;

extern_class!(
    /// This class can be used to take an image snapshot from a camera.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/homekit/hmcamerasnapshotcontrol?language=objc)
    #[unsafe(super(HMCameraControl, NSObject))]
    #[derive(Debug, PartialEq, Eq, Hash)]
    #[cfg(feature = "HMCameraControl")]
    pub struct HMCameraSnapshotControl;
);

#[cfg(feature = "HMCameraControl")]
unsafe impl Send for HMCameraSnapshotControl {}

#[cfg(feature = "HMCameraControl")]
unsafe impl Sync for HMCameraSnapshotControl {}

#[cfg(feature = "HMCameraControl")]
extern_conformance!(
    unsafe impl NSObjectProtocol for HMCameraSnapshotControl {}
);

#[cfg(feature = "HMCameraControl")]
impl HMCameraSnapshotControl {
    extern_methods!(
        /// Delegate that receives updates on the camera snapshot changes.
        ///
        /// This property is not atomic.
        ///
        /// # Safety
        ///
        /// This might not be thread-safe.
        #[unsafe(method(delegate))]
        #[unsafe(method_family = none)]
        pub unsafe fn delegate(
            &self,
        ) -> Option<Retained<ProtocolObject<dyn HMCameraSnapshotControlDelegate>>>;

        /// Setter for [`delegate`][Self::delegate].
        ///
        /// This is a [weak property][objc2::topics::weak_property].
        ///
        /// # Safety
        ///
        /// This might not be thread-safe.
        #[unsafe(method(setDelegate:))]
        #[unsafe(method_family = none)]
        pub unsafe fn setDelegate(
            &self,
            delegate: Option<&ProtocolObject<dyn HMCameraSnapshotControlDelegate>>,
        );

        #[cfg(all(feature = "HMCameraSnapshot", feature = "HMCameraSource"))]
        /// Represents the most recent snapshot taken from the camera.
        ///
        /// This property is not atomic.
        ///
        /// # Safety
        ///
        /// This might not be thread-safe.
        #[unsafe(method(mostRecentSnapshot))]
        #[unsafe(method_family = none)]
        pub unsafe fn mostRecentSnapshot(&self) -> Option<Retained<HMCameraSnapshot>>;

        /// Takes an image snapshot.
        #[unsafe(method(takeSnapshot))]
        #[unsafe(method_family = none)]
        pub unsafe fn takeSnapshot(&self);

        #[deprecated = "HMCameraSnapshotControl objects are created by their parent container objects. Directly creating them is not supported."]
        #[unsafe(method(init))]
        #[unsafe(method_family = init)]
        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
    );
}

/// Methods declared on superclass `NSObject`.
#[cfg(feature = "HMCameraControl")]
impl HMCameraSnapshotControl {
    extern_methods!(
        #[unsafe(method(new))]
        #[unsafe(method_family = new)]
        pub unsafe fn new() -> Retained<Self>;
    );
}

extern_protocol!(
    /// This delegate receives updates on the camera snapshot.
    ///
    /// See also [Apple's documentation](https://developer.apple.com/documentation/homekit/hmcamerasnapshotcontroldelegate?language=objc)
    pub unsafe trait HMCameraSnapshotControlDelegate: NSObjectProtocol {
        #[cfg(all(
            feature = "HMCameraControl",
            feature = "HMCameraSnapshot",
            feature = "HMCameraSource"
        ))]
        /// Informs the delegate that the snapshot was taken.
        ///
        ///
        /// Parameter `cameraSnapshotControl`: Sender of this message.
        ///
        ///
        /// Parameter `snapshot`: Snapshot will be valid if snapshot was successfully taken.
        ///
        ///
        /// Parameter `error`: Error will be populated if the snapshot could not be taken.
        #[optional]
        #[unsafe(method(cameraSnapshotControl:didTakeSnapshot:error:))]
        #[unsafe(method_family = none)]
        unsafe fn cameraSnapshotControl_didTakeSnapshot_error(
            &self,
            camera_snapshot_control: &HMCameraSnapshotControl,
            snapshot: Option<&HMCameraSnapshot>,
            error: Option<&NSError>,
        );

        #[cfg(feature = "HMCameraControl")]
        /// Informs the delegate that the mostRecentSnapshot was updated.
        ///
        ///
        /// Parameter `cameraSnapshotControl`: Sender of this message.
        #[optional]
        #[unsafe(method(cameraSnapshotControlDidUpdateMostRecentSnapshot:))]
        #[unsafe(method_family = none)]
        unsafe fn cameraSnapshotControlDidUpdateMostRecentSnapshot(
            &self,
            camera_snapshot_control: &HMCameraSnapshotControl,
        );
    }
);