privacyProtectDetectForVideo(params: Object)

Requires:
AIKit≥1.2.0@ray-js/ray≥1.7.9
Platforms:
iOSAndroid
import { ai } from '@ray-js/ray';

const { privacyProtectDetectForVideo } = ai;

// Promise usage
try {
  const res = await privacyProtectDetectForVideo({ ...params });
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

Description

Run privacy region recognition on a video

Parameters

PropertyTypeRequiredDefaultDescription
inputVideoPathstringYes-Video input path
outputVideoPathstringYes-Video output path
videoConfig1 | 2 | 3 | 4No4Video configuration -- defaults to 1080
detectType1 | 2No1Recognition type
imageEditType1 | 2 | 3No1Image processing type
musicPathstringYes-Local path of background music
audioEditType1 | 2 | 3No1Audio processing type
originAudioVolumenumberNo0.5Original audio volume
overlayAudioVolumenumberNo0.5Overlay audio volume
complete() => voidNo-Completion callback (executed on both success and failure)
success(params: Object) => voidNo-Callback on successful API call
fail(params: Object) => voidNo-Failure callback
success callback parameters
PropertyTypeDescription
pathstringOutput path
fail callback parameters
PropertyTypeDescription
errorMsgstringError message
errorCodestring | numberError code
Error extension

Return Value

None

Valid Values

videoConfig
ValueDescriptionAIKit Since
1480v1.1.0
2540v1.1.0
3720v1.1.0
41080 (default)v1.1.0
detectType
ValueDescriptionAIKit Since
1Petsv1.1.0
2Peoplev1.1.0
imageEditType
ValueDescriptionAIKit Since
1No effectv1.1.0
2Emphasize subjectv1.1.0
3Privacy protection-
audioEditType
ValueDescriptionAIKit Since
1No processingv1.1.0
20.5 0.5 mixingv1.1.0
3Mute videov1.1.0

Examples

import { ai } from '@ray-js/ray'

ai.privacyProtectDetectForVideo({
  inputVideoPath: "xx",
  outputVideoPath: "xx",
  videoConfig: 4,
  detectType: 1,
  imageEditType: 1,
  musicPath: "xx",
  audioEditType: 1,
  originAudioVolume: 0.5,
  overlayAudioVolume: 0.5,
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});