AudioCategory enumeration

AudioCategory enumeration

Describes the purpose of the audio information in an audio stream. Used as a value by AudioCategory.

Syntax


public enum AudioCategory

Members

The AudioCategory enumeration has these members.

MemberValueDescription
Other0

All other streams.

ForegroundOnlyMedia1

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.

BackgroundCapableMedia2

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.

Communications3

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

Alerts4

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

SoundEffects5

Audio is for sound effects.

GameEffects6

Audio is for game-specific sound effects.

GameMedia7

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

GameChat8

Game chat audio. Similar to Communications except that GameChat will not attenuate other streams.

Speech9

Audio is speech.

Movie10

Stream that includes audio with dialog.

Media11

Stream that includes audio without dialog.

Remarks

These enumeration values are used by the MediaElement.AudioCategory property. If you use the MediaPlayerElement control, you use the MediaPlayerAudioCategory enumeration values to set the AudioCategory directly on the underlying MediaPlayer instead.

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.

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.UI.Xaml.Media
Windows::UI::Xaml::Media [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.Xaml.Media
Windows::UI::Xaml::Media [C++]

Metadata

Windows.winmd

Attributes

[Version(0x06020000)]
[WebHostHidden()]

 

 

Show:
© 2017 Microsoft