Index

A

active_end_time (ZoneAlarm attribute) active_start_time (ZoneAlarm attribute) ADMIN (User.Role attribute) AdminMustExistError alarm_id (Alert attribute) alarms (Zone attribute) Alert (class in brainframe.api.bf_codecs.alarm_codecs)

AlertNotFoundError alerts (ZoneStatus attribute) ALL (NodeDescription.Size attribute) AnalysisLimitExceededError ASC (Ordering attribute) Attribute (class in brainframe.api.bf_codecs.detection_codecs) attributes (Detection attribute) (NodeDescription attribute)

B

BaseAPIError brainframe.api.bf_codecs.alarm_codecs module brainframe.api.bf_codecs.capsule_codecs module brainframe.api.bf_codecs.condition_codecs module brainframe.api.bf_codecs.config_codecs module brainframe.api.bf_codecs.detection_codecs module brainframe.api.bf_codecs.identity_codecs module

brainframe.api.bf_codecs.license_codecs module brainframe.api.bf_codecs.premises_codecs module brainframe.api.bf_codecs.sorting module brainframe.api.bf_codecs.user_codecs module brainframe.api.bf_errors module BrainFrameAPI (class in brainframe.api)

C

capability (Capsule attribute) Capsule (class in brainframe.api.bf_codecs.capsule_codecs) CapsuleNotFoundError CapsuleOption (class in brainframe.api.bf_codecs.capsule_codecs) CapsuleOption.Type (class in brainframe.api.bf_codecs.capsule_codecs) category (Attribute attribute) center() (Detection property) change (ZoneAlarmRateCondition attribute) check_analyzing() (BrainFrameAPI method) check_value (ZoneAlarmCountCondition attribute)

class_name (Detection attribute) (Encoding attribute) close() (BrainFrameAPI method) CloudUserNotFoundError connection_options (StreamConfiguration attribute) connection_type (StreamConfiguration attribute) constraints (CapsuleOption attribute) coords (Detection attribute) (Zone attribute) count_conditions (ZoneAlarm attribute)

D

DATE_FORMAT (in module brainframe.api.bf_codecs.license_codecs) default (CapsuleOption attribute) delete_encoding() (BrainFrameAPI method) delete_encodings() (BrainFrameAPI method) delete_identity() (BrainFrameAPI method) delete_premises() (BrainFrameAPI method) delete_storage() (BrainFrameAPI method) delete_stream_configuration() (BrainFrameAPI method) delete_user() (BrainFrameAPI method) delete_zone() (BrainFrameAPI method) delete_zone_alarm() (BrainFrameAPI method) DESC (Ordering attribute)

description (Capsule attribute) (CapsuleOption attribute) Detection (class in brainframe.api.bf_codecs.detection_codecs) detection_within_counts() (ZoneStatus property) detections (NodeDescription attribute) direction (ZoneAlarmRateCondition attribute) DuplicateIdentityNameError DuplicateStreamSourceError DuplicateUsernameError DuplicateVectorError DuplicateZoneNameError duration (ZoneAlarmRateCondition attribute)

E

EDITOR (User.Role attribute) encoded (NodeDescription attribute) Encoding (class in brainframe.api.bf_codecs.identity_codecs) EncodingNotFoundError end_time (Alert attribute)

entering (ZoneStatus attribute) exiting (ZoneStatus attribute) expiration_date (LicenseTerms attribute) EXPIRED (LicenseInfo.State attribute) extra_data (Detection attribute) (NodeDescription attribute)

F

field_name (SortOptions attribute) FILE (StreamConfiguration.ConnType attribute)

FrameNotFoundForAlertError from_image (Encoding attribute) FULL_FRAME_ZONE_NAME (Zone attribute)

G

get_alarm() (Zone method) get_alert() (BrainFrameAPI method) get_alert_frame() (BrainFrameAPI method) get_alerts() (BrainFrameAPI method) get_all_premises() (BrainFrameAPI method) get_capsule() (BrainFrameAPI method) get_capsule_option_vals() (BrainFrameAPI method) get_capsules() (BrainFrameAPI method) get_encoding() (BrainFrameAPI method) get_encoding_class_names() (BrainFrameAPI method) get_encodings() (BrainFrameAPI method) get_identities() (BrainFrameAPI method) get_identity() (BrainFrameAPI method) get_latest_zone_statuses() (BrainFrameAPI method)

get_license_info() (BrainFrameAPI method) get_premises() (BrainFrameAPI method) get_runtime_options() (BrainFrameAPI method) get_storage_data() (BrainFrameAPI method) get_storage_data_as_image() (BrainFrameAPI method) get_stream_configuration() (BrainFrameAPI method) get_stream_configurations() (BrainFrameAPI method) get_stream_url() (BrainFrameAPI method) get_user() (BrainFrameAPI method) get_users() (BrainFrameAPI method) get_zone() (BrainFrameAPI method) get_zone_alarm() (BrainFrameAPI method) get_zone_alarms() (BrainFrameAPI method) get_zone_status_stream() (BrainFrameAPI method) get_zones() (BrainFrameAPI method)

I

id (Alert attribute) (Encoding attribute) (Identity attribute) (Premises attribute) (StreamConfiguration attribute) (User attribute) (Zone attribute) (ZoneAlarm attribute) (ZoneAlarmCountCondition attribute) (ZoneAlarmRateCondition attribute) Identity (class in brainframe.api.bf_codecs.identity_codecs) identity_id (Encoding attribute) IdentityNotFoundError ImageAlreadyEncodedError ImageNotFoundForIdentityError

IncompatibleCapsuleError input_type (Capsule attribute) InsufficientRoleError intersection_point (ZoneAlarmCountCondition attribute) (ZoneAlarmRateCondition attribute) IntersectionPointType (class in brainframe.api.bf_codecs.condition_codecs) INVALID (LicenseInfo.State attribute) InvalidCapsuleError InvalidCapsuleOptionError InvalidFormatError InvalidImageTypeError InvalidRuntimeOptionError InvalidSessionError InvalidSyntaxError IP_CAMERA (StreamConfiguration.ConnType attribute) is_capsule_active() (BrainFrameAPI method)

J

journal_max_allowed_age (LicenseTerms attribute)

L

LicenseExpiredError LicenseInfo (class in brainframe.api.bf_codecs.license_codecs) LicenseInfo.State (class in brainframe.api.bf_codecs.license_codecs)

LicenseInvalidError LicenseRequiredError LicenseTerms (class in brainframe.api.bf_codecs.license_codecs)

M

max_streams (LicenseTerms attribute) metadata (Identity attribute) (StreamConfiguration attribute) MISSING (LicenseInfo.State attribute) module brainframe.api.bf_codecs.alarm_codecs brainframe.api.bf_codecs.capsule_codecs brainframe.api.bf_codecs.condition_codecs brainframe.api.bf_codecs.config_codecs brainframe.api.bf_codecs.detection_codecs brainframe.api.bf_codecs.identity_codecs brainframe.api.bf_codecs.license_codecs brainframe.api.bf_codecs.premises_codecs brainframe.api.bf_codecs.sorting brainframe.api.bf_codecs.user_codecs brainframe.api.bf_errors

N

name (Capsule attribute) (Premises attribute) (StreamConfiguration attribute) (Zone attribute) (ZoneAlarm attribute) new_identity_image() (BrainFrameAPI method) new_identity_vector() (BrainFrameAPI method) new_storage() (BrainFrameAPI method)

new_storage_as_image() (BrainFrameAPI method) nickname (Identity attribute) NodeDescription (class in brainframe.api.bf_codecs.capsule_codecs) NodeDescription.Size (class in brainframe.api.bf_codecs.capsule_codecs) NoDetectionsInImageError NoDetectorForClassError NoEncoderForClassError NONE (NodeDescription.Size attribute) NotImplementedInAPIError

O

online_checkin (LicenseTerms attribute) options (Capsule attribute)

Ordering (class in brainframe.api.bf_codecs.sorting) ordering (SortOptions attribute) output_type (Capsule attribute)

P

password (User attribute) patch_capsule_option_vals() (BrainFrameAPI method)

