IRenderingControl::GetLoudness
A version of this page is also available for
4/8/2010
This method returns the current loudness setting for the specified channel in this RenderingControl instance.
Syntax
virtual DWORD GetLoudness(
LPCWSTR pszChannel,
bool* pLoudness
) = 0;
Parameters
- pszChannel
[in] Audio channel to examine. For example, Master, LF (left front), RF (right front), and so on. Corresponds to the A_ARG_TYPE_Channel state variable.
- pLoudness
[in, out] Loudness setting for the specified channel in this RenderingControl instance. Corresponds to the Loudness state variable.
Return Value
Custom implementations can return appropriate error codes. Should return SUCCESS_AV if the method succeeds. Otherwise, should return an error code defined in WinError.h or UPnP.h, or one of the UPnP AV-specific return values specified in UPnPAVError, especially the following errors documented for this action in the RenderingControl DCP documentation:
- ERROR_AV_UPNP_ACTION_FAILED
- ERROR_AV_UPNP_RC_INVALID_INSTANCE_ID
Remarks
This method corresponds to the RenderingControl service's GetLoudness action.
The RenderingControl service does not require that this method be implemented. The IRenderingControlImpl class therefore overrides this method to return ERROR_AV_UPNP_INVALID_ACTION.
For more information about the actions in the RenderingControl service, see UPnP AV DCP Documentation.
Requirements
| Header | av_upnp.h |
| Library | Av_upnp.lib |
| Windows Embedded CE | Windows CE 5.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |