Skip to content

Camera (Batch)

ActionBatchCamera

ActionBatchCamera class.

update_device_camera_custom_analytics

Update custom analytics settings for a camera.

API documentation: updateDeviceCameraCustomAnalytics

Parameters:

  • serial (str) –

    Serial.

  • enabled (bool | None, default: None ) –

    Enable custom analytics.

  • artifact_id (str | None, default: None ) –

    The ID of the custom analytics artifact.

  • parameters (list[UpdateDeviceCameraCustomAnalyticsParametersItem] | None, default: None ) –

    Parameters for the custom analytics workload.

update_device_camera_quality_and_retention

Update quality and retention settings for the given camera.

API documentation: updateDeviceCameraQualityAndRetention

Parameters:

  • serial (str) –

    Serial.

  • profile_id (str | None, default: None ) –

    The ID of a quality and retention profile to assign to the camera. The profile's settings will override all of the per-camera quality and retention settings. If the value of this parameter is null, any existing profile will be unassigned from the camera.

  • motion_based_retention_enabled (bool | None, default: None ) –

    Boolean indicating if motion-based retention is enabled(true) or disabled(false) on the camera.

  • audio_recording_enabled (bool | None, default: None ) –

    Boolean indicating if audio recording is enabled(true) or disabled(false) on the camera.

  • restricted_bandwidth_mode_enabled (bool | None, default: None ) –

    Boolean indicating if restricted bandwidth is enabled(true) or disabled(false) on the camera. This setting does not apply to MV2 cameras.

  • quality (UpdateDeviceCameraQualityAndRetentionQuality | None, default: None ) –

    Quality of the camera. Can be one of 'Standard', 'High', 'Enhanced' or 'Ultra'. Not all qualities are supported by every camera model.

  • resolution (UpdateDeviceCameraQualityAndRetentionResolution | None, default: None ) –

    Resolution of the camera. Can be one of '1280x720', '1920x1080', '1080x1080', '2112x2112', '2880x2880', '2688x1512' or '3840x2160'.Not all resolutions are supported by every camera model.

  • motion_detector_version (UpdateDeviceCameraQualityAndRetentionMotionDetectorVersion | None, default: None ) –

    The version of the motion detector that will be used by the camera. Only applies to Gen 2 cameras. Defaults to v2.

update_device_camera_sense

Update sense settings for the given camera.

API documentation: updateDeviceCameraSense

Parameters:

  • serial (str) –

    Serial.

  • sense_enabled (bool | None, default: None ) –

    Boolean indicating if sense(license) is enabled(true) or disabled(false) on the camera.

  • mqtt_broker_id (str | None, default: None ) –

    The ID of the MQTT broker to be enabled on the camera. A value of null will disable MQTT on the camera.

  • audio_detection (UpdateDeviceCameraSenseAudioDetection | None, default: None ) –

    The details of the audio detection config.

  • detection_model_id (str | None, default: None ) –

    The ID of the object detection model.

update_device_camera_video_settings

Update video settings for the given camera.

API documentation: updateDeviceCameraVideoSettings

Parameters:

  • serial (str) –

    Serial.

  • external_rtsp_enabled (bool | None, default: None ) –

    Boolean indicating if external rtsp stream is exposed.

update_device_camera_wireless_profiles

Assign wireless profiles to the given camera.

API documentation: updateDeviceCameraWirelessProfiles

Parameters:

  • serial (str) –

    Serial.

  • ids (UpdateDeviceCameraWirelessProfilesIds) –

    The ids of the wireless profile to assign to the given camera.