Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.9.8628 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
|
Wwise SDK 2023.1.9
|
ak_wwise_plugin_sink_devices_v1 Struct Reference
Device enumerator for sink plug-ins. More...
#include <SinkDevices.h>
Inheritance diagram for ak_wwise_plugin_sink_devices_v1:
Public Types | |
| using | Instance = ak_wwise_plugin_sink_devices_instance_v1 |
| Base instance type for providing a device list for your custom sink through ak_wwise_plugin_sink_devices_v1. More... | |
Public Member Functions | |
| ak_wwise_plugin_sink_devices_v1 () | |
 Public Member Functions inherited from ak_wwise_plugin_interface_ptr | |
| constexpr | ak_wwise_plugin_base_interface (decltype(m_interface) in_interface, decltype(m_version) in_version) |
| constexpr | ak_wwise_plugin_base_interface () |
| constexpr | ak_wwise_plugin_base_interface (std::underlying_type< decltype(m_interface)>::type in_interface, decltype(m_version) in_version) |
Public Attributes | |
| int(* | GetCount )(const struct ak_wwise_plugin_sink_devices_instance_v1 *in_this) |
| Get a count of the number of interfaces currently available. More... | |
| const char *(* | GetName )(const struct ak_wwise_plugin_sink_devices_instance_v1 *in_this, int in_num) |
| Get a user-presentable name for the device number in_num. More... | |
| uint32_t(* | GetDeviceID )(const struct ak_wwise_plugin_sink_devices_instance_v1 *in_this, int in_num) |
| Get a device ID for the device number in_num. More... | |
| Public Attributes inherited from ak_wwise_plugin_interface_ptr | |
| ak_wwise_plugin_interface_type | m_interface: 32 |
| Interface type (see ak_wwise_plugin_interface_type) More... | |
| uint32_t | m_version: 32 |
| Version of the interface. More... | |
Detailed Description
Device enumerator 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
- ak_wwise_plugin_sink_devices_instance_v1 instance type
- AK::Wwise::Plugin::SinkDevices C++ Interface
- AK_WWISE_PLUGIN_SINK_DEVICES_V1_ID Current ID for interface
- AK_WWISE_PLUGIN_INTERFACE_TYPE_SINK_DEVICES
Definition at line 58 of file SinkDevices.h.
Was this page helpful?
Need Support?
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageTell 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