AppNotificationBuilder.SetAudioEvent Méthode

Définition

Espace de noms:

Microsoft.Windows.AppNotifications.Builder

Surcharges

SetAudioEvent(AppNotificationSoundEvent)	Définit l’événement audio pour une notification d’application.
SetAudioEvent(AppNotificationSoundEvent, AppNotificationAudioLooping)	Définit l’événement audio et le comportement de boucle pour une notification d’application.

SetAudioEvent(AppNotificationSoundEvent)

Définit l’événement audio pour une notification d’application.

public:
 virtual AppNotificationBuilder ^ SetAudioEvent(AppNotificationSoundEvent appNotificationSoundEvent) = SetAudioEvent;

/// [Windows.Foundation.Metadata.Overload("SetAudioEvent")]
AppNotificationBuilder SetAudioEvent(AppNotificationSoundEvent const& appNotificationSoundEvent);

[Windows.Foundation.Metadata.Overload("SetAudioEvent")]
public AppNotificationBuilder SetAudioEvent(AppNotificationSoundEvent appNotificationSoundEvent);

function setAudioEvent(appNotificationSoundEvent)

Public Function SetAudioEvent (appNotificationSoundEvent As AppNotificationSoundEvent) As AppNotificationBuilder

Paramètres

appNotificationSoundEvent

AppNotificationSoundEvent

Membre de l’énumération AppNotificationSoundEvent spécifiant un son système à lire.

Retours

AppNotificationBuilder

Retourne le instance AppNotificationBuilder afin que des appels de méthode supplémentaires puissent être chaînés.

Attributs

OverloadAttribute

Exemples

L’exemple suivant montre comment définir un événement audio dans la charge utile XML pour une notification d’application.

var notification = new AppNotificationBuilder()
    .AddText("Notification text.")
    .SetAudioEvent(AppNotificationSoundEvent.Alarm)
    .BuildNotification();

AppNotificationManager.Default.Show(notification);

Charge utile XML résultante :

<toast>
    <visual>
        <binding template='ToastGeneric'>
            <text>Notification text.</text>
        </binding>
    </visual>
    <audio src='ms-winsoundevent:Notification.Looping.Alarm'/>
</toast>

Remarques

Cette méthode vous permet de fournir une expérience audio cohérente en spécifiant un type d’événement audio, qui utilise des sons système standardisés. Vous pouvez spécifier un son personnalisé pour une notification d’application en appelant SetAudioUri.

Pour obtenir des conseils sur l’utilisation des API AppNotificationBuilder pour créer l’interface utilisateur pour les notifications d’application, consultez Contenu des notifications d’application.

Pour obtenir des informations de référence sur le schéma XML pour les notifications d’application, consultez Schéma de contenu de notification d’application.

SetAudioEvent(AppNotificationSoundEvent, AppNotificationAudioLooping)

Définit l’événement audio et le comportement de boucle pour une notification d’application.

public:
 virtual AppNotificationBuilder ^ SetAudioEvent(AppNotificationSoundEvent appNotificationSoundEvent, AppNotificationAudioLooping loop) = SetAudioEvent;

/// [Windows.Foundation.Metadata.Overload("SetAudioEvent2")]
AppNotificationBuilder SetAudioEvent(AppNotificationSoundEvent const& appNotificationSoundEvent, AppNotificationAudioLooping const& loop);

[Windows.Foundation.Metadata.Overload("SetAudioEvent2")]
public AppNotificationBuilder SetAudioEvent(AppNotificationSoundEvent appNotificationSoundEvent, AppNotificationAudioLooping loop);

function setAudioEvent(appNotificationSoundEvent, loop)

Public Function SetAudioEvent (appNotificationSoundEvent As AppNotificationSoundEvent, loop As AppNotificationAudioLooping) As AppNotificationBuilder

Paramètres

appNotificationSoundEvent

AppNotificationSoundEvent

Membre de l’énumération AppNotificationSoundEvent spécifiant un son système à lire.

loop

AppNotificationAudioLooping

Membre de l’énumération AppNotificationAudioLooping spécifiant le comportement de boucle pour l’audio.

Retours

AppNotificationBuilder

Retourne le instance AppNotificationBuilder afin que des appels de méthode supplémentaires puissent être chaînés.

Attributs

OverloadAttribute

Exemples

L’exemple suivant montre comment définir un événement audio dans la charge utile XML pour une notification d’application.

var notification = new AppNotificationBuilder()
    .AddText("Notification text.")
    .SetAudioEvent(AppNotificationSoundEvent.Alarm, AppNotificationAudioLooping.Loop)
    .BuildNotification();

AppNotificationManager.Default.Show(notification);

Charge utile XML résultante :

<toast>
    <visual>
        <binding template='ToastGeneric'>
            <text>Notification text.</text>
        </binding>
    </visual>
    <audio src='ms-winsoundevent:Notification.Looping.Alarm' loop='true'/>
</toast>

Remarques

Cette méthode vous permet de fournir une expérience audio cohérente en spécifiant un type d’événement audio, qui utilise des sons système standardisés. Vous pouvez spécifier un son personnalisé pour une notification d’application en appelant SetAudioUri.

Pour obtenir des conseils sur l’utilisation des API AppNotificationBuilder pour créer l’interface utilisateur pour les notifications d’application, consultez Contenu des notifications d’application.

Pour obtenir des informations de référence sur le schéma XML pour les notifications d’application, consultez Schéma de contenu de notification d’application.