SinkDevices

Wwise SDK 2022.1.7

C++ API to provide device enumeration for sink plug-ins. More...

Inheritance diagram for AK.Wwise::Plugin::V1::SinkDevices:

Classes
struct	Interface
	The C interface, fulfilled by your plug-in. More...

Public Types
enum	: InterfaceTypeValue { k_interfaceType = AK_WWISE_PLUGIN_INTERFACE_TYPE_SINK_DEVICES }
	The interface type, as provided by this plug-in. More...

enum	: InterfaceVersion { k_interfaceVersion = 1 }
	The interface version, as provided by this plug-in. More...

using	Instance = CSinkDevices::Instance
	Base instance type for providing a device list for your custom sink through ak_wwise_plugin_sink_devices_v1. More...

Public Member Functions
InterfacePtr	GetInterfacePointer ()

CSinkDevices::Instance *	GetInstancePointer ()

const CSinkDevices::Instance *	GetInstancePointer () const

	SinkDevices ()

virtual	~SinkDevices ()

virtual int	GetCount () const =0
	Get a count of the number of interfaces currently available. More...

virtual const char *	GetName (int in_num) const =0
	Get a user-presentable name for the device number in_num. More...

virtual uint32_t	GetDeviceID (int in_num) const =0
	Get a device ID for the device number in_num. More...

Public Member Functions inherited from ak_wwise_plugin_cpp_base_instance
virtual	~ak_wwise_plugin_cpp_base_instance ()

Detailed Description

C++ API to provide device enumeration for sink plug-ins.

Allows your plug-in to provide a list of up-to-date device IDs that can be used to instantiate a new Sound Engine sink.

This plug-in interface cannot be linked to a backend or a frontend plug-in, it must be standalone.

See also

Definition at line 171 of file SinkDevices.h.

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

Visit our Support page

Get started with Wwise