IRenderingControl

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This pure virtual class contains methods that expose the functionality provided by the UPnP AV RenderingControl service. The RenderingControl service is used by MediaRenderer devices to enable control points to access and change device settings that affect playback, like volume, video settings, and so on.

Syntax

class IRenderingControl : public IVirtualService, 
      public IEventSource

Methods

The following table shows the methods for this class. This class also inherits the methods from the IVirtualService and IEventSource classes.

Method	Description
IRenderingControl::GetBlueVideoBlackLevel	Returns the blue video black-level setting of this RenderingControl instance.
IRenderingControl::GetBlueVideoGain	Returns the blue video gain setting of this RenderingControl instance.
IRenderingControl::GetBrightness	Returns the brightness setting of this RenderingControl instance.
IRenderingControl::GetColorTemperature	Returns the color temperature setting of this RenderingControl instance.
IRenderingControl::GetContrast	Returns the contrast setting of this RenderingControl instance.
IRenderingControl::GetGreenVideoBlackLevel	Returns the green video black-level setting of this RenderingControl instance.
IRenderingControl::GetGreenVideoGain	Returns the green video gain setting of this RenderingControl instance.
IRenderingControl::GetHorizontalKeystone	Returns the horizontal keystone setting of this RenderingControl instance.
IRenderingControl::GetLoudness	Returns the current loudness setting for the specified channel in this RenderingControl instance.
IRenderingControl::GetMute	Returns the current mute setting for the specified channel in this RenderingControl instance.
IRenderingControl::GetRedVideoBlackLevel	Returns the red video black-level setting of this RenderingControl instance.
IRenderingControl::GetRedVideoGain	Returns the red video gain setting of this RenderingControl instance.
IRenderingControl::GetSharpness	Returns the sharpness setting of this RenderingControl instance.
IRenderingControl::GetVerticalKeystone	Returns the vertical keystone setting of this RenderingControl instance.
IRenderingControl::GetVolume	Returns the current volume for the specified channel in this RenderingControl instance.
IRenderingControl::GetVolumeDB	Returns the current volume, in units of 1/256 of a decibel, for the specified channel in this RenderingControl instance.
IRenderingControl::GetVolumeDBRange	Returns the decibel volume range supported by the device exposing this RenderingControl instance.
IRenderingControl::InvokeVendorAction	Enables RenderingControl implementations and users to provide and invoke custom vendor-specific actions that are not defined in the RenderingControl DCP.
IRenderingControl::ListPresets	Returns a list of the currently defined presets.
IRenderingControl::SelectPreset	Uses the specified preset to restore a subset of this RenderingControl instance's state variables to the values associated with the preset.
IRenderingControl::SetBlueVideoBlackLevel	Sets the blue video black-level setting of this RenderingControl instance.
IRenderingControl::SetBlueVideoGain	Sets the blue video gain setting of this RenderingControl instance.
IRenderingControl::SetBrightness	Sets the brightness setting of this RenderingControl instance.
IRenderingControl::SetColorTemperature	Sets the color temperature setting of this RenderingControl instance.
IRenderingControl::SetContrast	Sets the contrast setting of this RenderingControl instance.
IRenderingControl::SetGreenVideoBlackLevel	Sets the green video black-level setting of this RenderingControl instance.
IRenderingControl::SetGreenVideoGain	Sets the green video gain setting of this RenderingControl instance.
IRenderingControl::SetHorizontalKeystone	Sets the horizontal keystone setting of this RenderingControl instance.
IRenderingControl::SetLoudness	Sets the current loudness setting for the specified channel in this RenderingControl instance.
IRenderingControl::SetMute	Sets the current mute setting for the specified channel in this RenderingControl instance.
IRenderingControl::SetRedVideoBlackLevel	Sets the red video black-level setting of this RenderingControl instance.
IRenderingControl::SetRedVideoGain	Sets the red video gain setting of this RenderingControl instance.
IRenderingControl::SetSharpness	Sets the sharpness setting of this RenderingControl instance.
IRenderingControl::SetVerticalKeystone	Sets the vertical keystone setting of this RenderingControl instance.
IRenderingControl::SetVolume	Sets the current volume for the specified channel in this RenderingControl instance.
IRenderingControl::SetVolumeDB	Sets the current volume, in units of 1/256 of a decibel, for the specified channel in this RenderingControl instance.

Obtaining a Pointer

This class is used by UPnP MediaRenderer devices and control points.

UPnP MediaRenderer devices implement the methods in this class to make their device hardware and other functionality available to UPnP control points. Rather than deriving directly from this class, devices can inherit from the provided IRenderingControlImpl class, which provides useful implementations for some of the methods in this class.

Control points use this class to control UPnP MediaRenderer devices. A control point obtains a pointer to this class by:

1. Retrieving an IConnectionManager instance using MediaRendererDevice::GetConnectionManager.
2. Calling IConnectionManager::PrepareForConnection to retrieve, among other things, an IRenderingControl reference.

A control point can also retrieve a pointer to a class that implements this interface by calling IConnectionManager::GetCurrentConnectionInfo and then using the pRenderingControl field in the returned ConnectionInfo structure.

Remarks

The methods in this class match the actions in the RenderingControl service, with the exception of IRenderingControl::InvokeVendorAction.

For more information about 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

See Also

Reference

UPnP AV Interface and Implementation Classes
ConnectionInfo
IConnectionManager
IConnectionManager::GetCurrentConnectionInfo
IConnectionManager::PrepareForConnection
IEventSource
IRenderingControlImpl
IVirtualService
MediaRendererDevice::GetConnectionManager