intel_adsp::KpbInterface Class Reference

Version 1 KPB service interface for IADK modules. More...

#include <src/include/sof/audio/module_adapter/iadk/kpb_interface.h>

Public Member Functions
virtual ErrorCode::Type	RegisterKpbClient (const ModuleHandle &module_handle, KpbToken &token, size_t current_history_depth, size_t max_hist_depth, uint32_t output_pin) const =0
	Register an IADK module as a KPB client.
virtual ErrorCode::Type	SignalDetection (KpbToken &token, void *data) const =0
	Report key-phrase detection for a registered client.
virtual ErrorCode::Type	SignalVoiceDetection (KpbToken &token, void *data) const =0
	Report voice detection for a registered client.
virtual ErrorCode::Type	SignalSilenceDetection (KpbToken &token, void *data) const =0
	Report silence detection for a registered client.
virtual ErrorCode::Type	UnregisterKpbClient (KpbToken &token) const =0
	Unregister a KPB client.
virtual ErrorCode::Type	RegisterWovProducer (const ModuleHandle &module_handle) const =0
	Register an IADK module as a WOV producer.
virtual ErrorCode::Type	RegisterKpbProducer (const ModuleHandle &module_handle) const =0
	Register an IADK module as a KPB producer.
virtual ErrorCode::Type	RequestWovConsumer (const ModuleHandle &module_handle) const =0
	Request a WOV consumer for an IADK module.

Detailed Description

Version 1 KPB service interface for IADK modules.

Member Function Documentation

RegisterKpbClient()

virtual ErrorCode::Type intel_adsp::KpbInterface::RegisterKpbClient ( const ModuleHandle &  module_handle, KpbToken &  token, size_t  current_history_depth, size_t  max_hist_depth, uint32_t  output_pin  ) const

pure virtual

Register an IADK module as a KPB client.

Parameters

module_handle	Handle of the module registering the client.
token	Storage for the registered client's token.
current_history_depth	Initial history depth in milliseconds.
max_hist_depth	Maximum history depth in milliseconds.
output_pin	Zero-based buffered output pin index.

Returns

SOF error code, with ADSP_NO_ERROR on success.

RegisterKpbProducer()

virtual ErrorCode::Type intel_adsp::KpbInterface::RegisterKpbProducer ( const ModuleHandle &  module_handle ) const

pure virtual

Register an IADK module as a KPB producer.

Parameters

module_handle

Handle of the module registering as a producer.

Returns

SOF error code, with ADSP_NO_ERROR on success.

RegisterWovProducer()

virtual ErrorCode::Type intel_adsp::KpbInterface::RegisterWovProducer ( const ModuleHandle &  module_handle ) const

pure virtual

Register an IADK module as a WOV producer.

Parameters

module_handle

Handle of the module registering as a producer.

Returns

SOF error code, with ADSP_NO_ERROR on success.

RequestWovConsumer()

virtual ErrorCode::Type intel_adsp::KpbInterface::RequestWovConsumer ( const ModuleHandle &  module_handle ) const

pure virtual

Request a WOV consumer for an IADK module.

Parameters

module_handle

Handle of the module requesting a consumer.

Returns

SOF error code, with ADSP_NO_ERROR on success.

SignalDetection()

virtual ErrorCode::Type intel_adsp::KpbInterface::SignalDetection ( KpbToken &  token, void *  data  ) const

pure virtual

Report key-phrase detection for a registered client.

Parameters

token	Token of the registered client.
data	Pointer to the detected phrase length in milliseconds.

Returns

SOF error code, with ADSP_NO_ERROR on success.

SignalSilenceDetection()

virtual ErrorCode::Type intel_adsp::KpbInterface::SignalSilenceDetection ( KpbToken &  token, void *  data  ) const

pure virtual

Report silence detection for a registered client.

Parameters

token	Token of the registered client.
data	Event-specific data (unused by the current native service).

Returns

SOF error code, with ADSP_NO_ERROR on success.

SignalVoiceDetection()

virtual ErrorCode::Type intel_adsp::KpbInterface::SignalVoiceDetection ( KpbToken &  token, void *  data  ) const

pure virtual

Report voice detection for a registered client.

Parameters

token	Token of the registered client.
data	Event-specific data (unused by the current native service).

Returns

SOF error code, with ADSP_NO_ERROR on success.

UnregisterKpbClient()

virtual ErrorCode::Type intel_adsp::KpbInterface::UnregisterKpbClient ( KpbToken &  token ) const

pure virtual

Unregister a KPB client.

Parameters

token

Token of the client to unregister.

Returns

SOF error code, with ADSP_NO_ERROR on success.

---

The documentation for this class was generated from the following file:

• src/include/sof/audio/module_adapter/iadk/kpb_interface.h