Skip to content

Commit 8d24ab9

Browse files
Karl-Bridge-MicrosoftKarl-Bridge-Microsoft
committed
second round of stubs
1 parent 68c7cac commit 8d24ab9

15 files changed

Lines changed: 546 additions & 541 deletions

windows.gaming.input.preview/legacygipgamecontrollerprovider_clearpairing.md renamed to windows.gaming.input.preview/legacygipgamecontrollerprovider_clearpairing_328827560.md

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,37 @@
1-
---
2-
-api-id: M:Windows.Gaming.Input.Preview.LegacyGipGameControllerProvider.ClearPairing(Windows.System.User,System.String)
3-
-api-type: winrt method
4-
---
5-
6-
# Windows.Gaming.Input.Preview.LegacyGipGameControllerProvider.ClearPairing(Windows.System.User,System.String)
7-
8-
<!--
9-
public static void ClearPairing (Windows.System.User user, string controllerProviderId);
10-
-->
11-
12-
## -description
13-
14-
Removes any copilot pairings for controllerId for the given user.
15-
16-
## -parameters
17-
18-
### -param user
19-
20-
User to clear the pairing for.
21-
22-
### -param controllerProviderId
23-
24-
Provider id for the controller to remove from parings.
25-
26-
## -remarks
27-
28-
Removes the given controller from any pairings where it is either a pilot or copilot for the given user. The controller does not need to be connected to be unpaired. Removing one controller from a pairing removes the pairing entirely &mdash; that is, if a controller is paired as a copilot to another controller, removing the copilot controller will also remove the pairing for the pilot controller and vice versa.
29-
30-
> [!CAUTION]
31-
> Copilot pairing is system-wide and persistent for the given user. This should only be done at the user's direction.
32-
33-
## -examples
34-
35-
:::code language="csharp" source="code/csharp/CopilotSample.cs":::
36-
37-
## -see-also
1+
---
2+
-api-id: M:Windows.Gaming.Input.Preview.LegacyGipGameControllerProvider.ClearPairing(Windows.System.User,System.String)
3+
-api-type: winrt method
4+
---
5+
6+
# Windows.Gaming.Input.Preview.LegacyGipGameControllerProvider.ClearPairing(Windows.System.User,System.String)
7+
8+
<!--
9+
public static void ClearPairing (Windows.System.User user, string controllerProviderId);
10+
-->
11+
12+
## -description
13+
14+
Removes any copilot pairings for controllerId for the given user.
15+
16+
## -parameters
17+
18+
### -param user
19+
20+
User to clear the pairing for.
21+
22+
### -param controllerProviderId
23+
24+
Provider id for the controller to remove from parings.
25+
26+
## -remarks
27+
28+
Removes the given controller from any pairings where it is either a pilot or copilot for the given user. The controller does not need to be connected to be unpaired. Removing one controller from a pairing removes the pairing entirely &mdash; that is, if a controller is paired as a copilot to another controller, removing the copilot controller will also remove the pairing for the pilot controller and vice versa.
29+
30+
> [!CAUTION]
31+
> Copilot pairing is system-wide and persistent for the given user. This should only be done at the user's direction.
32+
33+
## -see-also
34+
35+
## -examples
36+
37+
:::code language="csharp" source="code/csharp/CopilotSample.cs":::

