Documentation for Axxon One 1.0.

Previous page Get info about archives using gRPC API methods  Remove archive using gRPC API methods Next page

Creating an archive entity

{
    "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
        "added": [
            {
                "uid": "hosts/Server1",
                "units": [
                    {
                        "type": "MultimediaStorage",
                        "properties": [
                            {
                                "id": "color",
                                "value_string": "Pink",
                                "properties": []
                            },
                            {
                                "id": "display_name",
                                "value_string": "Pink",
                                "properties": []
                            }
                        ],
                        "units": [],
                        "opaque_params": []
                    }
                ],
                "opaque_params": []
            }
        ]
    }
}

where

  • uid − Server on which the archive is created;
  • units − properties.

Adding an archive file

{
    "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
        "added": [
            {
                "uid": "hosts/Server1/MultimediaStorage.Red",
                "units": [
                    {
                        "type": "ArchiveVolume",
                        "properties": [
                            {
                                "id": "volume_type",
                                "properties": [
                                    {
                                        "id": "file_name",
                                        "value_string": "D:/archiveRed.afs"
                                    }
                                ],
                                "value_string": "local"
                            },
                            {
                                "id": "file_size",
                                "value_int32": 2
                            },
                            {
                                "id": "format",
                                "value_bool": true
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

Linking a camera to archive

Creating an ArchiveContext with constant recording:

{
    "method": "axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data": {
        "added": [
            {
                "uid": "hosts/Server1/MultimediaStorage.Yellow",
                "units": [
                    {
                        "type": "ArchiveContext",
                        "properties": [
                            {
                                "id": "camera_ref",
                                "value_string": "hosts/Server1/DeviceIpint.10/SourceEndpoint.video:0:0"
                            },
                            {
                                "id": "constant_recording",
                                "value_bool": true
                            },
                            {
                                "id": "prerecord_sec",
                                "value_int32": 0
                            },
                            {
                                "id": "specific_fps",
                                "value_double": 0
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

The response will contain uid of the added ArchiveContext:

{
    "failed": [],
    "added": [
        "hosts/Server1/MultimediaStorage.Yellow/ArchiveContext/b73f4b6c-2962-5d51-e9ee-ceb5420b4cd2"
    ]
}

Changing a stream linked to the archive

{
    "method":"axxonsoft.bl.config.ConfigurationService.ChangeConfig",
    "data":{
        "changed":[{
              "uid": "hosts/Server1/MultimediaStorage.Aqua/ArchiveContext/b73f4b6c-2962-5d51-e9ee-ceb5420b4cd2",
              "type": "ArchiveContext",
              "properties": [
                {
                  "id": "streaming_id",
                  "value_string": "hosts/Server1/DeviceIpint.10/SourceEndpoint.video:0:0"
                }]
            }
        ]
    }
}
  • No labels