Microsoft DirectX 8.1 (C++)

IMediaParams::AddEnvelope

The AddEnvelope method adds an envelope to a parameter.

Syntax

HRESULT AddEnvelope(
    DWORD dwParamIndex,
    DWORD cPoints,
    MP_ENVELOPE_SEGMENT *pEnvelope,
);

Parameters

dwParamIndex

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

cPoints

[in] Number of segments in the envelope.

pEnvelope

[in] Pointer to an array of MP_ENVELOPE_SEGMENT structures that define the envelope segments. The size of the array is given in the cPoints parameter.

Return Values

Returns an HRESULT value. Possible values include the following.

Return Code Description
E_INVALIDARG Index out of range.
E_OUTOFMEMEORY Insufficient memory.
E_POINTER NULL pointer argument.
S_OK Success.

Remarks

If the envelope overlaps an existing envelope, the new envelope takes precedence.

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

See Also