---
name: "IpcPlayerContext.setSoundMode"
mode: "api"
versionRequirements:
  - { name: "基础库", version: "2.21.8" }
title: "IpcContext.setSoundMode - 设置声音模式"
---

## IpcPlayerContext.setSoundMode

> [VERSION] 基础库 >= 2.21.8

### 描述

设置声音模式

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `options` | `IpcSetSoundModeOption` | 是 | 声音模式配置 |

### 返回值

无


### 引用对象

##### `interface` IpcSetSoundModeOption

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `mode` | `"speaker" \| "ear"` | 声音模式，speaker 扬声器，ear 听筒 |
| `success` | `() => void` | 接口调用成功的回调函数 |
| `fail` | `(result: IpcFailResult) => void` | 接口调用失败的回调函数 |
| `complete` | `() => void` | 接口调用结束的回调函数（调用成功、失败都会执行） |

##### `interface` IpcFailResult

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorCode` | `string` | 错误码 |
| `errorMsg` | `string` | 错误信息 |


### 示例代码

#### 切换到扬声器模式

```ts
const ipcCtx = ty.createIpcPlayerContext('deviceId');
ipcCtx.setSoundMode({
  mode: 'speaker',
  success() {
    console.log('已切换到扬声器');
  },
});
```