---
name: "IpcPlayerContext.isRecording"
mode: "api"
versionRequirements:
  - { name: "Base Library", version: "2.21.8" }
title: "IpcContext.isRecording - 查询是否正在录像"
---

## IpcPlayerContext.isRecording

> [VERSION] Base Library >= 2.21.8

### Description

Check if recording is active

### Parameters

`Params`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `options` | `IpcIsRecordingOption` | No | Callback options |

### Return Value

None


### Referenced Types

##### `interface` IpcIsRecordingOption

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `success` | `(result: IpcIsRecordingResult) => void` | No | Callback invoked on successful API call |
| `fail` | `(result: IpcFailResult) => void` | No | Callback on failure |
| `complete` | `() => void` | No | Callback on complete (success or failure) |

##### `interface` IpcIsRecordingResult

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `isRecording` | `boolean` | Yes | Whether recording is in progress |

##### `interface` IpcFailResult

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


### Examples

#### Query recording status

```ts
const ipcCtx = ty.createIpcPlayerContext('deviceId');
ipcCtx.isRecording({
  success(res) {
    console.log('Is recording', res.isRecording);
  },
});
```