objectDetectForVideo(params: Object)

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

const { objectDetectForVideo } = ai;

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

Description

Run object 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
1480-
2540-
3720-
41080 (default)-
detectType
ValueDescriptionAIKit Since
1Pets-
2People-
imageEditType
ValueDescriptionAIKit Since
1No effect-
2Emphasize subject-
3Privacy protectionv1.2.0
audioEditType
ValueDescriptionAIKit Since
1No processing-
20.5 0.5 mixing-
3Mute video-

Examples

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

ai.objectDetectForVideo({
  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);
  },
});