useSGScreenRecord
Phiên bản
Khả dụng từ v2.0.0+
Một React hook để phát hiện các sự kiện quay màn hình. Thay thế cho registerScreenRecordingEventListener từ phiên bản v1.x.
Hỗ trợ nền tảng:
- iOS 13+
- Android 15+ (API 35+)
Core Function
function useSGScreenRecord(
listener?: (event: ScreenGuardScreenRecordDataObject) => void
): {
recordingData: ScreenGuardScreenRecordDataObject | null;
activationStatus: ScreenGuardHookData | null;
}
Tham số
| Tên | Bắt buộc | Kiểu | Mô tả |
|---|---|---|---|
| listener | Không | function | Một hàm callback tùy chọn được kích hoạt khi trạng thái quay màn hình thay đổi |
Giá trị trả về
| Tên | Kiểu | Mô tả |
|---|---|---|
| recordingData | đối tượng | null | Dữ liệu về trạng thái quay màn hình hiện tại |
| activationStatus | đối tượng | null | Trạng thái kích hoạt hiện tại của ScreenGuard |
Đối tượng recordingData
interface ScreenGuardScreenRecordDataObject {
isRecording?: boolean;
}
| Trường | Kiểu | Mô tả |
|---|---|---|
isRecording | boolean | undefined | true khi quá trình quay màn hình bắt đầu, false khi quá trình quay màn hình dừng lại. undefined trước khi có bất kỳ sự kiện quay màn hình nào xảy ra |
Đối tượng activationStatus
interface ScreenGuardHookData {
method: string;
isActivated: boolean;
}
| Trường | Kiểu | Mô tả |
|---|---|---|
method | string | Phương thức kích hoạt hiện đang hoạt động. Các giá trị có thể có: 'blur', 'image', 'color', '' (trống khi không được kích hoạt) |
isActivated | boolean | true nếu screenguard hiện đang được kích hoạt, false nếu ngược lại |