Interfaces for "Enhanced UX Notification for Video and Audio Call Fea…

…ture" (#4783)
microsoft · Nov 22, 2024 · 5a41e3b · 5a41e3b
1 parent c9eebef
commit 5a41e3b
Show file tree

Hide file tree

Showing 26 changed files with 537 additions and 24 deletions.
diff --git a/dev/AppNotifications/AppNotification.cpp b/dev/AppNotifications/AppNotification.cpp
@@ -119,4 +119,17 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
         auto lock{ m_lock.lock_exclusive() };
         m_notificationId = id;
     }
+
+    winrt::Microsoft::Windows::AppNotifications::AppNotificationConferencingConfig AppNotification::ConferencingConfig()
+    {
+        auto lock{ m_lock.lock_shared() };
+        return m_conferencingConfig;
+    }
+
+    void AppNotification::ConferencingConfig(winrt::Microsoft::Windows::AppNotifications::AppNotificationConferencingConfig const& conferencingConfig)
+    {
+        THROW_HR_IF(E_NOTIMPL, !AppNotificationConferencingConfig::IsCallingPreviewSupported());
+        auto lock{ m_lock.lock_exclusive() };
+        m_conferencingConfig = conferencingConfig;
+    }
 }
diff --git a/dev/AppNotifications/AppNotification.h b/dev/AppNotifications/AppNotification.h
@@ -37,6 +37,9 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
         // IAppNotificationInternal
         void SetNotificationId(uint32_t id);
 
+        winrt::Microsoft::Windows::AppNotifications::AppNotificationConferencingConfig ConferencingConfig();
+        void ConferencingConfig(winrt::Microsoft::Windows::AppNotifications::AppNotificationConferencingConfig const& value);
+
     private:
         winrt::hstring m_tag{};
         winrt::hstring m_group{};
@@ -49,6 +52,8 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
         { winrt::Microsoft::Windows::AppNotifications::AppNotificationPriority::Default };
         bool m_suppressDisplay{ false };
         wil::srwlock m_lock;
+
+        winrt::Microsoft::Windows::AppNotifications::AppNotificationConferencingConfig m_conferencingConfig{ nullptr };
     };
 }
 namespace winrt::Microsoft::Windows::AppNotifications::factory_implementation

diff --git a/dev/AppNotifications/AppNotificationBuilder/AppNotificationBuilder.cpp b/dev/AppNotifications/AppNotificationBuilder/AppNotificationBuilder.cpp
@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation and Contributors.
+// Copyright (c) Microsoft Corporation and Contributors.
 // Licensed under the MIT License.
 
 #include "pch.h"
@@ -376,14 +376,15 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
         // Build the actions string and fill m_useButtonStyle
         std::wstring actions{ GetActions() };
 
-        auto xmlResult{ wil::str_printf<std::wstring>(L"<toast%ls%ls%ls%ls%ls><visual><binding template='ToastGeneric'>%ls%ls%ls%ls</binding></visual>%ls%ls</toast>",
+        auto xmlResult{ wil::str_printf<std::wstring>(L"<toast%ls%ls%ls%ls%ls><visual><binding template='ToastGeneric'>%ls%ls%ls%ls%ls</binding></visual>%ls%ls</toast>",
             m_timeStamp.c_str(),
             GetDuration().c_str(),
             GetScenario().c_str(),
             GetArguments().c_str(),
             GetButtonStyle().c_str(),
             GetText().c_str(),
             m_attributionText.c_str(),
+            GetCameraPreview().c_str(),
             GetImages().c_str(),
             GetProgressBars().c_str(),
             m_audio.c_str(),
@@ -399,4 +400,19 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
 
         return appNotification;
     }
+
+    winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationBuilder AppNotificationBuilder::AddCameraPreview()
+    {
+        THROW_HR_IF(E_NOTIMPL, !AppNotificationConferencingConfig::IsCallingPreviewSupported());
+
+        THROW_HR_IF_MSG(E_INVALIDARG, m_useCameraPreview, "CameraPreview element is already added, only one is allowed");
+
+        m_useCameraPreview = true;
+        return *this;
+    }
+
+    std::wstring AppNotificationBuilder::GetCameraPreview()
+    {
+        return m_useCameraPreview ? L"<cameraPreview/>" : L"";
+    }
 }
diff --git a/dev/AppNotifications/AppNotificationBuilder/AppNotificationBuilder.h b/dev/AppNotifications/AppNotificationBuilder/AppNotificationBuilder.h
@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
 #pragma once
@@ -65,6 +65,8 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
 
         static bool IsUrgentScenarioSupported();
 
+        winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationBuilder AddCameraPreview();
+
     private:
         void ThrowIfMaxInputItemsExceeded();
         std::wstring GetDuration();
@@ -75,6 +77,7 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
         std::wstring GetImages();
         std::wstring GetActions();
         std::wstring GetProgressBars();
+        std::wstring GetCameraPreview();
 
         std::wstring m_timeStamp{};
         AppNotificationDuration m_duration{ AppNotificationDuration::Default };
@@ -93,6 +96,7 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
         std::vector<AppNotificationComboBox> m_comboBoxList{};
         winrt::hstring m_tag{};
         winrt::hstring m_group{};
+        bool m_useCameraPreview{false};
     };
 }
 namespace winrt::Microsoft::Windows::AppNotifications::Builder::factory_implementation

