kaimo_rtsp_plugin/dist/docs.json

RTSP plugin for Capacitor with native AAR support

{
  "api": {
    "name": "rtsp_viewPlugin",
    "slug": "rtsp_viewplugin",
    "docs": "",
    "tags": [],
    "methods": [
      {
        "name": "startPull",
        "signature": "(options: { url: string; }) => Promise<{ success: boolean; }>",
        "parameters": [
          {
            "name": "options",
            "docs": "包含RTSP URL的选项",
            "type": "{ url: string; }"
          }
        ],
        "returns": "Promise<{ success: boolean; }>",
        "tags": [
          {
            "name": "param",
            "text": "options 包含RTSP URL的选项"
          },
          {
            "name": "returns",
            "text": "操作结果"
          }
        ],
        "docs": "开始拉流 (JNI功能)",
        "complexTypes": [],
        "slug": "startpull"
      },
      {
        "name": "stopPull",
        "signature": "() => Promise<{ success: boolean; }>",
        "parameters": [],
        "returns": "Promise<{ success: boolean; }>",
        "tags": [
          {
            "name": "returns",
            "text": "操作结果"
          }
        ],
        "docs": "停止拉流 (JNI功能)",
        "complexTypes": [],
        "slug": "stoppull"
      },
      {
        "name": "saveJpg",
        "signature": "(options: { directUrl: string; }) => Promise<{ success: boolean; }>",
        "parameters": [
          {
            "name": "options",
            "docs": "包含保存路径的选项",
            "type": "{ directUrl: string; }"
          }
        ],
        "returns": "Promise<{ success: boolean; }>",
        "tags": [
          {
            "name": "param",
            "text": "options 包含保存路径的选项"
          },
          {
            "name": "returns",
            "text": "操作结果"
          }
        ],
        "docs": "保存JPEG图像 (JNI功能)",
        "complexTypes": [],
        "slug": "savejpg"
      },
      {
        "name": "saveMp4",
        "signature": "(options: { directUrl: string; }) => Promise<{ success: boolean; }>",
        "parameters": [
          {
            "name": "options",
            "docs": "包含保存路径的选项",
            "type": "{ directUrl: string; }"
          }
        ],
        "returns": "Promise<{ success: boolean; }>",
        "tags": [
          {
            "name": "param",
            "text": "options 包含保存路径的选项"
          },
          {
            "name": "returns",
            "text": "操作结果"
          }
        ],
        "docs": "开始录制MP4视频 (JNI功能)",
        "complexTypes": [],
        "slug": "savemp4"
      },
      {
        "name": "stopRecordMp4",
        "signature": "() => Promise<{ success: boolean; }>",
        "parameters": [],
        "returns": "Promise<{ success: boolean; }>",
        "tags": [
          {
            "name": "returns",
            "text": "操作结果"
          }
        ],
        "docs": "停止录制MP4视频 (JNI功能)",
        "complexTypes": [],
        "slug": "stoprecordmp4"
      },
      {
        "name": "isRecording",
        "signature": "() => Promise<{ recording: boolean; }>",
        "parameters": [],
        "returns": "Promise<{ recording: boolean; }>",
        "tags": [
          {
            "name": "returns",
            "text": "是否正在录制"
          }
        ],
        "docs": "获取录制状态 (JNI功能)",
        "complexTypes": [],
        "slug": "isrecording"
      },
      {
        "name": "writeBinaryByJava",
        "signature": "(options: { url: string; data: string; replace: boolean; isFirstChunk: boolean; isLastChunk: boolean; chunkIndex: number; }) => Promise<{ success: boolean; }>",
        "parameters": [
          {
            "name": "options",
            "docs": "包含文件路径和数据的选项",
            "type": "{ url: string; data: string; replace: boolean; isFirstChunk: boolean; isLastChunk: boolean; chunkIndex: number; }"
          }
        ],
        "returns": "Promise<{ success: boolean; }>",
        "tags": [
          {
            "name": "param",
            "text": "options 包含文件路径和数据的选项"
          },
          {
            "name": "returns",
            "text": "操作结果"
          }
        ],
        "docs": "写入二进制文件数据",
        "complexTypes": [],
        "slug": "writebinarybyjava"
      },
      {
        "name": "startCameraPreview",
        "signature": "(options: { camera: 'rear' | 'front'; x: number; y: number; width: number; height: number; toBack?: boolean; tapPhoto?: boolean; tapFocus?: boolean; alpha?: number; }) => Promise<{ success: boolean; }>",
        "parameters": [
          {
            "name": "options",
            "docs": "相机预览配置选项",
            "type": "{ camera: 'rear' | 'front'; x: number; y: number; width: number; height: number; toBack?: boolean | undefined; tapPhoto?: boolean | undefined; tapFocus?: boolean | undefined; alpha?: number | undefined; }"
          }
        ],
        "returns": "Promise<{ success: boolean; }>",
        "tags": [
          {
            "name": "param",
            "text": "options 相机预览配置选项"
          },
          {
            "name": "returns",
            "text": "操作结果"
          }
        ],
        "docs": "启动相机预览",
        "complexTypes": [],
        "slug": "startcamerapreview"
      },
      {
        "name": "stopCameraPreview",
        "signature": "() => Promise<{ success: boolean; }>",
        "parameters": [],
        "returns": "Promise<{ success: boolean; }>",
        "tags": [
          {
            "name": "returns",
            "text": "操作结果"
          }
        ],
        "docs": "停止相机预览",
        "complexTypes": [],
        "slug": "stopcamerapreview"
      },
      {
        "name": "rtspUpdatePos",
        "signature": "(options: { x: number; y: number; width: number; height: number; }) => Promise<{ success: boolean; message: string; }>",
        "parameters": [
          {
            "name": "options",
            "docs": "坐标参数",
            "type": "{ x: number; y: number; width: number; height: number; }"
          }
        ],
        "returns": "Promise<{ success: boolean; message: string; }>",
        "tags": [
          {
            "name": "param",
            "text": "options 坐标参数"
          },
          {
            "name": "returns",
            "text": "操作结果"
          }
        ],
        "docs": "更新RTSP预览位置 - 接收HTML滑动后的坐标变化",
        "complexTypes": [],
        "slug": "rtspupdatepos"
      },
      {
        "name": "rtspCreateDir",
        "signature": "(options: { directUrl: string; }) => Promise<{ success: boolean; message: string; }>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ directUrl: string; }"
          }
        ],
        "returns": "Promise<{ success: boolean; message: string; }>",
        "tags": [],
        "docs": "",
        "complexTypes": [],
        "slug": "rtspcreatedir"
      }
    ],
    "properties": []
  },
  "interfaces": [],
  "enums": [],
  "typeAliases": [],
  "pluginConfigs": []
}