APO_BUFFER_FLAGS enumeration (audioapotypes.h)

Defines the buffer validation flags for the APO_CONNECTION_PROPERTY structure associated with each APO connection.

Syntax

typedef enum APO_BUFFER_FLAGS {
  BUFFER_INVALID,
  BUFFER_VALID,
  BUFFER_SILENT
} ;

Constants

 
BUFFER_INVALID
There is no valid data in the connection
buffer. The buffer pointer is valid and the buffer is capable of holding the amount of valid audio data specified in the APO_CONNECTION_PROPERTY structure.
While processing audio data, the audio engine marks every connection as BUFFER_INVALID before calling IAudioOutputEndpoint::GetOutputDataPointer or
IAudioInputEndpointRT::GetInputDataPointer.
BUFFER_VALID
The connection buffer contains valid data. This is the operational state of the connection buffer. The APO sets this flag after it
starts writing valid data into the buffer.
Capture endpoints should set this flag in the GetInputDataPointer method upon successful completion of the call.
BUFFER_SILENT
The connection buffer must be treated as if it contains silence.
If the endpoint receives an input connection buffer that is identified as BUFFER_SILENT, then the endpoint can assume the data represents silence. When capturing, the endpoint can also set this flag, if necessary for a capture buffer.

Remarks

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
Header audioapotypes.h