diff --git a/dev/AppNotifications/AppNotificationBuilder/AppNotificationBuilder.idl b/dev/AppNotifications/AppNotificationBuilder/AppNotificationBuilder.idl
@@ -1,11 +1,12 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
 import "..\AppNotifications\AppNotifications.idl";
+#include <TerminalVelocityFeatures-CallingPreviewSupport.h>
 
 namespace Microsoft.Windows.AppNotifications.Builder
 {
-    [contractversion(1)]
+    [contractversion(2)]
     apicontract AppNotificationBuilderContract {}
 
     [contract(AppNotificationBuilderContract, 1)]
@@ -31,6 +32,14 @@ namespace Microsoft.Windows.AppNotifications.Builder
         Critical,
     };
 
+    [contract(AppNotificationBuilderContract, 2), feature(Feature_CallingPreviewSupport)]
+    enum AppNotificationButtonSettingStyle
+    {
+        None,
+        VideoCallConfig,
+        AudioCallConfig,
+    };
+
     [contract(AppNotificationBuilderContract, 1)]
     runtimeclass AppNotificationButton
     {
@@ -69,6 +78,10 @@ namespace Microsoft.Windows.AppNotifications.Builder
         // Launches the URI passed into the button when activated.
         AppNotificationButton SetInvokeUri(Windows.Foundation.Uri protocolUri);
         AppNotificationButton SetInvokeUri(Windows.Foundation.Uri protocolUri, String targetAppId);
+
+        // Sets the setting type for the button.
+        [contract(AppNotificationBuilderContract, 2), feature(Feature_CallingPreviewSupport)]
+        AppNotificationButton SetSettingStyle(AppNotificationButtonSettingStyle value);
     };
 
     [contract(AppNotificationBuilderContract, 1)]
@@ -242,5 +255,9 @@ namespace Microsoft.Windows.AppNotifications.Builder
         // AppNotification properties
         AppNotificationBuilder SetTag(String value);
         AppNotificationBuilder SetGroup(String group);
+
+        // Adds a camera preview to the AppNotification
+        [contract(AppNotificationBuilderContract, 2), feature(Feature_CallingPreviewSupport)]
+        AppNotificationBuilder AddCameraPreview();
     };
 }
diff --git a/dev/AppNotifications/AppNotificationBuilder/AppNotificationButton.cpp b/dev/AppNotifications/AppNotificationBuilder/AppNotificationButton.cpp
@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation and Contributors.
+// Copyright (c) Microsoft Corporation and Contributors.
 // Licensed under the MIT License.
 
 #include "pch.h"