windows.gaming.input.preview/legacygipgamecontrollerprovider_executecommand.md renamed to windows.gaming.input.preview/legacygipgamecontrollerprovider_executecommand_1957933249.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
1-
---
2-
-api-id: M:Windows.Gaming.Input.Preview.LegacyGipGameControllerProvider.ExecuteCommand(Windows.Gaming.Input.Preview.DeviceCommand)
3-
-api-type: winrt method
4-
---
5-
6-
<!-- Method syntax.
7-
public void LegacyGipGameControllerProvider.ExecuteCommand(DeviceCommand command)
8-
-->
9-
10-
# Windows.Gaming.Input.Preview.LegacyGipGameControllerProvider.ExecuteCommand
11-
12-
## -description
13-
14-
Executes a command on a legacy GIP headset.
15-
16-
## -parameters
17-
18-
### -param command
19-
20-
The command to execute.
21-
22-
## -remarks
23-
24-
> [!CAUTION]
25-
> To avoid damaging devices, the headset control APIs should only be used with hardware you have developed.
26-
27-
## -examples
28-
29-
:::code language="csharp" source="code/csharp/HeadsetManagementSample.cs":::
30-
31-
## -see-also
32-
33-
[DeviceCommand](devicecommand.md)
1+
---
2+
-api-id: M:Windows.Gaming.Input.Preview.LegacyGipGameControllerProvider.ExecuteCommand(Windows.Gaming.Input.Preview.DeviceCommand)
3+
-api-type: winrt method
4+
---
5+
6+
# Windows.Gaming.Input.Preview.LegacyGipGameControllerProvider.ExecuteCommand(Windows.Gaming.Input.Preview.DeviceCommand)
7+
8+
<!--
9+
public void ExecuteCommand (Windows.Gaming.Input.Preview.DeviceCommand command);
10+
-->
11+
12+
## -description
13+
14+
Executes a command on a legacy GIP headset.
15+
16+
## -parameters
17+
18+
### -param command
19+
20+
The command to execute.
21+
22+
## -remarks
23+
24+
> [!CAUTION]
25+
> To avoid damaging devices, the headset control APIs should only be used with hardware you have developed.
26+
27+
## -see-also
28+
29+
[DeviceCommand](devicecommand.md)
30+
31+
## -examples
32+
33+
:::code language="csharp" source="code/csharp/HeadsetManagementSample.cs":::

windows.gaming.input.preview/legacygipgamecontrollerprovider_fromgamecontroller.md renamed to windows.gaming.input.preview/legacygipgamecontrollerprovider_fromgamecontroller_421915006.md

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
1-
---
2-
-api-id: M:Windows.Gaming.Input.Preview.LegacyGipGameControllerProvider.FromGameController(Windows.Gaming.Input.IGameController)
3-
-api-type: winrt method
4-
---
5-
6-
<!-- Method syntax.
7-
public LegacyGipGameControllerProvider LegacyGipGameControllerProvider.FromGameController(IGameController controller)
8-
-->
9-
10-
# Windows.Gaming.Input.Preview.LegacyGipGameControllerProvider.FromGameController
11-
12-
## -description
13-
14-
Constructs a [LegacyGipGameControllerProvider](legacygipgamecontrollerprovider.md) for the given controller.
15-
16-
## -parameters
17-
18-
### -param controller
19-
20-
Controller to construct a LegacyGipGameControllerProvider for.
21-
22-
## -returns
23-
24-
A LegacyGipGameControllerProvider if the controller is a GIP controller. Null if the controller is not a GIP controller.
25-
26-
## -remarks
27-
28-
## -examples
29-
30-
:::code language="csharp" source="code/csharp/EnumerateControllerPropertiesSample.cs":::
31-
32-
## -see-also
33-
34-
[LegacyGipGameControllerProvider](legacygipgamecontrollerprovider.md)
1+
---
2+
-api-id: M:Windows.Gaming.Input.Preview.LegacyGipGameControllerProvider.FromGameController(Windows.Gaming.Input.IGameController)
3+
-api-type: winrt method
4+
---
5+
6+
# Windows.Gaming.Input.Preview.LegacyGipGameControllerProvider.FromGameController(Windows.Gaming.Input.IGameController)
7+
8+
<!--
9+
public static Windows.Gaming.Input.Preview.LegacyGipGameControllerProvider FromGameController (Windows.Gaming.Input.IGameController controller);
10+
-->
11+
12+
## -description
13+
14+
Constructs a [LegacyGipGameControllerProvider](legacygipgamecontrollerprovider.md) for the given controller.
15+
16+
## -parameters
17+
18+
### -param controller
19+
20+
Controller to construct a LegacyGipGameControllerProvider for.
21+
22+
## -returns
23+
24+
A LegacyGipGameControllerProvider if the controller is a GIP controller. Null if the controller is not a GIP controller.
25+
26+
## -remarks
27+
28+
## -see-also
29+
30+
[LegacyGipGameControllerProvider](legacygipgamecontrollerprovider.md)
31+
32+
## -examples
33+
34+
:::code language="csharp" source="code/csharp/EnumerateControllerPropertiesSample.cs":::

