Skip to content

Latest commit

 

History

History
110 lines (91 loc) · 5.69 KB

nf-audioengineendpoint-iaudioinputendpointrt-getinputdatapointer.md

File metadata and controls

110 lines (91 loc) · 5.69 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:audioengineendpoint.IAudioInputEndpointRT.GetInputDataPointer
IAudioInputEndpointRT::GetInputDataPointer (audioengineendpoint.h)
Gets a pointer to the buffer from which data will be read by the audio engine.
GetInputDataPointer
GetInputDataPointer method [Remote Desktop Services]
GetInputDataPointer method [Remote Desktop Services]
IAudioInputEndpointRT interface
IAudioInputEndpointRT interface [Remote Desktop Services]
GetInputDataPointer method
IAudioInputEndpointRT.GetInputDataPointer
IAudioInputEndpointRT::GetInputDataPointer
audioengineendpoint/IAudioInputEndpointRT::GetInputDataPointer
termserv.iaudioinputendpointrt_getinputdatapointer
termserv\iaudioinputendpointrt_getinputdatapointer.htm
TermServ
1da81a49-d421-4643-9be6-b13d45d678f0
12/05/2018
GetInputDataPointer, GetInputDataPointer method [Remote Desktop Services], GetInputDataPointer method [Remote Desktop Services],IAudioInputEndpointRT interface, IAudioInputEndpointRT interface [Remote Desktop Services],GetInputDataPointer method, IAudioInputEndpointRT.GetInputDataPointer, IAudioInputEndpointRT::GetInputDataPointer, audioengineendpoint/IAudioInputEndpointRT::GetInputDataPointer, termserv.iaudioinputendpointrt_getinputdatapointer
audioengineendpoint.h
Windows
Windows 7
Windows Server 2008 R2
Windows
19H1
IAudioInputEndpointRT::GetInputDataPointer
audioengineendpoint/IAudioInputEndpointRT::GetInputDataPointer
c++
APIRef
kbSyntax
COM
Audioengineendpoint.h
IAudioInputEndpointRT.GetInputDataPointer

IAudioInputEndpointRT::GetInputDataPointer

-description

The GetInputDataPointer method gets a pointer to the buffer from which data will be read by the audio engine.

-parameters

-param pConnectionProperty [in, out]

A pointer to an APO_CONNECTION_PROPERTY structure.

The caller sets the member values as follows:

  • pBuffer is set to NULL.
  • u32ValidFrameCount contains the number of frames that need to be in the retrieved data pointer. The endpoint object must not cache this information. The audio engine can change this number depending on its processing needs.
  • u32BufferFlags is set to BUFFER_INVALID.
If this call completes successfully, the endpoint must set the member values as follows:
  • pBuffer points to valid memory where the data has been read. This could include silence depending on the flags that were set in the u32BufferFlags member.
  • u32ValidFrameCount is unchanged.
  • u32BufferFlags is set to BUFFER_VALID if the data pointer contains valid data or to BUFFER_SILENT if the data pointer contains only silent data. The data in the buffer does not actually need to be silence, but the buffer specified in pBuffer must be capable of holding all the frames of silence contained in u32ValidFrameCount to match the required frame count.

-param pAeTimeStamp [in, out]

A pointer to an AE_CURRENT_POSITION structure that contains the time stamp of the data that is captured in the buffer. This parameter is optional.

-remarks

This method returns a pointer from the endpoint to the buffer pConnectionProperty->pBuffer, which contains data that needs to be passed into the engine as input. The data and the buffer pointer must remain valid until the IAudioInputEndpointRT::ReleaseInputDataPointer method is called. The endpoint object must set the requested amount of information and insert silence if no valid data exists. The buffer pointer, pConnectionProperty->pBuffer, returned by the endpoint object must be frame aligned. Endpoints do not support the extra space, which may be available in the APO_CONNECTION_PROPERTY associated with the connection properties passed in the pConnectionProperty parameter.

Passing zero in the u32ValidFrameCount member is a valid request. In this case, the input pointer must be valid but the endpoint does not read from it. The pConnectionProperty->u32ValidFrameCount value must be less than or equal to the maximum frame count supported by the endpoint. To get the supported number of frames, call 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.

-see-also

IAudioInputEndpointRT