category: IT Services
sectionorder:
- Connect
- Collect
provider: Ubiquiti
commonfields:
  id: UnifiVideo
  version: -1
configuration:
- display: API Key
  name: api_key
  required: true
  type: 4
  section: Connect
- display: IP address or hostname
  name: addr
  required: true
  type: 0
  section: Connect
- defaultvalue: '7080'
  display: Port number
  name: port
  type: 0
  required: false
  section: Connect
- defaultvalue: http
  display: Schema
  name: schema
  options:
  - http
  - https
  type: 15
  required: false
  section: Connect
- defaultvalue: 'true'
  display: Verify CA cert
  name: verify_cert
  type: 8
  required: false
  section: Connect
- display: Fetch incidents
  name: isFetch
  type: 8
  required: false
  section: Collect
- display: Incident type
  name: incidentType
  type: 13
  required: false
  section: Collect
- display: Incidents Fetch Interval
  name: incidentFetchInterval
  defaultvalue: '1'
  required: false
  type: 19
  advanced: true
  section: Collect
- defaultvalue: 10 minutes
  display: First fetch timestamp (<number> <time unit>, e.g., 12 hours, 7 days, 3 months, 1 year)
  name: fetch_time
  type: 0
  required: false
  section: Collect
- defaultvalue: '50'
  display: Fetch Limit (unlimited=0)
  name: fetch_limit
  type: 0
  required: false
  section: Collect
description: |-
  Connect to UnifiVideo NVR and manage CCTV cameras!

  This integration allows you to fetch motion recording events as incidents.

  The integration commands also allow downloading snapshots, recordings and controlling the camera infra-red capabilities.
display: UnifiVideo
name: UnifiVideo
script:
  commands:
  - description: Gets the list of cameras bound with the NVR.
    name: unifivideo-get-camera-list
    outputs:
    - contextPath: UnifiVideo.Cameras
      description: The camera list.
      type: Unknown
  - arguments:
    - description: The name of the camera.
      name: camera_name
      required: true
    description: The name of the camera to take the snapshot from. If empty then all camera snapshots will be taken.
    name: unifivideo-get-snapshot
  - arguments:
    - description: The id of the recording.
      name: recording_id
      required: true
    description: Download a recording to file.
    name: unifivideo-get-recording
    outputs:
    - contextPath: UnifiVideo.Recordings
      description: The recording list.
      type: Unknown
  - arguments:
    - description: The camera name.
      name: camera_name
      required: true
    - auto: PREDEFINED
      defaultValue: motion
      description: Recording setting, motion,fulltime or disable.
      name: rec_set
      predefined:
      - fulltime
      - motion
      - disable
      required: true
    description: Set the recording settings.
    execution: true
    name: unifivideo-set-recording-settings
  - arguments:
    - description: The camera name.
      name: camera_name
      required: true
    - auto: PREDEFINED
      defaultValue: auto
      description: The Infra-Red LED mode.
      name: ir_leds
      predefined:
      - auto
      - 'on'
      - 'off'
      required: true
    description: Turn ON or OFF the camera Infra-Red LED.
    execution: true
    name: unifivideo-ir-leds
  - description: Get the list of all recordings.
    execution: true
    name: unifivideo-get-recording-list
  - arguments:
    - description: File entryID of the video file.
      name: entryid
      required: true
    - description: Frame to take from the video.
      name: frame
      required: true
    description: Get a snapshot from video file based on the frame number.
    name: unifivideo-get-snapshot-at-frame
  - arguments:
    - defaultValue: '150'
      description: The frame to snapshot.
      name: frame
      required: true
    - description: the ubnt_id of the recording.
      name: recording_id
      required: true
    description: Get the recording snapshot (at frame) based on the recording id.
    name: unifivideo-get-recording-snapshot
  - arguments:
    - description: the ubnt_id of the recording.
      name: recording_id
      required: true
    description: Gets the frame snapshot that has triggered the motion event.
    name: unifivideo-get-recording-motion-snapshot
  dockerimage: demisto/unifi-video:1.0.0.9094740
  isfetch: true
  runonce: true
  script: '-'
  subtype: python3
  type: python
tests:
- No tests (auto formatted)
fromversion: 6.0.0