語言

AppNotificationBuilder.SetAudioUri 方法

定義

多載

名稱 Description
SetAudioUri(Uri)

設定在顯示應用程式通知時播放的音效檔案。

SetAudioUri(Uri, AppNotificationAudioLooping)

它設定了當應用程式通知顯示時播放的音檔和音訊循環行為。

SetAudioUri(Uri)

設定在顯示應用程式通知時播放的音效檔案。

public:
 virtual AppNotificationBuilder ^ SetAudioUri(Uri ^ audioUri) = SetAudioUri;
/// [Windows.Foundation.Metadata.Overload("SetAudioUri")]
AppNotificationBuilder SetAudioUri(Uri const& audioUri);
[Windows.Foundation.Metadata.Overload("SetAudioUri")]
public AppNotificationBuilder SetAudioUri(System.Uri audioUri);
function setAudioUri(audioUri)
Public Function SetAudioUri (audioUri As Uri) As AppNotificationBuilder

參數

audioUri
Uri Uri

音訊檔案的 URI。

傳回

傳回 AppNotificationBuilder 實例,以便鏈結其他方法呼叫。

屬性

範例

以下範例示範如何在 XML payload 中設定應用程式通知的音訊 URI。

var notification = new AppNotificationBuilder()
    .AddText("Notification text.")
    .SetAudioUri(new Uri("ms-appx:///Audio/NotificationSound.mp3"))
    .BuildNotification();


AppNotificationManager.Default.Show(notification);

產生的 XML 承載:

<toast>
    <visual>
        <binding template='ToastGeneric'>
            <text>Notification text.</text>
        </binding>
    </visual>
    <audio src='ms-appx:///Audio/NotificationSound.mp3'/>
</toast>

備註

支援以下音訊檔案類型:

  • .aac
  • .flac
  • .m4a
  • .mp3
  • .wav
  • .wma

支援以下音訊檔案來源:

  • ms-appx:///
  • ms-resource

以下音訊檔案來源不支援:

  • ms-appdata
  • 網際網路網址,如 http://,https://
  • 絕對檔案路徑,例如 C:/、F:/ 等。

你可以指定一個聲音事件,播放系統定義的聲音,方法是呼叫 SetAudioEvent。

如需使用 AppNotificationBuilder API 來建立應用程式通知 UI 的指引,請參閱 應用程式通知內容。

如需應用程式通知 XML 架構的參考資訊,請參閱 應用程式通知內容架構。

適用於

SetAudioUri(Uri, AppNotificationAudioLooping)

它設定了當應用程式通知顯示時播放的音檔和音訊循環行為。

public:
 virtual AppNotificationBuilder ^ SetAudioUri(Uri ^ audioUri, AppNotificationAudioLooping loop) = SetAudioUri;
/// [Windows.Foundation.Metadata.Overload("SetAudioUri2")]
AppNotificationBuilder SetAudioUri(Uri const& audioUri, AppNotificationAudioLooping const& loop);
[Windows.Foundation.Metadata.Overload("SetAudioUri2")]
public AppNotificationBuilder SetAudioUri(System.Uri audioUri, AppNotificationAudioLooping loop);
function setAudioUri(audioUri, loop)
Public Function SetAudioUri (audioUri As Uri, loop As AppNotificationAudioLooping) As AppNotificationBuilder

參數

audioUri
Uri Uri

音訊檔案的 URI。

loop
AppNotificationAudioLooping

AppNotificationAudioLooping 列舉的成員,指定音訊的循環行為。

傳回

傳回 AppNotificationBuilder 實例,以便鏈結其他方法呼叫。

屬性

範例

以下範例示範如何在 XML payload 中設定應用程式通知的音訊 URI。

var notification = new AppNotificationBuilder()
    .AddText("Notification text.")
    .SetAudioUri(new Uri("ms-appx:///Audio/NotificationSound.mp3"), AppNotificationAudioLooping.Loop)
    .BuildNotification();


AppNotificationManager.Default.Show(notification);

產生的 XML 承載:

<toast>
    <visual>
        <binding template='ToastGeneric'>
            <text>Notification text.</text>
        </binding>
    </visual>
    <audio src='ms-appx:///Audio/NotificationSound.mp3'/>
</toast>

備註

支援以下音訊檔案類型:

  • .aac
  • .flac
  • .m4a
  • .mp3
  • .wav
  • .wma

支援以下音訊檔案來源:

  • ms-appx:///
  • ms-resource

以下音訊檔案來源不支援:

  • ms-appdata
  • 網際網路網址,如 http://,https://
  • 絕對檔案路徑,例如 C:/、F:/ 等。

你可以指定一個聲音事件,播放系統定義的聲音,方法是呼叫 SetAudioEvent。

如需使用 AppNotificationBuilder API 來建立應用程式通知 UI 的指引,請參閱 應用程式通知內容。

如需應用程式通知 XML 架構的參考資訊,請參閱 應用程式通知內容架構。

適用於