EVT_ACX_KEYWORDSPOTTER_RETRIEVE_ARM callback function (acxelements.h)

Article
02/22/2024

The EVT_ACX_KEYWORDSPOTTER_RETRIEVE_ARM callback retrieves the current arm state of the keyword spotter.

Syntax

EVT_ACX_KEYWORDSPOTTER_RETRIEVE_ARM EvtAcxKeywordspotterRetrieveArm;

NTSTATUS EvtAcxKeywordspotterRetrieveArm(
  ACXKEYWORDSPOTTER KeywordSpotter,
  GUID *EventId,
  PBOOLEAN Arm
)
{...}

Parameters

KeywordSpotter

An existing, initialized, ACXKEYWORDSPOTTER object. For more information about ACX objects, see Summary of ACX Objects. Also see the AcxKeywordSpotterCreate function.

EventId

A pointer to a GUID that represents the EventId.

Arm

A boolean value indicating if the keyword detection is armed.

Return value

Returns STATUS_SUCCESS if the call was successful. Otherwise, it returns an appropriate error code. For more information, see Using NTSTATUS Values.

Remarks

For general information about keyword detection, see Voice Activation and Multiple Voice Assistant.

Example

Example usage is shown below.

EVT_ACX_KEYWORDSPOTTER_RETRIEVE_ARM     CodecC_EvtAcxKeywordSpotterRetrieveArm;

NTSTATUS
NTAPI
CodecC_EvtAcxKeywordSpotterRetrieveArm(
    _In_    ACXKEYWORDSPOTTER   KeywordSpotter,
    _In_    GUID *              EventId,
    _Out_   BOOLEAN *           Arm
    )
{
    PAGED_CODE();
    PCODEC_KEYWORDSPOTTER_CONTEXT keywordSpotterCtx;
    CKeywordDetector *              keywordDetector = NULL;

    keywordSpotterCtx = GetCodecKeywordSpotterContext(KeywordSpotter);

    keywordDetector = (CKeywordDetector*)keywordSpotterCtx->KeywordDetector;

    return keywordDetector->GetArmed(*EventId, Arm);
}

ACX requirements

Minimum ACX version: 1.0

For more information about ACX versions, see ACX version overview.

Requirements

Requirement	Value
Header	acxelements.h
IRQL	PASSIVE_LEVEL

Share via