CameraGroup

class CameraGroup
property id

The id of the group.

Type

str, read-only

property name

The name of the group.

Type

str

Raises

ReadOnlyError -- If Database is in read only mode.

property parent_group

The parent group of this group or None if the group is at the root of the hierarchy.

Type

CameraGroup or None

Raises

ReadOnlyError -- If Database is in read only mode.

list_cameras(recursive = True)

List the cameras of the group.

Parameters

recursive (bool) -- If True, list all cameras in this group and child groups, otherwise only cameras of this group are returned.

Returns

The list of cameras in the group.

Return type

list(Camera)

list_child_groups(recursive = True)

List the child camera groups of this group.

Parameters

recursive (bool) -- If True, list camera groups of this group recursively, otherwise only the direct child groups are returned.

Returns

The list of child groups.

Return type

list(CameraGroup)

remove(force = False)

Delete a camera group

Note

By default, only empty groups can be deleted (NotEmptyError is raised otherwise), use force to force deletion of non empty groups.

Parameters

force (bool) -- Force the deletion of the group even if it contains cameras and/or groups.

Raises