IMediaParams::FlushEnvelope

Microsoft DirectX 8.1 (C++)

IMediaParams::FlushEnvelope

The FlushEnvelope method flushes envelope data for a specified parameter over the specified time range.

Syntax

HRESULT FlushEnvelope(
    DWORD dwParamIndex,
    REFERENCE_TIME refTimeStart,
    REFERENCE_TIME refTimeEnd
);

Parameters

dwParamIndex

[in] Zero-based index of the parameter, or DWORD_ALLPARAMS to flush envelope data from every parameter.

refTimeStart

[in] Start time of the envelope data to flush.

refTimeEnd

[in] Stop time of the envelope data to flush.

Return Values

Returns an HRESULT value. Possible values include the following.

Return Code	Description
E_INVALIDARG	Index out of range.
S_OK	Success.

Remarks

If the time span specified by refTimeStart and refTimeEnd overlaps an envelope segment, the entire segment is flushed. On the other hand, if it falls on the boundary of an envelope segment, the entire segment is retained. Thus:

If the start time falls inside an envelope segment, the segment is flushed.
If the end time falls inside an envelope segment, the segment is flushed.
If the start time equals the end time of an envelope segment, the segment is retained.
If the end time equals the start time of an envelope segment, the segment is retained.

To enumerate the parameters supported by this object, along with their index values, use the IMediaParamInfo interface.

See Also