windows.gaming.input.preview/legacygipgamecontrollerprovider_fromgamecontrollerprovider.md renamed to windows.gaming.input.preview/legacygipgamecontrollerprovider_fromgamecontrollerprovider_1641665457.md

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
1-
---
2-
-api-id: M:Windows.Gaming.Input.Preview.LegacyGipGameControllerProvider.FromGameControllerProvider(Windows.Gaming.Input.IGameControllerProvider)
3-
-api-type: winrt method
4-
---
5-
6-
<!-- Method syntax.
7-
public LegacyGipGameControllerProvider LegacyGipGameControllerProvider.FromGameControllerProvider(IGameControllerProvider provider)
8-
-->
9-
10-
# Windows.Gaming.Input.Preview.LegacyGipGameControllerProvider.FromGameControllerProvider
11-
12-
## -description
13-
14-
Constructs a [LegacyGipGameControllerProvider](legacygipgamecontrollerprovider.md) for the given controller provider.
15-
16-
## -parameters
17-
18-
### -param provider
19-
20-
Controller provider to construct a LegacyGipGameControllerProvider for.
21-
22-
## -returns
23-
24-
A LegacyGipGameControllerProvider if the controller is a GIP controller. Null if the controller is not a GIP controller.
25-
26-
## -remarks
27-
28-
## -examples
29-
30-
:::code language="csharp" source="code/csharp/HeadsetManagementSample.cs":::
31-
32-
## -see-also
33-
34-
[LegacyGipGameControllerProvider](legacygipgamecontrollerprovider.md)
1+
---
2+
-api-id: M:Windows.Gaming.Input.Preview.LegacyGipGameControllerProvider.FromGameControllerProvider(Windows.Gaming.Input.Custom.IGameControllerProvider)
3+
-api-type: winrt method
4+
---
5+
6+
# Windows.Gaming.Input.Preview.LegacyGipGameControllerProvider.FromGameControllerProvider(Windows.Gaming.Input.Custom.IGameControllerProvider)
7+
8+
<!--
9+
public static Windows.Gaming.Input.Preview.LegacyGipGameControllerProvider FromGameControllerProvider (Windows.Gaming.Input.Custom.IGameControllerProvider provider);
10+
-->
11+
12+
## -description
13+
14+
Constructs a [LegacyGipGameControllerProvider](legacygipgamecontrollerprovider.md) for the given controller provider.
15+
16+
## -parameters
17+
18+
### -param provider
19+
20+
Controller provider to construct a LegacyGipGameControllerProvider for.
21+
22+
## -returns
23+
24+
A LegacyGipGameControllerProvider if the controller is a GIP controller. Null if the controller is not a GIP controller.
25+
26+
## -remarks
27+
28+
## -see-also
29+
30+
[LegacyGipGameControllerProvider](legacygipgamecontrollerprovider.md)
31+
32+
## -examples
33+
34+
:::code language="csharp" source="code/csharp/HeadsetManagementSample.cs":::

