---
name: "backgroundMusicDownload"
mode: "kit"
versionRequirements:
  - { name: "AIKit", version: "1.1.0" }
  - { name: "@ray-js/ray", version: "1.6.29" }
platform:
  - "iOS"
  - "Android"
async: true
title: "backgroundMusicDownload"
---

## backgroundMusicDownload

> [VERSION] AIKit >= 1.1.0 | @ray-js/ray >= 1.6.29

> [PLATFORM] iOS, Android

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

### Description

Download background music locally from a URL

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `musicUrl` | `string` | Yes | - | `1.1.0` | Music download URL |
| `musicPath` | `string` | Yes | - | `1.1.0` | Local music path |
| `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 |
| --- | --- | --- | --- |
| `musicPath` | `string` | `1.1.0` | Local music address |

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

#### Basic usage

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

const { backgroundMusicDownload } = ai;

backgroundMusicDownload({
  musicUrl: 'example',
  musicPath: 'example',
  success: (result) => {
    console.log('backgroundMusicDownload success', result);
  },
  fail: (error) => {
    console.log('backgroundMusicDownload fail', error.errorMsg);
  },
});
```