Merge pull request #213 from Unity-Technologies/ios-sound-type-support

Add sound type support for iOS

Author: aurimasc

TestProjects/Main/Assets/Resources/iOSNotifications/TimeIntervalTrigger/Only Body.asset

@@ -12,7 +12,7 @@ MonoBehaviour:
   m_Script: {fileID: 11500000, guid: 4fc6c74f6df364b36b9afcbfd8cfbca3, type: 3}
   m_Name: Only Body
   m_EditorClassIdentifier: 
-  ButtonName: Empty notification + body
+  ButtonName: Empty notification + body (silent)
   Identifier: 
   CategoryIdentifier: 
   ThreadIdentifier: 
@@ -25,3 +25,4 @@ MonoBehaviour:
   Data: 
   TimeTriggerInterval: 1
   Repeats: 0
+  SoundType: 4

TestProjects/Main/Assets/Scripts/ScriptableObjects/iOSNotificationTemplateTimeTrigger.cs

@@ -36,6 +36,7 @@ public class iOSNotificationTemplateTimeTrigger : ScriptableObject
         [Header("Time Trigger")]
         public Int32 TimeTriggerInterval;
         public bool Repeats = false;
+        public NotificationSoundType SoundType;
 
         [Serializable]
         public struct UserDataItem

TestProjects/Main/Assets/Scripts/iOSTest.cs

@@ -226,6 +226,7 @@ private void InstantiateAllTestButtons()
                         ForegroundPresentationOption = template.PresentationOptions,
                         Badge = template.Badge,
                         Data = template.Data,
