kpb_service.h File Reference

Include dependency graph for kpb_service.h:

Go to the source code of this file.

Functions
AdspErrorCode	kpb_service_register_client (size_t current_history_depth, size_t max_history_depth, uint32_t output_pin, struct kpb_service_client **client)
	Register an IADK client with the SOF KPB component.
AdspErrorCode	kpb_service_signal_detection (struct kpb_service_client *client, uint32_t phrase_length)
	Notify KPB about key phrase detection.
AdspErrorCode	kpb_service_unregister_client (struct kpb_service_client *client)
	Unregister an IADK client from the SOF KPB component.

Function Documentation

kpb_service_register_client()

AdspErrorCode kpb_service_register_client	(	size_t	current_history_depth,
		size_t	max_history_depth,
		uint32_t	output_pin,
		struct kpb_service_client **	client
	)

Register an IADK client with the SOF KPB component.

Parameters

current_history_depth	Initial history depth in milliseconds.
max_history_depth	Maximum history depth in milliseconds.
output_pin	Zero-based buffered output pin index.
client	Location for the registered client handle.

Returns

ADSP error code.

kpb_service_signal_detection()

AdspErrorCode kpb_service_signal_detection	(	struct kpb_service_client *	client,
		uint32_t	phrase_length
	)

Notify KPB about key phrase detection.

Parameters

client	Registered client handle.
phrase_length	Detected phrase length in milliseconds.

Returns

ADSP error code.

kpb_service_unregister_client()

AdspErrorCode kpb_service_unregister_client

(

struct kpb_service_client *

client

)

Unregister an IADK client from the SOF KPB component.

Parameters

client

Registered client handle.

Returns

ADSP error code.