IMFSpatialAudioObjectBuffer::GetID method

Returns the unique, unsigned 32-bit ID of the spatial audio object represented by the buffer. If SetID method was not previously called, this method returns the invalid object ID, -1 (0xffffffff). The invalid ID indicates that the object buffer is unused and contains invalid data.

Syntax


HRESULT GetID(
  [out] UINT32 *pu32ID
);

Parameters

pu32ID [out]

Pointer to a 32-bit variable where the object ID will be stored.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return codeDescription
S_OK

The method succeeded.

E_POINTER

The supplied pointer is invalid.

 

Requirements

Minimum supported client

Windows 10, version 1703 [desktop apps only]

Minimum supported server

None supported

Header

Mfobjects.h

Library

Mfobjects.lib

See also

IMFSpatialAudioObjectBuffer

 

 

Show: