IAudioSessionControl2::GetProcessId method (audiopolicy.h)

Article
02/22/2024

The GetProcessId method retrieves the process identifier of the audio session.

Syntax

HRESULT GetProcessId(
  [out] DWORD *pRetVal
);

Parameters

[out] pRetVal

Pointer to a DWORD variable that receives the process identifier of the audio session.

Return value

If the method succeeds, it returns S_OK. If it fails, possible return codes include, but are not limited to, the values shown in the following table.

Return value	Description
E_POINTER	pRetVal is NULL.
AUDCLNT_S_NO_SINGLE_PROCESS	The session spans more than one process. In this case, pRetVal receives the initial identifier of the process that created the session. To use this value , include the following definition: `#define AUDCLNT_S_NO_SINGLE_PROCESS AUDCLNT_SUCCESS (0x00d)`
AUDCLNT_E_DEVICE_INVALIDATED	The audio session is disconnected on the default audio device.

Remarks

This method overwrites the value that was passed by the application in pRetVal.

GetProcessId checks whether the audio session has been disconnected on the default device or if the session has switched to another stream. In the case of stream switching, this method transfers state information for the new stream to the session. State information includes volume controls, metadata information (display name, icon path), and the session's property store.

Requirements

Requirement	Value
Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Target Platform	Windows
Header	audiopolicy.h