Skip to content

Client Properties

The engine can benefit from knowing various states of the device. This information can be taken into account when determining if a wake word is present to make the engine more or less sensitive.

Use the public API call PryonLite_SetClientProperty to inform the engine of any device state changes at run-time.


Common Client Properties

The table below lists all of the common client properties defined in pryon_lite_common_client_properties.h

Group Property Description
CLIENT_PROP_GROUP_COMMON CLIENT_PROP_COMMON_AUDIO_PLAYBACK Generic audio playback (any sound)
CLIENT_PROP_GROUP_COMMON CLIENT_PROP_COMMON_ALARM_STATE Alarm playback
CLIENT_PROP_GROUP_COMMON CLIENT_PROP_COMMON_MEDIA_PLAYER_STATE Media playback
CLIENT_PROP_GROUP_COMMON CLIENT_PROP_COMMON_EARCON_PLAYER_STATE Earcon playback
CLIENT_PROP_GROUP_COMMON CLIENT_PROP_COMMON_TTS_PLAYER_STATE Text to speech playback

All common client properties share the following possible values

Value Meaning
-1 Unknown State
0 Not Playing
1 Playing