Edit

Share via

audio (Toast XML Schema)

  • Article

Specifies a sound to play when a toast notification is displayed. This element also allows you to mute any toast notification audio.

Element hierarchy

<toast>
<audio>

Syntax

<audio src?    = string
       loop?   = boolean
       silent? = boolean />

Key

?   optional (zero or one)

Attributes and Elements

Attributes

Attribute Description Data type Required Default value
loop

Set to true if the sound should repeat as long as the toast is shown; false to play only once. If this attribute is set to true, the duration attribute in the toast element must also be set. There are specific sounds provided to be used when looping. Note that UWP apps support neither looping audio nor long-duration toasts.

 boolean No false
silent

True to mute the sound; false to allow the toast notification sound to play.

 boolean No false
src

The media file to play in place of the default sound. On Windows, this attribute can have one of the following string values:

  • ms-winsoundevent:Notification.Default
  • ms-winsoundevent:Notification.IM
  • ms-winsoundevent:Notification.Mail
  • ms-winsoundevent:Notification.Reminder
  • ms-winsoundevent:Notification.SMS
  • ms-winsoundevent:Notification.Looping.Alarm
  • ms-winsoundevent:Notification.Looping.Alarm2
  • ms-winsoundevent:Notification.Looping.Alarm3
  • ms-winsoundevent:Notification.Looping.Alarm4
  • ms-winsoundevent:Notification.Looping.Alarm5
  • ms-winsoundevent:Notification.Looping.Alarm6
  • ms-winsoundevent:Notification.Looping.Alarm7
  • ms-winsoundevent:Notification.Looping.Alarm8
  • ms-winsoundevent:Notification.Looping.Alarm9
  • ms-winsoundevent:Notification.Looping.Alarm10
  • ms-winsoundevent:Notification.Looping.Call
  • ms-winsoundevent:Notification.Looping.Call2
  • ms-winsoundevent:Notification.Looping.Call3
  • ms-winsoundevent:Notification.Looping.Call4
  • ms-winsoundevent:Notification.Looping.Call5
  • ms-winsoundevent:Notification.Looping.Call6
  • ms-winsoundevent:Notification.Looping.Call7
  • ms-winsoundevent:Notification.Looping.Call8
  • ms-winsoundevent:Notification.Looping.Call9
  • ms-winsoundevent:Notification.Looping.Call10

See the remarks section for information about custom sounds.

 string No None

 

Child Elements

None.

Parent Elements

Parent Element Description
toast

Base toast element, which contains at least a single visual element.

 

Remarks

UWP apps that target the desktop platform support custom toast notification sounds on Windows 10, version 1511 (build 10586) and later. On earlier versions, you can choose from the list of ms-winsoundevent values listed for the src attribute in the table above. For more information about custom toast notification sounds, see Custom audio on toasts.

If you specify a custom file path in the app payload, the default sound (notification, call, alarm, or reminder) will be played based on the specified scenario.

Examples

The following code shows an example of this tag.

<audio src="ms-winsoundevent:Notification.Mail" loop="false"/>

The following code shows this tag used to mute toast notification audio.

<audio silent="true"/>

See also