Skip to content

Commit 7e9645f

Browse files
drewbatgitdrewbatgit
committed
Merged PR 21049: Initial draft of audioeffectcontrols Ge APIs
Initial draft of audioeffectcontrols Ge APIs
2 parents 9caaa4d + 20ba7a4 commit 7e9645f

9 files changed

Lines changed: 234 additions & 2 deletions

‎windows.media.devices/audiodevicecontroller_audiocaptureeffectsmanager.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
-api-id: P:Windows.Media.Devices.AudioDeviceController.AudioCaptureEffectsManager
3+
-api-type: winrt property
4+
---
5+
6+
# Windows.Media.Devices.AudioDeviceController.AudioCaptureEffectsManager
7+
8+
<!--
9+
public Windows.Media.Effects.AudioCaptureEffectsManager AudioCaptureEffectsManager { get; }
10+
-->
11+
12+
13+
## -description
14+
15+
Gets the <xref:Windows.Media.Effects.AudioCaptureEffectsManager> associated with the **AudioDeviceController**.
16+
17+
## -property-value
18+
19+
An instance of **AudioCaptureEffectsManager**.
20+
21+
22+
## -remarks
23+
24+
## -see-also
25+
26+
## -examples
27+
28+

‎windows.media.effects/acousticechocancellationconfiguration.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
-api-id: T:Windows.Media.Effects.AcousticEchoCancellationConfiguration
3+
-api-type: winrt class
4+
---
5+
6+
# Windows.Media.Effects.AcousticEchoCancellationConfiguration
7+
8+
<!--
9+
public sealed class AcousticEchoCancellationConfiguration
10+
-->
11+
12+
13+
## -description
14+
15+
Represents the configuration of an Acoustic Echo Cancellation (AEC) audio capture effect.
16+
17+
## -remarks
18+
19+
Get an instance of this class by calling <xref:Windows.Media.Effects.AudioEffect.AcousticEchoCancellationConfiguration>.
20+
21+
## -see-also
22+
23+
## -examples
24+
25+

‎windows.media.effects/acousticechocancellationconfiguration_setechocancellationrenderendpoint_1849190620.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
-api-id: M:Windows.Media.Effects.AcousticEchoCancellationConfiguration.SetEchoCancellationRenderEndpoint(System.String)
3+
-api-type: winrt method
4+
---
5+
6+
# Windows.Media.Effects.AcousticEchoCancellationConfiguration.SetEchoCancellationRenderEndpoint(System.String)
7+
8+
<!--
9+
public void SetEchoCancellationRenderEndpoint (string deviceId);
10+
-->
11+
12+
13+
## -description
14+
15+
Sets the endpoint that should be used as the loopback reference by the Acoustic Echo Cancellation (AEC) effect.
16+
17+
## -parameters
18+
19+
### -param deviceId
20+
21+
The device ID of the device to use as the loopback reference.
22+
23+
## -remarks
24+
25+
Passing in a null string as the deviceId parameter will result in the loopback endpoint being reset to its default value.
26+
27+
## -see-also
28+
29+
## -examples
30+
31+

‎windows.media.effects/audiocaptureeffectsmanager.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,11 @@ public class AudioCaptureEffectsManager : Windows.Media.Effects.IAudioCaptureEff
1010
# Windows.Media.Effects.AudioCaptureEffectsManager
1111

1212
## -description
13-
Represent an audio capture effects manager which can be used to discover the audio processing chain on a device for a specific media category and audio processing mode.
13+
14+
Represents an audio capture effects manager which can be used to discover the audio processing chain on a device for a specific media category and audio processing mode.
1415

1516
## -remarks
16-
To create an instance of AudioCaptureEffectsManager, call [AudioEffectsManager.CreateAudioCaptureEffectsManager](audioeffectsmanager_createaudiocaptureeffectsmanager_1036225902.md).
17+
To create an instance of **AudioCaptureEffectsManager**, call [AudioEffectsManager.CreateAudioCaptureEffectsManager](audioeffectsmanager_createaudiocaptureeffectsmanager_1036225902.md). Or, you can get an instance of this class from an <xref:Windows.Media.Devices.AudioDeviceController> by accessing the <xref:Windows.Media.Devices.AudioDeviceController.AudioCaptureEffectsManager> property.
1718

