---
name: "getTTSData"
mode: "kit"
versionRequirements:
  - { name: "OutdoorKit", version: "1.0.1" }
platform:
  - "iOS"
  - "Android"
async: true
title: "ty.outdoor.getTTSData"
---

## getTTSData

> [VERSION] OutdoorKit >= 1.0.1

> [PLATFORM] iOS, Android

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

### Description

Get cycling announcement data

### Parameters

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `complete` | `() => void` | No | - | Callback when the API call completes (executed on both success and failure) |
| `success` | `(params: Object) => void` ↓see below | No | - | Success callback |
| `fail` | `(params: Object) => void` ↓see below | No | - | Failure callback |

#### success callback parameters

| Property | Type | Since | Description |
| --- | --- | --- | --- |
| `ttsMainSwitch` | `boolean` | `1.0.1` | Master switch for cycling data announcements |
| `weather` | `boolean` | `1.0.1` | Weather |
| `abnormalWear` | `boolean` | `1.0.1` | Abnormal wearing announcement toggle |
| `cyclingMileage` | `boolean` | `1.0.1` | Cycling mileage announcement toggle |
| `lowBattery` | `boolean` | `1.0.1` | Low battery |
| `electricThreshold` | `number` | `1.0.1` | Low-battery announcement threshold; triggers announcement when battery is below this percentage |
| `callReminder` | `boolean` | `1.0.1` | Incoming call reminder announcement toggle |

#### 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 message |


### Examples

#### Demo

```tsx
ty.outdoor.getTTSData({
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});
```