Edit

IAudioInputEndpointRT::ReleaseInputDataPointer method (audioengineendpoint.h)

  • Article

The ReleaseInputDataPointer method releases the acquired data pointer.

Syntax

void ReleaseInputDataPointer(
  [in] UINT32   u32FrameCount,
  [in] UINT_PTR pDataPointer
);

Parameters

[in] u32FrameCount

The number of frames that have been consumed by the audio engine. This count might not be the same as the value returned by the IAudioInputEndpointRT::GetInputDataPointer method in the pConnectionProperty->u32ValidFrameCount member.

[in] pDataPointer

The pointer to the buffer retrieved by the GetInputDataPointer method received in the pConnectionProperty->pBuffer member.

Return value

None

Remarks

ReleaseInputDataPointer notifies the endpoint that the audio engine no longer requires the input data pointer and also indicates the number of frames used during the session. For example, an endpoint, which represents a looped buffer, is connected to the input of the audio engine and can advance its read pointer by using the actual frame count. If u32FrameCount is zero, this indicates that the client did not use any data from the specified input buffer. The u32FrameCount must be less than or equal to the maximum frame count supported by the endpoint. To get the supported number of frames, the audio engine calls the IAudioEndpoint::GetFramesPerPacket method.

This method can be called from a real-time processing thread. The implementation of this method must not block, access paged memory, or call any blocking system routines.

The Remote Desktop Services AudioEndpoint API is for use in Remote Desktop scenarios; it is not for client applications.

Requirements

Requirement Value
Minimum supported client Windows 7
Minimum supported server Windows Server 2008 R2
Target Platform Windows
Header audioengineendpoint.h

See also

IAudioInputEndpointRT