interface ICoreWebView2Experimental9
Note
This reference is no longer being maintained. For the latest API reference, see WebView2 API Reference.
Note
This an experimental API that is shipped with our prerelease SDK. See WebView2 release notes.
interface ICoreWebView2Experimental9
: public IUnknown
This interface is an extension of ICoreWebView2.
Summary
| Members | Descriptions |
|---|---|
| add_IsDocumentPlayingAudioChanged | Adds an event handler for the IsDocumentPlayingAudioChanged event. |
| add_IsMutedChanged | Adds an event handler for the IsMutedChanged event. |
| get_IsDocumentPlayingAudio | Indicates whether any audio output from this CoreWebView2 is playing. |
| get_IsMuted | Indicates whether all audio output from this CoreWebView2 is muted or not. |
| put_IsMuted | Sets the IsMuted property. |
| remove_IsDocumentPlayingAudioChanged | Remove an event handler previously added with add_IsDocumentPlayingAudioChanged. |
| remove_IsMutedChanged | Remove an event handler previously added with add_IsMutedChanged. |
Applies to
| Product | Introduced |
|---|---|
| WebView2 Win32 | N/A |
| WebView2 Win32 Prerelease | 1.0.1018 |
Members
add_IsDocumentPlayingAudioChanged
Adds an event handler for the IsDocumentPlayingAudioChanged event.
public HRESULT add_IsDocumentPlayingAudioChanged(ICoreWebView2ExperimentalIsDocumentPlayingAudioChangedEventHandler * eventHandler, EventRegistrationToken * token)
IsDocumentPlayingAudioChanged is raised when the IsDocumentPlayingAudio property changes value.
AudioComponent::AudioComponent(AppWindow* appWindow)
: m_appWindow(appWindow), m_webView(appWindow->GetWebView())
{
auto webviewExperimental9 = m_webView.try_query<ICoreWebView2Experimental9>();
if (webviewExperimental9)
{
// Register a handler for the IsDocumentPlayingAudioChanged event.
CHECK_FAILURE(webviewExperimental9->add_IsDocumentPlayingAudioChanged(
Callback<ICoreWebView2ExperimentalIsDocumentPlayingAudioChangedEventHandler>(
[this, webviewExperimental9](ICoreWebView2* sender, IUnknown* args) -> HRESULT {
UpdateTitleWithMuteState(webviewExperimental9);
return S_OK;
})
.Get(),
&m_isDocumentPlayingAudioChangedToken));
// Register a handler for the IsMutedChanged event.
CHECK_FAILURE(webviewExperimental9->add_IsMutedChanged(
Callback<ICoreWebView2ExperimentalIsMutedChangedEventHandler>(
[this, webviewExperimental9](ICoreWebView2* sender, IUnknown* args) -> HRESULT {
UpdateTitleWithMuteState(webviewExperimental9);
return S_OK;
})
.Get(),
&m_isMutedChangedToken));
}
}
bool AudioComponent::HandleWindowMessage(
HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam, LRESULT* result)
{
if (message == WM_COMMAND)
{
switch (LOWORD(wParam))
{
case IDM_TOGGLE_MUTE_STATE:
ToggleMuteState();
return true;
}
}
return false;
}
// Toggle the mute state of the current window and show a mute or unmute icon on the title bar
void AudioComponent::ToggleMuteState()
{
auto webviewExperimental9 = m_webView.try_query<ICoreWebView2Experimental9>();
if (webviewExperimental9)
{
BOOL isMuted;
CHECK_FAILURE(webviewExperimental9->get_IsMuted(&isMuted));
CHECK_FAILURE(webviewExperimental9->put_IsMuted(!isMuted));
}
}
void AudioComponent::UpdateTitleWithMuteState(
wil::com_ptr<ICoreWebView2Experimental9> webviewExperimental9)
{
BOOL isDocumentPlayingAudio;
CHECK_FAILURE(webviewExperimental9->get_IsDocumentPlayingAudio(&isDocumentPlayingAudio));
BOOL isMuted;
CHECK_FAILURE(webviewExperimental9->get_IsMuted(&isMuted));
wil::unique_cotaskmem_string title;
CHECK_FAILURE(m_webView->get_DocumentTitle(&title));
std::wstring result = L"";
if (isDocumentPlayingAudio)
{
if (isMuted)
{
result = L"???? " + std::wstring(title.get());
}
else
{
result = L"???? " + std::wstring(title.get());
}
}
else
{
result = std::wstring(title.get());
}
m_appWindow->SetDocumentTitle(result.c_str());
}
add_IsMutedChanged
Adds an event handler for the IsMutedChanged event.
public HRESULT add_IsMutedChanged(ICoreWebView2ExperimentalIsMutedChangedEventHandler * eventHandler, EventRegistrationToken * token)
IsMutedChanged is raised when the IsMuted property changes value.
AudioComponent::AudioComponent(AppWindow* appWindow)
: m_appWindow(appWindow), m_webView(appWindow->GetWebView())
{
auto webviewExperimental9 = m_webView.try_query<ICoreWebView2Experimental9>();
if (webviewExperimental9)
{
// Register a handler for the IsDocumentPlayingAudioChanged event.
CHECK_FAILURE(webviewExperimental9->add_IsDocumentPlayingAudioChanged(
Callback<ICoreWebView2ExperimentalIsDocumentPlayingAudioChangedEventHandler>(
[this, webviewExperimental9](ICoreWebView2* sender, IUnknown* args) -> HRESULT {
UpdateTitleWithMuteState(webviewExperimental9);
return S_OK;
})
.Get(),
&m_isDocumentPlayingAudioChangedToken));
// Register a handler for the IsMutedChanged event.
CHECK_FAILURE(webviewExperimental9->add_IsMutedChanged(
Callback<ICoreWebView2ExperimentalIsMutedChangedEventHandler>(
[this, webviewExperimental9](ICoreWebView2* sender, IUnknown* args) -> HRESULT {
UpdateTitleWithMuteState(webviewExperimental9);
return S_OK;
})
.Get(),
&m_isMutedChangedToken));
}
}
bool AudioComponent::HandleWindowMessage(
HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam, LRESULT* result)
{
if (message == WM_COMMAND)
{
switch (LOWORD(wParam))
{
case IDM_TOGGLE_MUTE_STATE:
ToggleMuteState();
return true;
}
}
return false;
}
// Toggle the mute state of the current window and show a mute or unmute icon on the title bar
void AudioComponent::ToggleMuteState()
{
auto webviewExperimental9 = m_webView.try_query<ICoreWebView2Experimental9>();
if (webviewExperimental9)
{
BOOL isMuted;
CHECK_FAILURE(webviewExperimental9->get_IsMuted(&isMuted));
CHECK_FAILURE(webviewExperimental9->put_IsMuted(!isMuted));
}
}
void AudioComponent::UpdateTitleWithMuteState(
wil::com_ptr<ICoreWebView2Experimental9> webviewExperimental9)
{
BOOL isDocumentPlayingAudio;
CHECK_FAILURE(webviewExperimental9->get_IsDocumentPlayingAudio(&isDocumentPlayingAudio));
BOOL isMuted;
CHECK_FAILURE(webviewExperimental9->get_IsMuted(&isMuted));
wil::unique_cotaskmem_string title;
CHECK_FAILURE(m_webView->get_DocumentTitle(&title));
std::wstring result = L"";
if (isDocumentPlayingAudio)
{
if (isMuted)
{
result = L"???? " + std::wstring(title.get());
}
else
{
result = L"???? " + std::wstring(title.get());
}
}
else
{
result = std::wstring(title.get());
}
m_appWindow->SetDocumentTitle(result.c_str());
}
get_IsDocumentPlayingAudio
Indicates whether any audio output from this CoreWebView2 is playing.
public HRESULT get_IsDocumentPlayingAudio(BOOL * value)
This property will be true if audio is playing even if IsMuted is true.
AudioComponent::AudioComponent(AppWindow* appWindow)
: m_appWindow(appWindow), m_webView(appWindow->GetWebView())
{
auto webviewExperimental9 = m_webView.try_query<ICoreWebView2Experimental9>();
if (webviewExperimental9)
{
// Register a handler for the IsDocumentPlayingAudioChanged event.
CHECK_FAILURE(webviewExperimental9->add_IsDocumentPlayingAudioChanged(
Callback<ICoreWebView2ExperimentalIsDocumentPlayingAudioChangedEventHandler>(
[this, webviewExperimental9](ICoreWebView2* sender, IUnknown* args) -> HRESULT {
UpdateTitleWithMuteState(webviewExperimental9);
return S_OK;
})
.Get(),
&m_isDocumentPlayingAudioChangedToken));
// Register a handler for the IsMutedChanged event.
CHECK_FAILURE(webviewExperimental9->add_IsMutedChanged(
Callback<ICoreWebView2ExperimentalIsMutedChangedEventHandler>(
[this, webviewExperimental9](ICoreWebView2* sender, IUnknown* args) -> HRESULT {
UpdateTitleWithMuteState(webviewExperimental9);
return S_OK;
})
.Get(),
&m_isMutedChangedToken));
}
}
bool AudioComponent::HandleWindowMessage(
HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam, LRESULT* result)
{
if (message == WM_COMMAND)
{
switch (LOWORD(wParam))
{
case IDM_TOGGLE_MUTE_STATE:
ToggleMuteState();
return true;
}
}
return false;
}
// Toggle the mute state of the current window and show a mute or unmute icon on the title bar
void AudioComponent::ToggleMuteState()
{
auto webviewExperimental9 = m_webView.try_query<ICoreWebView2Experimental9>();
if (webviewExperimental9)
{
BOOL isMuted;
CHECK_FAILURE(webviewExperimental9->get_IsMuted(&isMuted));
CHECK_FAILURE(webviewExperimental9->put_IsMuted(!isMuted));
}
}
void AudioComponent::UpdateTitleWithMuteState(
wil::com_ptr<ICoreWebView2Experimental9> webviewExperimental9)
{
BOOL isDocumentPlayingAudio;
CHECK_FAILURE(webviewExperimental9->get_IsDocumentPlayingAudio(&isDocumentPlayingAudio));
BOOL isMuted;
CHECK_FAILURE(webviewExperimental9->get_IsMuted(&isMuted));
wil::unique_cotaskmem_string title;
CHECK_FAILURE(m_webView->get_DocumentTitle(&title));
std::wstring result = L"";
if (isDocumentPlayingAudio)
{
if (isMuted)
{
result = L"???? " + std::wstring(title.get());
}
else
{
result = L"???? " + std::wstring(title.get());
}
}
else
{
result = std::wstring(title.get());
}
m_appWindow->SetDocumentTitle(result.c_str());
}
get_IsMuted
Indicates whether all audio output from this CoreWebView2 is muted or not.
public HRESULT get_IsMuted(BOOL * value)
AudioComponent::AudioComponent(AppWindow* appWindow)
: m_appWindow(appWindow), m_webView(appWindow->GetWebView())
{
auto webviewExperimental9 = m_webView.try_query<ICoreWebView2Experimental9>();
if (webviewExperimental9)
{
// Register a handler for the IsDocumentPlayingAudioChanged event.
CHECK_FAILURE(webviewExperimental9->add_IsDocumentPlayingAudioChanged(
Callback<ICoreWebView2ExperimentalIsDocumentPlayingAudioChangedEventHandler>(
[this, webviewExperimental9](ICoreWebView2* sender, IUnknown* args) -> HRESULT {
UpdateTitleWithMuteState(webviewExperimental9);
return S_OK;
})
.Get(),
&m_isDocumentPlayingAudioChangedToken));
// Register a handler for the IsMutedChanged event.
CHECK_FAILURE(webviewExperimental9->add_IsMutedChanged(
Callback<ICoreWebView2ExperimentalIsMutedChangedEventHandler>(
[this, webviewExperimental9](ICoreWebView2* sender, IUnknown* args) -> HRESULT {
UpdateTitleWithMuteState(webviewExperimental9);
return S_OK;
})
.Get(),
&m_isMutedChangedToken));
}
}
bool AudioComponent::HandleWindowMessage(
HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam, LRESULT* result)
{
if (message == WM_COMMAND)
{
switch (LOWORD(wParam))
{
case IDM_TOGGLE_MUTE_STATE:
ToggleMuteState();
return true;
}
}
return false;
}
// Toggle the mute state of the current window and show a mute or unmute icon on the title bar
void AudioComponent::ToggleMuteState()
{
auto webviewExperimental9 = m_webView.try_query<ICoreWebView2Experimental9>();
if (webviewExperimental9)
{
BOOL isMuted;
CHECK_FAILURE(webviewExperimental9->get_IsMuted(&isMuted));
CHECK_FAILURE(webviewExperimental9->put_IsMuted(!isMuted));
}
}
void AudioComponent::UpdateTitleWithMuteState(
wil::com_ptr<ICoreWebView2Experimental9> webviewExperimental9)
{
BOOL isDocumentPlayingAudio;
CHECK_FAILURE(webviewExperimental9->get_IsDocumentPlayingAudio(&isDocumentPlayingAudio));
BOOL isMuted;
CHECK_FAILURE(webviewExperimental9->get_IsMuted(&isMuted));
wil::unique_cotaskmem_string title;
CHECK_FAILURE(m_webView->get_DocumentTitle(&title));
std::wstring result = L"";
if (isDocumentPlayingAudio)
{
if (isMuted)
{
result = L"???? " + std::wstring(title.get());
}
else
{
result = L"???? " + std::wstring(title.get());
}
}
else
{
result = std::wstring(title.get());
}
m_appWindow->SetDocumentTitle(result.c_str());
}
put_IsMuted
Sets the IsMuted property.
public HRESULT put_IsMuted(BOOL value)
AudioComponent::AudioComponent(AppWindow* appWindow)
: m_appWindow(appWindow), m_webView(appWindow->GetWebView())
{
auto webviewExperimental9 = m_webView.try_query<ICoreWebView2Experimental9>();
if (webviewExperimental9)
{
// Register a handler for the IsDocumentPlayingAudioChanged event.
CHECK_FAILURE(webviewExperimental9->add_IsDocumentPlayingAudioChanged(
Callback<ICoreWebView2ExperimentalIsDocumentPlayingAudioChangedEventHandler>(
[this, webviewExperimental9](ICoreWebView2* sender, IUnknown* args) -> HRESULT {
UpdateTitleWithMuteState(webviewExperimental9);
return S_OK;
})
.Get(),
&m_isDocumentPlayingAudioChangedToken));
// Register a handler for the IsMutedChanged event.
CHECK_FAILURE(webviewExperimental9->add_IsMutedChanged(
Callback<ICoreWebView2ExperimentalIsMutedChangedEventHandler>(
[this, webviewExperimental9](ICoreWebView2* sender, IUnknown* args) -> HRESULT {
UpdateTitleWithMuteState(webviewExperimental9);
return S_OK;
})
.Get(),
&m_isMutedChangedToken));
}
}
bool AudioComponent::HandleWindowMessage(
HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam, LRESULT* result)
{
if (message == WM_COMMAND)
{
switch (LOWORD(wParam))
{
case IDM_TOGGLE_MUTE_STATE:
ToggleMuteState();
return true;
}
}
return false;
}
// Toggle the mute state of the current window and show a mute or unmute icon on the title bar
void AudioComponent::ToggleMuteState()
{
auto webviewExperimental9 = m_webView.try_query<ICoreWebView2Experimental9>();
if (webviewExperimental9)
{
BOOL isMuted;
CHECK_FAILURE(webviewExperimental9->get_IsMuted(&isMuted));
CHECK_FAILURE(webviewExperimental9->put_IsMuted(!isMuted));
}
}
void AudioComponent::UpdateTitleWithMuteState(
wil::com_ptr<ICoreWebView2Experimental9> webviewExperimental9)
{
BOOL isDocumentPlayingAudio;
CHECK_FAILURE(webviewExperimental9->get_IsDocumentPlayingAudio(&isDocumentPlayingAudio));
BOOL isMuted;
CHECK_FAILURE(webviewExperimental9->get_IsMuted(&isMuted));
wil::unique_cotaskmem_string title;
CHECK_FAILURE(m_webView->get_DocumentTitle(&title));
std::wstring result = L"";
if (isDocumentPlayingAudio)
{
if (isMuted)
{
result = L"???? " + std::wstring(title.get());
}
else
{
result = L"???? " + std::wstring(title.get());
}
}
else
{
result = std::wstring(title.get());
}
m_appWindow->SetDocumentTitle(result.c_str());
}
remove_IsDocumentPlayingAudioChanged
Remove an event handler previously added with add_IsDocumentPlayingAudioChanged.
public HRESULT remove_IsDocumentPlayingAudioChanged(EventRegistrationToken token)
remove_IsMutedChanged
Remove an event handler previously added with add_IsMutedChanged.
public HRESULT remove_IsMutedChanged(EventRegistrationToken token)
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示