Wwise SDK 2023.1.5

◆ GetCount()

virtual int AK.Wwise::Plugin::V1::SinkDevices::GetCount ( ) const
pure virtual

Get a count of the number of interfaces currently available.

Provided by your plug-in, this should return a count.

Note: Due to the unpredictable nature of hardware configuration changes, an unpadded, basic system would return a configuration that can change between a GetCount and subsequent objects retrieval.

As a plug-in designer, you are responsible to address this by returning adequate values that make sense as a whole.

To guide you, Sink Devices interface is used for retrieval and data copy in a tight loop over a single thread at once. Host will retrieve the count, followed by the Name (GetName) and DeviceID (GetDeviceID), in the order the compiler sees fit. Data is expected to survive for the amount of time this tight loop exists.

int count = m_interface->GetCount(m_instance);
for (int i = 0; i < count; ++i)
m_interface->GetName(m_instance, i),
m_interface->GetDeviceID(m_instance, i)

A proposal is to use GetCount to internally retrieve the device names and IDs, make a static internal cache, and then return name and device ID based on this cache.

You can also spawn an event listener or an update thread, and ensure the data is up to date when the calls come in, and block updates until all calls are accounted for.

int Count of the number of interfaces available.

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise