AudioRenderCategory AudioRenderCategory AudioRenderCategory AudioRenderCategory AudioRenderCategory Enum

Definition

Describes the purpose of the audio information in an audio stream.

public : enum class AudioRenderCategory
enum class winrt::Windows::Media::Render::AudioRenderCategory : int32_t
public enum AudioRenderCategory
Public Enum AudioRenderCategory
var value = Windows.Media.Render.AudioRenderCategory.alerts;
Attributes

Windows 10 requirements

Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Fields

Alerts Alerts Alerts Alerts Alerts 4

Audio is for system or application notifications, for example ring tones.

BackgroundCapableMedia BackgroundCapableMedia BackgroundCapableMedia BackgroundCapableMedia BackgroundCapableMedia 2

Audio is for general media, for example audio for video, or streaming audio, and can be played as background. This enumeration value is deprecated. For more information, see Remarks.

Communications Communications Communications Communications Communications 3

Audio is for peer-to-peer communications, for example chat or VoIP.

ForegroundOnlyMedia ForegroundOnlyMedia ForegroundOnlyMedia ForegroundOnlyMedia ForegroundOnlyMedia 1

Audio is for general media, for example audio for video, or streaming audio, but should not be played as background. This enumeration value is deprecated. For more information, see Remarks.

GameChat GameChat GameChat GameChat GameChat 8

Audio is voice chat for games.

GameEffects GameEffects GameEffects GameEffects GameEffects 6

Audio is for game-specific sound effects.

GameMedia GameMedia GameMedia GameMedia GameMedia 7

Audio is background (non-event or ambient) audio for games.

Media Media Media Media Media 11

Audio is media playback.

Movie Movie Movie Movie Movie 10

Audio is movie audio.

Other Other Other Other Other 0

All other streams.

SoundEffects SoundEffects SoundEffects SoundEffects SoundEffects 5

Audio is for sound effects.

Speech Speech Speech Speech Speech 9

Audio is speech.

Remarks

Starting in Windows 10, version 1511 the ForegroundOnlyMedia and BackgroundCapableMedia enumeration values are deprecated. For more info about using background audio in your app, see Play media in the background.

Games should categorize their music streams as GameMedia so that game music mutes automatically if another application plays music in the background. Music or video applications should categorize their streams as Media or Movie so they will take priority over GameMedia streams. Game audio for in-game cinematics or cutscenes, when the audio is premixed or for creative reasons should take priority over background audio, should also be categorized as Media or Movie.