screen_record_start

macOS

Назначение

Начинает запись экрана (ScreenCaptureKit) для дисплея, окна или области. В v1 допускается один активный сеанс — повторный запуск возвращает already_recording. Возвращает session_id, который используют record_marker и screen_record_stop. Требует разрешения на запись экрана; без него возвращает явную ошибку permission_required, а не молча ничего не делает. Первый вызов показывает предпросмотр; confirm: true запускает запись.

Обязательные входные данные

• target

Имена сохранены в точности как их требует инструмент. Канонические технические определения на английском находятся в раскрываемой схеме ниже.

Разрешения и подтверждение

Схема объявляет явный параметр подтверждения. Проверьте предварительный результат и разрешите реальную операцию согласно контракту платформы.

• Используйте на этой платформе только приложения, учетные записи и ресурсы, разрешенные пользователем. Требования к подключению и разрешениям приведены в описании инструмента для конкретной платформы; этот каталог не заявляет о дополнительных областях OAuth или разрешениях OS.

{
  "properties": {
    "confirm": {
      "description": "Must be true to start recording. Without it the call returns a preview and captures nothing.",
      "type": "boolean"
    },
    "fps": {
      "description": "Frames per second (default 60).",
      "type": "integer"
    },
    "output_path": {
      "description": "Where to write the .mov (default: temp file, returned by stop). Missing parent folders are created.",
      "type": "string"
    },
    "show_cursor": {
      "description": "Default true.",
      "type": "boolean"
    },
    "target": {
      "description": "What to capture.",
      "properties": {
        "display_id": {
          "description": "Required if kind=display.",
          "type": "string"
        },
        "kind": {
          "enum": [
            "display",
            "window",
            "region"
          ],
          "type": "string"
        },
        "region": {
          "description": "Required if kind=region: {x,y,w,h} global points.",
          "type": "object"
        },
        "window_id": {
          "description": "Required if kind=window.",
          "type": "string"
        }
      },
      "required": [
        "kind"
      ],
      "type": "object"
    }
  },
  "required": [
    "target"
  ],
  "type": "object"
}

Пример для документации

Пример документации для screen_record_start. Не выполняйте этот пример. Показанные аргументы относятся к вымышленному набору данных; перед реальным вызовом найдите настоящие идентификаторы и получите разрешение.

{
  "confirm": false,
  "target": {
    "display_id": "1",
    "kind": "display"
  }
}