---
name: "IpcPlayerContext.setClarity"
mode: "api"
versionRequirements:
  - { name: "基础库", version: "2.21.8" }
title: "IpcContext.setClarity - 设置清晰度"
---

## IpcPlayerContext.setClarity

> [VERSION] 基础库 >= 2.21.8

### 描述

设置清晰度

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `options` | `IpcSetClarityOption` | 是 | 清晰度配置 |

### 返回值

无


### 引用对象

##### `interface` IpcSetClarityOption

| 属性 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `clarity` | `"normal" \| "hd" \| "ss" \| "ud" \| "ssp" \| "auto" \| "audio"` | 是 | 清晰度 |
| `success` | `() => void` | 否 | 接口调用成功的回调函数 |
| `fail` | `(result: IpcFailResult) => void` | 否 | 接口调用失败的回调函数 |
| `complete` | `() => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |

##### `interface` IpcFailResult

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


### 示例代码

#### 切换到高清模式

```ts
const ipcCtx = ty.createIpcPlayerContext('deviceId');
ipcCtx.setClarity({
  clarity: 'hd',
  success() {
    console.log('已切换到高清');
  },
});
```