1819
See the [Audio effects discovery sample](https://github.com/microsoftarchive/msdn-code-gallery-microsoft/tree/master/Official%20Windows%20Platform%20Sample/Audio%20effects%20discovery%20sample) for an example of how to query and monitor audio effects on render and capture audio devices.
1920

‎windows.media.effects/audioeffect_acousticechocancellationconfiguration.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
-api-id: P:Windows.Media.Effects.AudioEffect.AcousticEchoCancellationConfiguration
3+
-api-type: winrt property
4+
---
5+
6+
# Windows.Media.Effects.AudioEffect.AcousticEchoCancellationConfiguration
7+
8+
<!--
9+
public Windows.Media.Effects.AcousticEchoCancellationConfiguration AcousticEchoCancellationConfiguration { get; }
10+
-->
11+
12+
13+
## -description
14+
15+
Gets the <xref:Windows.Media.Effects.AcousticEchoCancellationConfiguration> associated with the audio effect.
16+
17+
## -property-value
18+
19+
The **AcousticEchoCancellationConfiguration** associated with the audio effect. If the audio effect doesn't support Acoustic Echo Cancellation (AEC), the returned value will be null.
20+
21+
## -remarks
22+
23+
## -see-also
24+
25+
## -examples
26+
27+

‎windows.media.effects/audioeffect_cansetstate.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
-api-id: P:Windows.Media.Effects.AudioEffect.CanSetState
3+
-api-type: winrt property
4+
---
5+
6+
# Windows.Media.Effects.AudioEffect.CanSetState
7+
8+
<!--
9+
public bool CanSetState { get; }
10+
-->
11+
12+
13+
## -description
14+
15+
Gets a boolean value indicating whether the audio effect supports setting its internal state with a call to <Windows.Media.Effects.AudioEffect.SetState(Windows.Media.Effects.AudioEffectState)>.
16+
17+
## -property-value
18+
19+
True if the effect supports setting state; otherwise, false.
20+
21+
## -remarks
22+
23+
## -see-also
24+
25+
## -examples
26+
27+

‎windows.media.effects/audioeffect_setstate_538029349.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
-api-id: M:Windows.Media.Effects.AudioEffect.SetState(Windows.Media.Effects.AudioEffectState)
3+
-api-type: winrt method
4+
---
5+
6+
# Windows.Media.Effects.AudioEffect.SetState(Windows.Media.Effects.AudioEffectState)
7+
8+
<!--
9+
public void SetState (Windows.Media.Effects.AudioEffectState newState);
10+
-->
11+
12+
13+
## -description
14+
15+
Sets the current state of the audio effect.
16+
17+
## -parameters
18+
19+
### -param newState
20+
21+
A value from the <xref:Windows.Media.Effects.AudioEffectState> enumeration specifying the new state of the audio effect.
22+
23+
## -remarks
24+
25+
You should call <xref: Windows.Media.Effects.AudioEffect.CanSetState> to confirm that the audio effect supports setting state before calling this method.
26+
27+
## -see-also
28+
29+
## -examples
30+
31+

‎windows.media.effects/audioeffect_state.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
-api-id: P:Windows.Media.Effects.AudioEffect.State
3+
-api-type: winrt property
4+
---
5+
6+
# Windows.Media.Effects.AudioEffect.State
7+
8+
<!--
9+
public Windows.Media.Effects.AudioEffectState State { get; }
10+
-->
11+
12+
13+
## -description
14+
15+
Gets the current state of the audio effect.
16+
17+
## -property-value
18+
19+
A value from the <xref:Windows.Media.Effects.AudioEffectState> enumeration indicating the current state of the audio effect.
20+
21+
## -remarks
22+
23+
## -see-also
24+
25+
## -examples
26+
27+

‎windows.media.effects/audioeffectstate.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
-api-id: T:Windows.Media.Effects.AudioEffectState
3+
-api-type: winrt enum
4+
---
5+
6+
# Windows.Media.Effects.AudioEffectState
7+
8+
<!--
9+
public enum AudioEffectState
10+
-->
11+
12+
13+
## -description
14+
15+
Specifies the state of an audio effect.
16+
17+
## -enum-fields
18+
19+
### -field Off: 0
20+
21+
The audio effect is disabled.
22+
23+
### -field On: 1
24+
25+
The audio effect is enabled.
26+
27+
## -remarks
28+
29+
This enumeration is used in calls to <xref:Windows.Media.Effects.AudioEffect.SetState(Windows.Media.Effects.AudioEffectState)>.
30+
31+
## -see-also
32+
33+
## -examples
34+
35+

0 commit comments

Comments
 (0)