IRenderingControl::SetVolume (Windows CE 5.0)
This method sets the current volume for the specified channel in this RenderingControl instance.
virtual DWORD SetVolume( LPCWSTR pszChannel, unsigned short Volume) = 0;
Parameters
- pszChannel
[in] Audio channel to set. For example, Master, LF (left front), RF (right front), and so on. Corresponds to the A_ARG_TYPE_Channel state variable. - Volume
[in] Volume setting for the specified channel in this RenderingControl instance. Ranges from 0 (silent) to a device-specific maximum value. A change of one unit is the most granular volume change supported by the device. Corresponds to the Volume state variable.
Return Values
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 SetVolume 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
OS Versions: Windows CE 5.0 and later.
Header: Av_upnp.h.
Link Library: Av_upnp.lib.
C++ Namespace: av_upnp.
See Also
IRenderingControl | IRenderingControlImpl | UPnPAVError
Send Feedback on this topic to the authors