+                        SoundType = template.SoundType,
                         Trigger = new iOSNotificationTimeIntervalTrigger()
                         {
                             TimeInterval = TimeSpan.FromSeconds(template.TimeTriggerInterval),

com.unity.mobile.notifications/Documentation~/iOS.md

@@ -225,3 +225,9 @@ Sometimes, you might want to set custom data on the payload for a remote notific
 ```
 
 You have to use the exact `data` as the key of your custom data, because this is what the package looks for.
+
+#### Images, videos and sounds
+
+By default notifications use the default system sound. Sound can be disabled by changing the [iOSNotificationCenter.SoundType](../api/Unity.Notifications.iOS.iOSNotification.html#Unity_Notifications_iOS_iOSNotification_SoundType). A custom sound can be used by using Default sound type and assigning sound file name to [iOSNotificationCenter.SoundName](../api/Unity.Notifications.iOS.iOSNotification.html#Unity_Notifications_iOS_iOSNotification_SoundName). The sound file itself has to be manually added to XCode project. For more information regarding file placement and supported formats, see [Apple documentation](https://developer.apple.com/documentation/usernotifications/unnotificationsound?language=objc).
+
+Images or video can added to notifications by using [attachments](../api/Unity.Notifications.iOS.iOSNotificationAttachment.html).

com.unity.mobile.notifications/Runtime/iOS/Plugins/UnityNotificationData.h

@@ -17,6 +17,14 @@ enum triggerType
     UNKNOWN_TRIGGER = -1,
 };
 
+enum UnitySoundType
+{
+    kSoundTypeDefault = 0,
+    kSoundTypeCritical = 1,
+    kSoundTypeRingtone = 2,
+    kSoundTypeNone = 4,
+};
+
 typedef struct iOSNotificationData
 {
     char* identifier;
@@ -26,6 +34,9 @@ typedef struct iOSNotificationData
     char* subtitle;
     char* categoryIdentifier;
     char* threadIdentifier;
+    int soundType;
+    float soundVolume;
+    char* soundName;
 
     void* userInfo;
     void* attachments;

com.unity.mobile.notifications/Runtime/iOS/Plugins/UnityNotificationData.m

@@ -78,6 +78,9 @@ void initiOSNotificationData(iOSNotificationData* notificationData)
     notificationData->subtitle = NULL;
     notificationData->categoryIdentifier = NULL;
     notificationData->threadIdentifier = NULL;
+    notificationData->soundType = kSoundTypeDefault;
+    notificationData->soundVolume = -1.0f;
+    notificationData->soundName = NULL;
     notificationData->triggerType = PUSH_TRIGGER;
     notificationData->userInfo = NULL;
 }
@@ -201,6 +204,9 @@ void freeiOSNotificationData(iOSNotificationData* notificationData)
     if (notificationData->threadIdentifier != NULL)
         free(notificationData->threadIdentifier);
 
+    if (notificationData->soundName != NULL)
+        free(notificationData->soundName);
+
     if (notificationData->userInfo != NULL)
     {
         NSDictionary* userInfo = (__bridge_transfer NSDictionary*)notificationData->userInfo;

com.unity.mobile.notifications/Runtime/iOS/Plugins/UnityNotificationManager.m

@@ -297,8 +297,9 @@ - (void)scheduleLocalNotification:(iOSNotificationData*)data
     if (data->threadIdentifier != NULL)
         content.threadIdentifier = [NSString stringWithUTF8String: data->threadIdentifier];
 
-    // TODO add a way to specify custom sounds.
-    content.sound = [UNNotificationSound defaultSound];
+    UNNotificationSound* sound = [self soundForNotification: data];
+    if (sound != nil)
+        content.sound = sound;
 
     content.attachments = (__bridge_transfer NSArray<UNNotificationAttachment*>*)data->attachments;
     data->attachments = NULL;
@@ -363,5 +364,47 @@ - (void)scheduleLocalNotification:(iOSNotificationData*)data
     }];
 }
 
+- (UNNotificationSound*)soundForNotification:(const iOSNotificationData*)data
+{
+    NSString* soundName = nil;
+    if (data->soundName != NULL)
+        soundName = [NSString stringWithUTF8String: data->soundName];
+
+    switch (data->soundType)
+    {
+        case kSoundTypeNone:
+            return nil;
+        case kSoundTypeCritical:
+            if (@available(iOS 12.0, *))
+            {
+                if (soundName != nil)
+                {
+                    if (data->soundVolume < 0)
+                        return [UNNotificationSound criticalSoundNamed: soundName];
+                    return [UNNotificationSound criticalSoundNamed: soundName withAudioVolume: data->soundVolume];
+                }
+                if (data->soundVolume >= 0)
+                    return [UNNotificationSound defaultCriticalSoundWithAudioVolume: data->soundVolume];
+                return UNNotificationSound.defaultCriticalSound;
+            }
+            else
+                goto default_fallback;
+        case kSoundTypeRingtone:
+            if (@available(iOS 15.2, *))
+            {
+                if (soundName != nil)
+                    return [UNNotificationSound ringtoneSoundNamed: soundName];
+                return UNNotificationSound.defaultRingtoneSound;
+            }
+        // continue to default
+        case kSoundTypeDefault:
+        default:
+        default_fallback:
+            if (soundName != nil)
+                return [UNNotificationSound soundNamed: soundName];
+            return UNNotificationSound.defaultSound;
+    }
+}
+
 @end
 #endif

com.unity.mobile.notifications/Runtime/iOS/iOSNotification.cs

@@ -32,6 +32,34 @@ public enum PresentationOption
         Alert = 1 << 2,
     }
 
+    /// <summary>
+    /// The type of sound to use for the notification.
+    /// See Apple documentation for details.
+    /// </summary>
+    /// <see href="https://developer.apple.com/documentation/usernotifications/unnotificationsound?language=objc"/>
+    public enum NotificationSoundType
+    {
+        /// <summary>
+        /// Play the default sound.
+        /// </summary>
+        Default = 0,
+
+        /// <summary>
+        /// Critical sound (bypass Do Not Disturb)
+        /// </summary>
+        Critical = 1,
+
+        /// <summary>
+        /// Ringtone sound.
+        /// </summary>
+        Ringtone = 2,
+
+        /// <summary>
+        /// No sound.
+        /// </summary>
+        None = 4,
+    }
+
     [StructLayout(LayoutKind.Sequential)]
     internal struct TimeTriggerData
     {
@@ -82,6 +110,9 @@ internal struct iOSNotificationData
         public string subtitle;
         public string categoryIdentifier;
         public string threadIdentifier;
+        public Int32 soundType;
+        public float soundVolume;
+        public string soundName;
 
         public IntPtr userInfo;
         public IntPtr attachments;
@@ -213,6 +244,32 @@ public int Badge
             set { data.badge = value; }
         }
 
+        /// <summary>
+        /// The type of sound to be played.
+        /// </summary>
+        public NotificationSoundType SoundType
+        {
+            get { return (NotificationSoundType)data.soundType; }
+            set { data.soundType = (int)value; }
+        }
+
+        /// <summary>
+        /// The name of the sound to be played. Use null for system default sound.
+        /// See Apple documentation for named sounds and sound file placement.
+        /// </summary>
+        public string SoundName
+        {
+            get { return data.soundName; }
+            set { data.soundName = value; }
+        }
+
+        /// <summary>
+        /// The volume for the sound. Use null to use the default volume.
+        /// See Apple documentation for supported values.
+        /// </summary>
+        /// <see href="https://developer.apple.com/documentation/usernotifications/unnotificationsound/2963118-defaultcriticalsoundwithaudiovol?language=objc"/>
+        public float? SoundVolume { get; set; }
+
         /// <summary>
         /// Arbitrary string data which can be retrieved when the notification is used to open the app or is received while the app is running.
         /// </summary>
@@ -400,6 +457,11 @@ internal iOSNotificationWithUserInfo GetDataForSending()
         {
             if (data.identifier == null)
                 data.identifier = GenerateUniqueID();
+            if (SoundVolume.HasValue)
+                data.soundVolume = SoundVolume.Value;
+            else
+                data.soundVolume = -1.0f;
+
             iOSNotificationWithUserInfo ret;
             ret.data = data;
             ret.userInfo = userInfo;