---
name: "getTTSData"
mode: "kit"
versionRequirements:
  - { name: "OutdoorKit", version: "1.0.1" }
  - { name: "@ray-js/ray", version: "1.4.40" }
platform:
  - "iOS"
  - "Android"
async: true
title: "outdoor.getTTSData - // @ray-js/ray >=1.4.40"
---

## getTTSData

> [VERSION] OutdoorKit >= 1.0.1 | @ray-js/ray >= 1.4.40

> [PLATFORM] iOS, Android

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

### Description

Get cycling voice broadcast data

### Parameters

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

#### success callback parameters

| Property | Type | Since | Description |
| --- | --- | --- | --- |
| `ttsMainSwitch` | `boolean` | `1.0.1` | Global switch for cycling data broadcast |
| `weather` | `boolean` | `1.0.1` | Weather |
| `abnormalWear` | `boolean` | `1.0.1` | Abnormal wear voice alert switch |
| `cyclingMileage` | `boolean` | `1.0.1` | Cycling distance voice alert switch |
| `lowBattery` | `boolean` | `1.0.1` | Low battery |
| `electricThreshold` | `number` | `1.0.1` | Low-battery voice alert threshold; triggers when the battery falls below this percentage |
| `callReminder` | `boolean` | `1.0.1` | Incoming call voice alert switch |

#### 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` | Error extension code |
| `errorMsg` | `string` | Error extension message |


### Examples

#### Demo

```tsx
import { outdoor } from '@ray-js/ray'

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