Premises (class in brainframe.api.bf_codecs.premises_codecs) premises_id (StreamConfiguration attribute) PremisesNotFoundError

R

rate_conditions (ZoneAlarm attribute) RemoteConnectionError

role (User attribute) runtime_options (StreamConfiguration attribute)

S

ServerNotReadyError set_alert_verification() (BrainFrameAPI method) set_capsule_active() (BrainFrameAPI method) set_capsule_option_vals() (BrainFrameAPI method) set_identity() (BrainFrameAPI method) set_license_key() (BrainFrameAPI method) set_premises() (BrainFrameAPI method) set_runtime_option_vals() (BrainFrameAPI method) set_stream_configuration() (BrainFrameAPI method) set_user() (BrainFrameAPI method) set_zone() (BrainFrameAPI method) set_zone_alarm() (BrainFrameAPI method) SINGLE (NodeDescription.Size attribute)

size (NodeDescription attribute) SortOptions (class in brainframe.api.bf_codecs.sorting) start_analyzing() (BrainFrameAPI method) start_time (Alert attribute) state (LicenseInfo attribute) stop_analyzing() (BrainFrameAPI method) StorageNotFoundError stream_id (Alert attribute) (Zone attribute) (ZoneAlarm attribute) StreamConfigNotFoundError StreamConfiguration (class in brainframe.api.bf_codecs.config_codecs) StreamConfiguration.ConnType (class in brainframe.api.bf_codecs.config_codecs) StreamNotOpenedError

T

terms (LicenseInfo attribute) test (ZoneAlarmCountCondition attribute) (ZoneAlarmRateCondition attribute) TooManyDetectionsInImageError total_entered (ZoneStatus attribute)

total_exited (ZoneStatus attribute) track_id (Detection attribute) tracked (NodeDescription attribute) tstamp (ZoneStatus attribute) type (CapsuleOption attribute)

U

UnauthorizedError UnauthorizedTokensError unique_name (Identity attribute) UnknownError

use_active_time (ZoneAlarm attribute) User (class in brainframe.api.bf_codecs.user_codecs) User.Role (class in brainframe.api.bf_codecs.user_codecs) username (User attribute) UserNotFoundError

V

VALID (LicenseInfo.State attribute) value (Attribute attribute) values() (CapsuleOption.Type class method) (NodeDescription.Size class method) (StreamConfiguration.ConnType class method) (User.Role class method) (ZoneAlarmCountCondition.TestType class method) (ZoneAlarmRateCondition.DirectionType class method) (ZoneAlarmRateCondition.TestType class method)

vector (Encoding attribute) VectorTooLongError verified_as (Alert attribute) version (Capsule attribute) version() (BrainFrameAPI method)

W

wait_for_server_initialization() (BrainFrameAPI method) WEBCAM (StreamConfiguration.ConnType attribute) window_duration (ZoneAlarmCountCondition attribute) window_threshold (ZoneAlarmCountCondition attribute) with_attribute (ZoneAlarmCountCondition attribute) (ZoneAlarmRateCondition attribute)

with_class_name (ZoneAlarmCountCondition attribute) (ZoneAlarmRateCondition attribute) with_identity (Detection attribute) within (ZoneStatus attribute)

Z

Zone (class in brainframe.api.bf_codecs.zone_codecs) zone (ZoneStatus attribute) zone_id (Alert attribute) (ZoneAlarm attribute) ZoneAlarm (class in brainframe.api.bf_codecs.alarm_codecs) ZoneAlarmCountCondition (class in brainframe.api.bf_codecs.condition_codecs) ZoneAlarmCountCondition.TestType (class in brainframe.api.bf_codecs.condition_codecs)

ZoneAlarmNotFoundError ZoneAlarmRateCondition (class in brainframe.api.bf_codecs.condition_codecs) ZoneAlarmRateCondition.DirectionType (class in brainframe.api.bf_codecs.condition_codecs) ZoneAlarmRateCondition.TestType (class in brainframe.api.bf_codecs.condition_codecs) ZoneNotDeletableError ZoneNotEditableError ZoneNotFoundError ZoneStatus (class in brainframe.api.bf_codecs.zone_codecs)