windows.gaming.input.preview/legacygipgamecontrollerprovider_getdevicefirmwarecorruptionstate.md renamed to windows.gaming.input.preview/legacygipgamecontrollerprovider_getdevicefirmwarecorruptionstate_2021274220.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
1-
---
2-
-api-id: M:Windows.Gaming.Input.Preview.LegacyGipGameControllerProvider.GetDeviceFirmwareCorruptionState()
3-
-api-type: winrt method
4-
---
5-
6-
<!-- Method syntax.
7-
public GameControllerFirmwareCorruptReason LegacyGipGameControllerProvider.GetDeviceFirmwareCorruptionState()
8-
-->
9-
10-
# Windows.Gaming.Input.Preview.LegacyGipGameControllerProvider.GetDeviceFirmwareCorruptionState
11-
12-
## -description
13-
14-
Gets the state of whether the device's firmware is corrupted and if so, in what way. See [GameControllerFirmwareCorruptReason](gamecontrollerfirmwarecorruptreason.md) for details.
15-
16-
## -parameters
17-
18-
## -returns
19-
20-
The state of whether the device's firmware is corrupted and if so, in what way.
21-
22-
## -remarks
23-
24-
This should be used rather than ```IsFirmwareCorrupted``` for most devices as it is supported by most devices. ```IsFirmwareCorrupted``` is only supported by older devices and should only be used if ```GetDeviceFirmwareCorruptionState``` is not supported.
25-
26-
> [!CAUTION]
27-
> To avoid damaging devices, the firmware corruption and update APIs should only be used with hardware you have developed.
28-
29-
## -examples
30-
31-
:::code language="csharp" source="code/csharp/EnumerateControllerPropertiesSample.cs":::
32-
33-
## -see-also
1+
---
2+
-api-id: M:Windows.Gaming.Input.Preview.LegacyGipGameControllerProvider.GetDeviceFirmwareCorruptionState
3+
-api-type: winrt method
4+
---
5+
6+
# Windows.Gaming.Input.Preview.LegacyGipGameControllerProvider.GetDeviceFirmwareCorruptionState
7+
8+
<!--
9+
public Windows.Gaming.Input.Preview.GameControllerFirmwareCorruptReason GetDeviceFirmwareCorruptionState ();
10+
-->
11+
12+
## -description
13+
14+
Retrieves the state of whether the device's firmware is corrupted and if so, in what way.
15+
16+
## -returns
17+
18+
The state of whether the device's firmware is corrupted and if so, in what way.
19+
20+
## -remarks
21+
22+
This should be used rather than ```IsFirmwareCorrupted``` for most devices as it is supported by most devices. ```IsFirmwareCorrupted``` is only supported by older devices and should only be used if ```GetDeviceFirmwareCorruptionState``` is not supported.
23+
24+
> [!CAUTION]
25+
> To avoid damaging devices, the firmware corruption and update APIs should only be used with hardware you have developed.
26+
27+
## -see-also
28+
29+
[GameControllerFirmwareCorruptReason](gamecontrollerfirmwarecorruptreason.md)
30+
31+
## -examples
32+
33+
:::code language="csharp" source="code/csharp/EnumerateControllerPropertiesSample.cs":::

windows.gaming.input.preview/legacygipgamecontrollerprovider_getextendeddeviceinfo.md renamed to windows.gaming.input.preview/legacygipgamecontrollerprovider_getextendeddeviceinfo_262080953.md

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,26 @@
1-
---
2-
-api-id: M:Windows.Gaming.Input.Preview.LegacyGipGameControllerProvider.GetExtendedDeviceInfo()
3-
-api-type: winrt method
4-
---
5-
6-
<!-- Method syntax.
7-
public byte[] LegacyGipGameControllerProvider.GetExtendedDeviceInfo()
8-
-->
9-
10-
# Windows.Gaming.Input.Preview.LegacyGipGameControllerProvider.GetExtendedDeviceInfo
11-
12-
## -description
13-
14-
Returns identification information for the device.
15-
16-
## -returns
17-
18-
An array of GIP device information provided by the device.
19-
20-
## -examples
21-
22-
:::code language="csharp" source="code/csharp/EnumerateControllerPropertiesSample.cs":::
23-
24-
## -see-also
1+
---
2+
-api-id: M:Windows.Gaming.Input.Preview.LegacyGipGameControllerProvider.GetExtendedDeviceInfo
3+
-api-type: winrt method
4+
---
5+
6+
# Windows.Gaming.Input.Preview.LegacyGipGameControllerProvider.GetExtendedDeviceInfo
7+
8+
<!--
9+
public byte[] GetExtendedDeviceInfo ();
10+
-->
11+
12+
## -description
13+
14+
Retrieves identification information for the device.
15+
16+
## -returns
17+
18+
An array of GIP device information provided by the device.
19+
20+
## -remarks
21+
22+
## -see-also
23+
24+
## -examples
25+
26+
:::code language="csharp" source="code/csharp/EnumerateControllerPropertiesSample.cs":::

0 commit comments

Comments
 (0)