WakewordManager

Outgoing Messages

OnWakewordDetected

Notifies the platform 3P wakeword detected

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "WakewordManager",
            "action": "OnWakewordDetected"
        }
    },
    "payload": {
        "wakeword": {{String}},
        "beginIndex": {{Int}},
        "endIndex": {{Int}}        
    }
}

Payload

Property	Type	Required	Description	Example
wakeword	String	Yes	Wakeword detected
beginIndex	Int	Yes	Begin index of wakeword detected
endIndex	Int	Yes	End index of wakeword detected

SetWakewordStatusReply

Reply for SetWakewordStatus message.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Reply",
        "id": {{String}},
        "messageDescription": {
            "topic": "WakewordManager",
            "action": "SetWakewordStatus",
            "replyToId": {{String}}        
        }
    },
    "payload": {
        "success": {{Bool}}        
    }
}

Payload

Property	Type	Required	Description	Example
success	Bool	Yes	True if SetWakewordStatus was successful, False otherwise.

Incoming Messages

SetWakewordStatus

Enables/disables wakeword detection

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "WakewordManager",
            "action": "SetWakewordStatus"
        }
    },
    "payload": {
        "name": {{String}},
        "value": {{Bool}}        
    }
}

Payload

Property	Type	Required	Description	Example
name	String	Yes	name of the wakeword to be enabled/disabled
value	Bool	Yes	vaues of enable/disable wakeword