AppNotificationBuilder.SetAudioUri 方法

定义

重载

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 有效负载中设置音频 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
  • Internet URL,例如 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 有效负载中设置音频 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
  • Internet URL,例如 http://、https://
  • 绝对文件路径,如 C:/、F:/等。

可以通过调用 SetAudioEvent 来指定播放系统定义声音的声音事件。

有关使用 AppNotificationBuilder API 创建应用通知的 UI 的指导,请参阅 应用通知内容

有关应用通知的 XML 架构的参考信息,请参阅 应用通知内容架构

适用于