CDynamicOutputPin.ChangeOutputFormat method

  • Article

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The ChangeOutputFormat method dynamically changes the media type for the connection, and delivers new segment information. The change can occur while the filter graph is running. Once this method is called, samples with the old media type cannot be delivered. The caller must ensure that no old samples are pending.

Syntax

HRESULT ChangeOutputFormat(
   const AM_MEDIA_TYPE  *pmt,
         REFERENCE_TIME tSegmentStart,
         REFERENCE_TIME tSegmentStop,
         double         dSegmentRate
);

Parameters

pmt

Pointer to an AM_MEDIA_TYPE structure that specifies the media type.

tSegmentStart

Start time of the segment.

tSegmentStop

Stop time of the segment.

dSegmentRate

Segment rate.

Return value

Returns an HRESULT value. Possible values include those shown in the following table.

Return code Description
S_OK
 Success.
E_FAIL
 Failure. Possibly the owning filter did not call CDynamicOutputPin::SetConfigInfo.
VFW_E_NOT_CONNECTED
 The pin is not connected.

Remarks

This method changes the format type while the filter is running. If the downstream pin accepts the new format, no reconnection is necessary. Otherwise, the method attempts to reconnect the pin. If the method successfully changes the format, it delivers the new segment information. This method calls the CDynamicOutputPin::ChangeMediaType method to perform the format change.

You must call the CDynamicOutputPin::StartUsingOutputPin method before calling this method.

Requirements

Requirement Value
Header
Amfilter.h (include Streams.h)
Library
Strmbase.lib (retail builds);
Strmbasd.lib (debug builds)

See also

CDynamicOutputPin Class