---
name: "IpcPlayerContext.snapshot"
mode: "api"
versionRequirements:
  - { name: "基础库", version: "2.21.8" }
title: "IpcContext.snapshot - 截图"
---

## IpcPlayerContext.snapshot

> [VERSION] 基础库 >= 2.21.8

### 描述

截图

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `options` | `IpcSnapshotOption` | 是 | 截图配置 |

### 返回值

无


### 引用对象

##### `interface` IpcSnapshotOption

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `saveToAlbum` | `number` | 是否保存到相册，0 系统相册，1 IPC 相册 |
| `success` | `(result: IpcSnapshotResult) => void` | 接口调用成功的回调函数 |
| `fail` | `(result: IpcFailResult) => void` | 接口调用失败的回调函数 |
| `complete` | `() => void` | 接口调用结束的回调函数（调用成功、失败都会执行） |

##### `interface` IpcSnapshotResult

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `path` | `string` | 截图文件路径 |

##### `interface` IpcFailResult

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


### 示例代码

#### 截图并保存到相册

```ts
const ipcCtx = ty.createIpcPlayerContext('deviceId');
ipcCtx.snapshot({
  saveToAlbum: 1,
  success(res) {
    console.log('截图成功', res.path);
  },
});
```