---
name: "IpcPlayerContext.startPreview"
mode: "api"
versionRequirements:
  - { name: "基础库", version: "2.21.8" }
title: "IpcContext.startPreview - 开始预览"
---

## IpcPlayerContext.startPreview

> [VERSION] 基础库 >= 2.21.8

### 描述

开始预览

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `options` | `IpcCallbackOption` | 否 | 回调配置 |

### 返回值

无


### 引用对象

##### `interface` IpcCallbackOption

| 属性 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `success` | `() => void` | 否 | 接口调用成功的回调函数 |
| `fail` | `(result: IpcFailResult) => void` | 否 | 接口调用失败的回调函数 |
| `complete` | `() => void` | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） |

##### `interface` IpcFailResult

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


### 示例代码

#### 开始预览

```ts
const ipcCtx = ty.createIpcPlayerContext('deviceId');
ipcCtx.startPreview({
  success() {
    console.log('预览已开始');
  },
});
```