{
  "api": {
    "name": "ScreenRecorderPlugin",
    "slug": "screenrecorderplugin",
    "docs": "Capacitor Screen Recorder Plugin for recording the device screen.\nAllows you to capture video recordings of the screen with optional audio.",
    "tags": [
      {
        "text": "1.0.0",
        "name": "since"
      }
    ],
    "methods": [
      {
        "name": "start",
        "signature": "(options?: { recordAudio?: boolean | undefined; } | undefined) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "- Recording configuration options",
            "type": "{ recordAudio?: boolean | undefined; } | undefined"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "options - Recording configuration options"
          },
          {
            "name": "param",
            "text": "options.recordAudio - Whether to record audio along with the screen video. Defaults to false."
          },
          {
            "name": "returns",
            "text": "Promise that resolves when recording starts"
          },
          {
            "name": "throws",
            "text": "Error if recording fails to start or permissions are denied"
          },
          {
            "name": "since",
            "text": "1.0.0"
          },
          {
            "name": "example",
            "text": "```typescript\n// Start recording without audio\nawait ScreenRecorder.start();\n\n// Start recording with audio\nawait ScreenRecorder.start({ recordAudio: true });\n```"
          }
        ],
        "docs": "Start recording the device screen.\n\nInitiates screen recording with optional audio capture. The user will be\nprompted to grant screen recording permissions if not already granted.\nOn iOS, the system recording UI will be displayed. On Android, the recording\nstarts immediately after permission is granted.",
        "complexTypes": [],
        "slug": "start"
      },
      {
        "name": "stop",
        "signature": "() => Promise<void>",
        "parameters": [],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "returns",
            "text": "Promise that resolves when recording stops and the video is saved"
          },
          {
            "name": "throws",
            "text": "Error if stopping the recording fails or no recording is active"
          },
          {
            "name": "since",
            "text": "1.0.0"
          },
          {
            "name": "example",
            "text": "```typescript\nawait ScreenRecorder.stop();\nconsole.log('Recording saved to gallery');\n```"
          }
        ],
        "docs": "Stop the current screen recording.\n\nStops the active screen recording and saves the video to the device's\ncamera roll or gallery. On iOS, the system will show a preview of the\nrecording. On Android, the video is saved directly to the gallery.",
        "complexTypes": [],
        "slug": "stop"
      },
      {
        "name": "getPluginVersion",
        "signature": "() => Promise<{ version: string; }>",
        "parameters": [],
        "returns": "Promise<{ version: string; }>",
        "tags": [
          {
            "name": "returns",
            "text": "Promise that resolves with the plugin version"
          },
          {
            "name": "throws",
            "text": "Error if getting the version fails"
          },
          {
            "name": "since",
            "text": "1.0.0"
          },
          {
            "name": "example",
            "text": "```typescript\nconst { version } = await ScreenRecorder.getPluginVersion();\nconsole.log('Plugin version:', version);\n```"
          }
        ],
        "docs": "Get the native Capacitor plugin version.",
        "complexTypes": [],
        "slug": "getpluginversion"
      }
    ],
    "properties": []
  },
  "interfaces": [],
  "enums": [],
  "typeAliases": [],
  "pluginConfigs": []
}