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

## IpcPlayerContext.setClarity

> [VERSION] Base Library >= 2.21.8

### Description

Set quality

### Parameters

`Params`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `options` | `IpcSetClarityOption` | Yes | Quality options |

### Return Value

None


### Referenced Types

##### `interface` IpcSetClarityOption

| Property | Type | Description |
| --- | --- | --- |
| `clarity` | `"normal" \| "hd" \| "ss" \| "ud" \| "ssp" \| "auto" \| "audio"` | Quality |
| `success` | `() => void` | Callback invoked on successful API call |
| `fail` | `(result: IpcFailResult) => void` | Callback on failure |
| `complete` | `() => void` | Callback on complete (success or failure) |

##### `interface` IpcFailResult

| Property | Type | Description |
| --- | --- | --- |
| `errorCode` | `string` | Error code |
| `errorMsg` | `string` | Error message |


### Examples

#### Switch to HD mode

```ts
const ipcCtx = ty.createIpcPlayerContext('deviceId');
ipcCtx.setClarity({
  clarity: 'hd',
  success() {
    console.log('Switched to HD');
  },
});
```