Skip to content

Update the documentation to use Experimental API #5464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Ju-MsGit wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update the documentation to use Experimental API #5464

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8b48a9e
Update the documentation to use exeprimental API
Dec 15, 2025
24cdf7c
Address review comment to add stable API
Dec 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 31 additions & 25 deletions specs/WebRtcPortConfiguration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,19 @@ Usage steps:
# Examples
### C++ Configure UDP Port Range
```cpp
Microsoft::WRL::ComPtr<ICoreWebView2StagingEnvironmentOptions10> optionsStaging10;
if (options.As(&optionsStaging10) == S_OK)
Microsoft::WRL::ComPtr<ICoreWebView2EnvironmentOptions> environmentOptions;
if (options.As(&environmentOptions) == S_OK)
{
// Configure port ranges for UDP traffic to work within enterprise firewalls
// Set UDP port range (example: 50000-55000 for enterprise environments)
const INT32 udpMin = 50000, udpMax = 55000;

CHECK_FAILURE(optionsStaging10->SetAllowedPortRange(
CHECK_FAILURE(environmentOptions->SetAllowedPortRange(
COREWEBVIEW2_ALLOWED_PORT_RANGE_SCOPE_DEFAULT,
COREWEBVIEW2_TRANSPORT_PROTOCOL_KIND_UDP, udpMin, udpMax));

// Get the configured port range
CHECK_FAILURE(optionsStaging10->GetEffectiveAllowedPortRange(
CHECK_FAILURE(environmentOptions->GetEffectiveAllowedPortRange(
COREWEBVIEW2_ALLOWED_PORT_RANGE_SCOPE_DEFAULT,
COREWEBVIEW2_TRANSPORT_PROTOCOL_KIND_UDP, &m_udpPortRange.minPort,
&m_udpPortRange.maxPort));
Expand All @@ -56,28 +56,34 @@ HRESULT hr = CreateCoreWebView2EnvironmentWithOptions(

### C# Configure UDP Port Range
```csharp
var options = CoreWebView2Environment.CreateCoreWebView2EnvironmentOptions();
var optionsStaging10 = options as ICoreWebView2StagingEnvironmentOptions10;
if (optionsStaging10 != null)
{
// Configure port ranges for UDP traffic to work within enterprise firewalls
// Set UDP port range (example: 50000-55000 for enterprise environments)
const int udpMin = 50000, udpMax = 55000;

optionsStaging10.SetAllowedPortRange(
COREWEBVIEW2_ALLOWED_PORT_RANGE_SCOPE_DEFAULT,
COREWEBVIEW2_TRANSPORT_PROTOCOL_KIND_UDP, udpMin, udpMax);
CoreWebView2EnvironmentOptions options = new CoreWebView2EnvironmentOptions();

// Get the configured port range
optionsStaging10.GetEffectiveAllowedPortRange(
COREWEBVIEW2_ALLOWED_PORT_RANGE_SCOPE_DEFAULT,
COREWEBVIEW2_TRANSPORT_PROTOCOL_KIND_UDP, out m_udpPortRange.minPort,
out m_udpPortRange.maxPort);
try
{
// Set allowed port range for WebRTC UDP traffic (example: ports 10000-20000)
options.SetAllowedPortRange(
CoreWebView2AllowedPortRangeScope.WebRtc,
CoreWebView2TransportProtocolKind.Udp,
10000,
20000);

}
catch (Exception ex)
{
// Handle any errors setting the port range
System.Diagnostics.Debug.WriteLine($"Failed to set WebRTC UDP port range: {ex.Message}");
}
string browserExecutableFolder = null;
if (webView2.CreationProperties?.BrowserExecutableFolder != null)
{
browserExecutableFolder = webView2.CreationProperties.BrowserExecutableFolder;
}

CoreWebView2Environment environment = await CoreWebView2Environment.CreateAsync(browserExecutableFolder, null, options);

var environment = await CoreWebView2Environment.CreateAsync(
subFolder, m_userDataFolder, options);
OnCreateEnvironmentCompleted(environment);
// Configure WebRTC UDP port range if experimental API is available
await webView2.EnsureCoreWebView2Async(environment);
```

API Rules and Precedence
Expand Down Expand Up @@ -133,7 +139,7 @@ typedef enum COREWEBVIEW2_TRANSPORT_PROTOCOL_KIND {

/// Additional options used to create WebView2 Environment to manage port range configuration.
[uuid(2c0f597d-2958-5a94-82f9-c750cf86cb88), object, pointer_default(unique)]
interface ICoreWebView2StagingEnvironmentOptions10 : IUnknown {
interface ICoreWebView2ExperimentalEnvironmentOptions : IUnknown {
/// Sets the allowed port range restriction for the specified
/// scope and transport protocol.
///
Expand Down Expand Up @@ -227,9 +233,9 @@ namespace Microsoft.Web.WebView2.Core

runtimeclass CoreWebView2EnvironmentOptions
{
[interface_name("Microsoft.Web.WebView2.Core.ICoreWebView2StagingEnvironmentOptions10")]
[interface_name("Microsoft.Web.WebView2.Core.ICoreWebView2ExperimentalEnvironmentOptions")]
{
// ICoreWebView2StagingEnvironmentOptions10 members
// ICoreWebView2ExperimentalEnvironmentOptions members
void SetAllowedPortRange(CoreWebview2AllowedPortRangeScope scope, CoreWebView2TransportProtocolKind protocol, Int32 minPort, Int32 maxPort);
void GetEffectiveAllowedPortRange(CoreWebview2AllowedPortRangeScope scope, CoreWebView2TransportProtocolKind protocol, out Int32 minPort, out Int32 maxPort);
}
Expand Down