---
name: "InnerAudioContext.play"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "2.3.2" }
platform:
  - "iOS"
  - "Android"
title: "InnerAudioContext.play - Play audio"
---

## InnerAudioContext.play

> [VERSION] BaseKit >= 2.3.2

> [PLATFORM] iOS, Android

### Description

Play

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `src` | `string` | Yes | - | `2.3.2` | src URL of the audio resource |
| `startTime` | `number` | No | `0` | `2.3.2` | startTime Start position, in seconds. Precision to 3 decimal places (ms-level accuracy) |
| `autoplay` | `boolean` | No | `false` | `2.3.2` | autoplay Whether to start playing automatically |
| `loop` | `boolean` | No | `false` | `2.3.2` | Whether to loop playback; default: false |
| `volume` | `number` | No | `1.0` | `2.3.2` | Volume, range 0–1. Default: 1 |
| `playbackRate` | `number` | No | `1.0` | `2.3.2` | Playback rate, range 0.5–2.0; default: 1. (Android 6 or above required) |
| `complete` | `() => void` | No | - | - | Completion callback (executed on both success and failure) |
| `success` | `() => void` | No | - | - | Callback on successful API call |
| `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` | Error extension code |
| `errorMsg` | `string` | Error extension message |


### Examples

#### Demo

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

const manager = await createInnerAudioContext();

manager.play({
  src: "https://example.com/test.mp3",
  startTime: 0,
  autoplay: false,
  loop: false,
  volume: 1.0,
  playbackRate: 1.0,
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});
```
