VideoProcessorSetStreamOutputRate function

Sets the rate at which the video processor produces output frames for an input stream.


VOID APIENTRY* VideoProcessorSetStreamOutputRate(
  _In_       D3D10DDI_HDEVICE                       hDevice,
  _In_       D3D11_1DDI_HVIDEOPROCESSOR             hVideoProcessor,
  _In_       UINT                                   StreamIndex,
  _In_       BOOL                                   RepeatFrame,
  _In_ const DXGI_RATIONAL                          *pCustomRate


hDevice [in]

A handle to the display device (graphics context).

hVideoProcessor [in]

A handle to the video processor object that was created through a call to the CreateVideoProcessor function.

StreamIndex [in]

The zero-based index of the input stream.

OutputRate [in]

The output rate, specified as a D3D11_1DDI_VIDEO_PROCESSOR_OUTPUT_RATE value. For more information, see the Remarks section.

RepeatFrame [in]

Specifies how the driver performs frame-rate conversion, if it is required.

If the RepeatFrame parameter is TRUE, the driver should repeat frames.

If the RepeatFrame parameter is FALSE, the driver should interpolate frames.

Note  If the VideoProcessorSetStreamOutputRate function is never called, the driver should interpolate frames by default.
pCustomRate [in]

A pointer to a DXGI_RATIONAL structure. If the OutputRate parameter is set to D3D11_VIDEO_PROCESSOR_OUTPUT_RATE_CUSTOM, this parameter specifies the exact output rate. Otherwise, this parameter is ignored and can be set to NULL.

Return value

This function does not return a value.


The standard output rates that are defined by D3D11_1DDI_VIDEO_PROCESSOR_OUTPUT_RATE enumeration values are normal frame-rate (D3D11_1DDI_VIDEO_PROCESSOR_OUTPUT_RATE_NORMAL) and half frame-rate (D3D11_1DDI_VIDEO_PROCESSOR_OUTPUT_RATE_HALF).

If the driver supports custom rates for rate conversion or inverse telecine, it can use a custom rate if the OutputRate parameter is set to D3D11_1DDI_VIDEO_PROCESSOR_OUTPUT_RATE_CUSTOM. The custom rate is specified by the pCustomRate parameter.

Note  The driver reports its custom rates in the D3D11_1DDI_VIDEO_PROCESSOR_CAPS structure that is returned through the GetVideoProcessorCustomRate function.

Depending on the output rate, the driver might have to convert the frame rate. If so, the value of the RepeatFrame parameter controls whether the driver creates interpolated frames or repeats input frames.


Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Target platform


D3d10umddi.h (include D3d10umddi.h)

See also




Send comments about this topic to Microsoft