tencent cloud

All product documents
Tencent Cloud Super App as a Service
Gyroscope
Last updated: 2025-04-10 18:18:36
Gyroscope
Last updated: 2025-04-10 18:18:36

startGyroscope

This API is called using wx.startGyroscope(Object object).
Feature description:Starts listening for gyroscope data.
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 gyroscope data.
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).
Valid values for object.interval:
Value
Description
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.

stopGyroscope

This API is called using wx.stopGyroscope(Object object).
Feature description:Stops listening for gyroscope data.
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).

onGyroscopeChange

This API is called using wx.onGyroscopeChange(function listener).
Feature description:Listens for gyroscope data change event. The frequency is based on the interval parameter of the wx.startGyroscope(). You can use wx.stopGyroscope() to stop listening.
Parameter and description:function listener. The callback function for gyroscope data change event. Parameter: Object res.
Property
Type
Description
x
number
The angular velocity around the x-axis.
y
number
The angular velocity around the y-axis.
z
number
The angular velocity around the z-axis.

offGyroscopeChange

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

wx.onGyroscopeChange(listener)
wx.offGyroscopeChange(listener) // Must pass the same function object used in onGyroscopeChange


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