@@ -121,17 +121,39 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
     {
         auto logTelemetry{ AppNotificationBuilderTelemetry::ButtonToString::Start(g_telemetryHelper) };
 
-        std::wstring xmlResult{ wil::str_printf<std::wstring>(L"<action content='%ls'%ls%ls%ls%ls%ls%ls/>",
+        std::wstring xmlResult{ wil::str_printf<std::wstring>(L"<action content='%ls'%ls%ls%ls%ls%ls%ls%ls/>",
             m_content.c_str(),
             GetActivationArguments().c_str(),
             m_useContextMenuPlacement ? L" placement='contextMenu'" : L"",
             m_iconUri ? wil::str_printf<std::wstring>(L" imageUri='%ls'", m_iconUri.ToString().c_str()).c_str() : L"",
             !m_inputId.empty() ? wil::str_printf<std::wstring>(L" hint-inputId='%ls'", m_inputId.c_str()).c_str() : L"",
             GetButtonStyle().c_str(),
-            !m_toolTip.empty() ? wil::str_printf<std::wstring>(L" hint-toolTip='%ls'", m_toolTip.c_str()).c_str() : L"") };
+            !m_toolTip.empty() ? wil::str_printf<std::wstring>(L" hint-toolTip='%ls'", m_toolTip.c_str()).c_str() : L"",
+            GetSettingStyle().c_str()) };
 
         logTelemetry.Stop();
 
         return xmlResult.c_str();
     }
+
+    winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationButton AppNotificationButton::SetSettingStyle(AppNotificationButtonSettingStyle const& value)
+    {
+        THROW_HR_IF(E_NOTIMPL, !AppNotificationConferencingConfig::IsCallingPreviewSupported());
+
+        m_settingType = value;
+        return *this;
+    }
+
+    std::wstring AppNotificationButton::GetSettingStyle()
+    {
+        switch (m_settingType)
+        {
+        case AppNotificationButtonSettingStyle::VideoCallConfig:
+            return L" settingType='videoDevices'";
+        case AppNotificationButtonSettingStyle::AudioCallConfig:
+            return L" settingType='audioDevices'";
+        default: // AppNotificationButtonSettingStyle::None
+            return L"";
+        }
+    }
 }
diff --git a/dev/AppNotifications/AppNotificationBuilder/AppNotificationButton.h b/dev/AppNotifications/AppNotificationBuilder/AppNotificationButton.h
@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation and Contributors.
+// Copyright (c) Microsoft Corporation and Contributors.
 // Licensed under the MIT License.
 
 #pragma once
@@ -60,9 +60,12 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
 
         winrt::hstring ToString();
 
+        winrt::Microsoft::Windows::AppNotifications::Builder::AppNotificationButton SetSettingStyle(AppNotificationButtonSettingStyle const& value);
+
     private:
         std::wstring GetActivationArguments();
         std::wstring GetButtonStyle();
+        std::wstring GetSettingStyle();
 
         winrt::hstring m_content{};
         winrt::Windows::Foundation::Collections::IMap<winrt::hstring, winrt::hstring> m_arguments { winrt::single_threaded_map<winrt::hstring, winrt::hstring>() };
@@ -73,6 +76,7 @@ namespace winrt::Microsoft::Windows::AppNotifications::Builder::implementation
         winrt::hstring m_inputId{};
         bool m_useContextMenuPlacement{};
         AppNotificationButtonStyle m_buttonStyle { AppNotificationButtonStyle::Default };
+        AppNotificationButtonSettingStyle m_settingType{ AppNotificationButtonSettingStyle::None };
     };
 }
 namespace winrt::Microsoft::Windows::AppNotifications::Builder::factory_implementation

