---
name: "startGyroscope"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "2.3.2" }
platform:
  - "iOS"
  - "Android"
async: true
---

## startGyroscope

> [VERSION] BaseKit >= 2.3.2

> [PLATFORM] iOS, Android

> ⚡ **Supports Promise** — Returns a Promise when success / fail / complete callbacks are omitted.

### Description

Start listening to gyroscope data

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `interval` | `"game" \| "ui" \| "normal"` | No | `'normal'` | `2.3.2` | Frequency at which the gyroscope data callback is invoked |
| `complete` | `() => void` | No | - | - | Callback invoked when the API call completes (runs on both success and failure) |
| `success` | `() => void` | No | - | - | Success callback |
| `fail` | `(params: Object) => void` ↓see below | No | - | - | Failure callback |

#### fail callback parameters

| Property | Type | Description |
| --- | --- | --- |
| `errorMsg` | `string` | Error message |
| `errorCode` | `string \| number` | Error code |
| `innerError` | `Object` | Error extension |

##### fail(params).innerError properties

| Property | Type | Description |
| --- | --- | --- |
| `errorCode` | `string \| number` | Extended error code |
| `errorMsg` | `string` | Extended error info |


### Valid Values

##### `interval` valid values

| Value | Description |
| --- | --- |
| `"game"` | For game updates: callback frequency around 20 ms per call |
| `"ui"` | For UI updates: callback frequency around 60 ms per call |
| `"normal"` | Normal callback frequency: around 200 ms per call |


### Examples

```tsx
// Start listening to the gyroscope; interval is the callback frequency: game (~20ms) / ui (~60ms) / normal (~200ms)
ty.startGyroscope({
  interval: "normal",
  success: () => console.log("Started listening to gyroscope"),
  fail: error => console.error(error),
});
```