rust-macios 0.4.2

Apple Frameworks for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

use libc::c_float;
use objc::{msg_send, sel, sel_impl};
use rust_macios_objective_c_runtime_proc_macros::interface_impl;

use crate::{
    object,
    objective_c_runtime::traits::{FromId, PNSObject},
};

use super::UNNotificationSoundName;

object! {
    /// The sound played upon delivery of a notification.
    unsafe pub struct UNNotificationSound;
}

#[interface_impl(NSObject)]
impl UNNotificationSound {
    /* Creating Notification Sounds
     */

    /// Returns an object representing the default sound for notifications.
    #[property]
    pub fn default_sound() -> UNNotificationSound {
        unsafe { UNNotificationSound::from_id(msg_send![Self::m_class(), defaultSound]) }
    }

    /// Creates a sound object that represents a custom sound file.
    #[method]
    pub fn sound_named(name: UNNotificationSoundName) -> Self
    where
        Self: Sized + FromId,
    {
        unsafe { Self::from_id(msg_send![Self::m_class(), soundNamed: name]) }
    }

    /* Getting Critical Sounds
     */

    /// The default sound used for critical alerts.
    #[property]
    pub fn default_critical_sound() -> UNNotificationSound {
        unsafe { UNNotificationSound::from_id(msg_send![Self::m_class(), defaultCriticalSound]) }
    }

    /// Creates a sound object that plays the default critical alert sound at the volume you specify.
    #[method]
    pub fn default_critical_sound_with_audio_volume(volume: c_float) -> Self
    where
        Self: Sized + FromId,
    {
        unsafe {
            Self::from_id(msg_send![
                Self::m_class(),
                defaultCriticalSoundWithAudioVolume: volume
            ])
        }
    }

    /// Creates a custom sound object for critical alerts.
    #[method]
    pub fn critical_sound_named(name: UNNotificationSoundName) -> Self
    where
        Self: Sized + FromId,
    {
        unsafe { Self::from_id(msg_send![Self::m_class(), criticalSoundNamed: name]) }
    }

    /// Creates a custom sound object for critical alerts with the volume you specify.
    #[method]
    pub fn critical_sound_named_with_audio_volume(
        name: UNNotificationSoundName,
        volume: c_float,
    ) -> Self
    where
        Self: Sized + FromId,
    {
        unsafe {
            Self::from_id(
                msg_send![Self::m_class(), criticalSoundNamed: name withAudioVolume: volume],
            )
        }
    }

    /* Type Properties
     */

    #[property]
    pub fn default_ringtone_sound() -> UNNotificationSound {
        unsafe { UNNotificationSound::from_id(msg_send![Self::m_class(), defaultRingtoneSound]) }
    }

    /* Type Methods
     */

    #[method]
    pub fn ringtone_sound_named(name: UNNotificationSoundName) -> Self
    where
        Self: Sized + FromId,
    {
        unsafe { Self::from_id(msg_send![Self::m_class(), ringtoneSoundNamed: name]) }
    }
}