diff --git a/dev/AppNotifications/AppNotificationConferencingConfig.cpp b/dev/AppNotifications/AppNotificationConferencingConfig.cpp
@@ -0,0 +1,50 @@
+// Copyright (c) Microsoft Corporation and Contributors.
+// Licensed under the MIT License.
+
+#include "pch.h"
+#include "AppNotificationConferencingConfig.h"
+#include "Microsoft.Windows.AppNotifications.AppNotificationConferencingConfig.g.cpp"
+#include <IsWindowsVersion.h>
+
+namespace winrt::Microsoft::Windows::AppNotifications::implementation
+{
+    hstring AppNotificationConferencingConfig::VideoDeviceId()
+    {
+        return m_videoDeviceId;
+    }
+
+    void AppNotificationConferencingConfig::VideoDeviceId(hstring const& value)
+    {
+        THROW_HR_IF(E_NOTIMPL, !IsCallingPreviewSupported());
+        m_videoDeviceId = value;
+    }
+
+    hstring AppNotificationConferencingConfig::AudioInputDeviceId()
+    {
+        return m_audioInputDeviceId;
+    }
+
+    void AppNotificationConferencingConfig::AudioInputDeviceId(hstring const& value)
+    {
+        THROW_HR_IF(E_NOTIMPL, !IsCallingPreviewSupported());
+        m_audioInputDeviceId = value;
+    }
+
+    hstring AppNotificationConferencingConfig::AudioOutputDeviceId()
+    {
+        return m_audioOutputDeviceId;
+    }
+
+    void AppNotificationConferencingConfig::AudioOutputDeviceId(hstring const& value)
+    {
+        THROW_HR_IF(E_NOTIMPL, !IsCallingPreviewSupported());
+        m_audioOutputDeviceId = value;
+    }
+
+    ///Checks if the calling preview feature is supported on the current OS version
+    ///TO DO - This method needs implementation on framework UDK, for now it always returns false
+    bool AppNotificationConferencingConfig::IsCallingPreviewSupported()
+    {
+        return false;
+    }
+}
diff --git a/dev/AppNotifications/AppNotificationConferencingConfig.h b/dev/AppNotifications/AppNotificationConferencingConfig.h
@@ -0,0 +1,37 @@
+// Copyright (c) Microsoft Corporation and Contributors.
+// Licensed under the MIT License.
+
+#pragma once
+#include "Microsoft.Windows.AppNotifications.AppNotificationConferencingConfig.g.h"
+
+namespace winrt::Microsoft::Windows::AppNotifications::implementation
+{
+    struct AppNotificationConferencingConfig : AppNotificationConferencingConfigT<AppNotificationConferencingConfig>
+    {
+        AppNotificationConferencingConfig() = default;
+
+        // Getters
+        hstring VideoDeviceId();
+        hstring AudioInputDeviceId();
+        hstring AudioOutputDeviceId();
+
+        // Setters
+        void VideoDeviceId(hstring const& value);
+        void AudioInputDeviceId(hstring const& value);
+        void AudioOutputDeviceId(hstring const& value);
+
+        static bool IsCallingPreviewSupported();
+
+    private:
+
+        hstring m_videoDeviceId{};
+        hstring m_audioInputDeviceId{};
+        hstring m_audioOutputDeviceId{};
+    };
+}
+namespace winrt::Microsoft::Windows::AppNotifications::factory_implementation
+{
+    struct AppNotificationConferencingConfig : AppNotificationConferencingConfigT<AppNotificationConferencingConfig, implementation::AppNotificationConferencingConfig>
+    {
+    };
+}
diff --git a/dev/AppNotifications/AppNotificationManager.cpp b/dev/AppNotifications/AppNotificationManager.cpp
@@ -433,7 +433,8 @@ namespace winrt::Microsoft::Windows::AppNotifications::implementation
             m_appId,
             notification.Payload(),
             notification.Tag(),
-            notification.Group()) };
+            notification.Group(),
+            winrt::AppNotificationConferencingConfig::IsCallingPreviewSupported()) };
 
         THROW_HR_IF(WPN_E_NOTIFICATION_POSTED, notification.Id() != 0);
 

diff --git a/dev/AppNotifications/AppNotificationTelemetry.h b/dev/AppNotifications/AppNotificationTelemetry.h
@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation and Contributors.
+// Copyright (c) Microsoft Corporation and Contributors.
 // Licensed under the MIT license.
 
 #pragma once
@@ -62,7 +62,8 @@ class AppNotificationTelemetry : public wil::TraceLoggingProvider
             std::wstring const& appId,
             winrt::hstring const& payload,
             winrt::hstring const& tag,
-            winrt::hstring const& group) noexcept try
+            winrt::hstring const& group,
+            bool isCallingPreviewSupported) noexcept try
         {
             TraceLoggingClassWriteStart(
                 Show,
@@ -72,7 +73,8 @@ class AppNotificationTelemetry : public wil::TraceLoggingProvider
                 TraceLoggingUInt32(tag.size(), "TagSize"),
                 TraceLoggingUInt32(group.size(), "GroupSize"),
                 TraceLoggingBool(notificationTelemetryHelper.IsPackagedApp(), "IsAppPackaged"),
-                TraceLoggingWideString(notificationTelemetryHelper.GetAppName().c_str(), "AppName"));
+                TraceLoggingWideString(notificationTelemetryHelper.GetAppName().c_str(), "AppName"),
+                TraceLoggingBool(isCallingPreviewSupported, "IsCallingPreviewSupported"));
         }
         CATCH_LOG() 
     END_ACTIVITY_CLASS();