Amazon Developer

as

Settings
Sign out
Notifications
Alexa
Amazon Appstore
Ring
AWS
Documentation
Support
Contact Us
My Cases
Get Started
Design and Develop
Publish
Reference
Support
Native
Skip to main content

Interface IUserEngagement

interface IUserEngagement
Extends com.amazon.apmf.IStandard Allows the calling app to report that the user is or is not engaged with a capability. For example, if an app is actively playing a video but it wants to signal the user is no longer engaged with this capability, the app should create a video user engagement object and invoke stop(). If the app knows the user is engaged after a certain trigger, it may use the start() API to signal this to the operating system. The Application Framework uses user engagement to drive the ambient experience among other behaviors. No access-control is needed for this API. Whenever an app sets engagement with a capability, this engagement is scoped to it. Built from ‘IKeplerUserEngagementModuleV2::makeVideoPlaybackUserEngagement()’ and ‘IKeplerUserEngagementModuleV2::makeAudioPlaybackUserEngagement()‘

Methods

start()

void start()
Report that the user will start engaging with the capability.

stop()

void stop()
Report that the user will stop engaging with the capability.
Last modified on October 29, 2026