tencent cloud

All product documents
Tencent Cloud Super App as a Service
Device Motion
Last updated: 2025-02-25 11:55:10
Device Motion
Last updated: 2025-02-25 11:55:10

stopDeviceMotionListening

Notes:
This API is supported in mini programs but not in mini games.
This API is called using wx.stopDeviceMotionListening(Object object).
Feature description:Stops listening for device motion change event.
Parameter and description:Object object.
Property
Type
Default value
‍Required
Description
success
function
-
False
Callback function for successful API calls.
fail
function
-
False
Callback function for failed API calls.
complete
function
-
False
Callback function executed after API call ends (regardless of success or failure).

startDeviceMotionListening

Notes:
This API is supported in mini programs but not in mini games.
This API is called using wx.startDeviceMotionListening(Object object).
Feature description:Starts listening for device motion change event.
Parameter and description:Object object.
Property
Type
Default value
‍Required
Description
interval
string
normal
False
The execution frequency of the callback function that listens for device orientation changes. Valid values:
game: Callback frequency suitable for game updates, about 20 ms/time.
ui: Callback frequency suitable for UI updates, about 60 ms/time.
normal: Normal callback frequency, about 200 ms/time.
success
function
-
False
Callback function for successful API calls.
fail
function
-
False
Callback function for failed API calls.
complete
function
-
False
Callback function executed after API call ends (regardless of success or failure).

onDeviceMotionChange

This API is called using wx.onDeviceMotionChange(function listener).
Feature description:Listens for device motion change event. The frequency is based on the interval parameter of the wx.startDeviceMotionListening(). You can use wx.stopDeviceMotionListening() to stop listening.
Parameter and description:function listener. The listener for device orientation change event.
Property
Type
Description
alpha
number
The angle around the Z-axis when the phone's X/Y coordinates align with the Earth's X/Y coordinates. The range is [0, 2*PI). Counterclockwise rotation is positive.
beta
number
The angle around the X-axis when the phone's Y/Z coordinates align with the Earth's Y/Z coordinates. The range is [-1*PI, PI). Rotation towards the Earth's surface is positive. It may also be positive towards the user.
gamma
number
The angle around the Y-axis when the phone's X/Z coordinates align with the Earth's X/Z coordinates. The range is [-1*PI/2, PI/2). Rotation towards the Earth's surface on the right side is positive.

offDeviceMotionChange

This API is called using wx.offDeviceMotionChange(function listener).
Feature description:Removes the listener for device orientation change event.
Parameter and description:function listener. The listener passed to onDeviceMotionChange. If not provided, all listeners will be removed.
Example:
const listener = function (res) { console.log(res) }

wx.onDeviceMotionChange(listener)
wx.offDeviceMotionChange(listener) // Must pass the same function object used in onDeviceOrientationChange


Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 available.

7x24 Phone Support