Skip to content

api/onvif.h

Namespaces

Name
cvedia
cvedia::rt
API for controlling the server and lifecycle management of runtime instances.
cvedia::rt::api
cvedia::rt::api::onvif

Functions

Name
expected< void > discoverDevices()
expected< std::shared_ptr< iface::OnvifDevice > > getDevice(Uuid const & deviceUuid)
std::map< Uuid, std::shared_ptr< iface::OnvifDevice > > getDevices()
std::map< Uuid, std::shared_ptr< iface::OnvifDevice > > getDevicesSeen()
expected< std::vector< iface::OnvifStream > > getStreams(Uuid const & deviceUuid)
expected< bool > setCredentials(Uuid const & deviceUuid, std::string const & username, std::string const & password)
expected< void > saveToDisk()
expected< void > removeDevice(Uuid const & deviceUuid)
expected< std::shared_ptr< iface::OnvifDevice > > addDevice(std::string const & xaddr, std::string const & username ="", std::string const & password ="")
expected< nlohmann::json > probeDevice(std::string const & xaddr, std::string const & username ="", std::string const & password ="")
Probe an ONVIF device at the given address to verify credentials and retrieve device/stream information.

Functions Documentation

function discoverDevices

expected< void > discoverDevices()

function getDevice

expected< std::shared_ptr< iface::OnvifDevice > > getDevice(
    Uuid const & deviceUuid
)

function getDevices

std::map< Uuid, std::shared_ptr< iface::OnvifDevice > > getDevices()

function getDevicesSeen

std::map< Uuid, std::shared_ptr< iface::OnvifDevice > > getDevicesSeen()

function getStreams

expected< std::vector< iface::OnvifStream > > getStreams(
    Uuid const & deviceUuid
)

function setCredentials

expected< bool > setCredentials(
    Uuid const & deviceUuid,
    std::string const & username,
    std::string const & password
)

function saveToDisk

expected< void > saveToDisk()

function removeDevice

expected< void > removeDevice(
    Uuid const & deviceUuid
)

function addDevice

expected< std::shared_ptr< iface::OnvifDevice > > addDevice(
    std::string const & xaddr,
    std::string const & username ="",
    std::string const & password =""
)

function probeDevice

expected< nlohmann::json > probeDevice(
    std::string const & xaddr,
    std::string const & username ="",
    std::string const & password =""
)

Probe an ONVIF device at the given address to verify credentials and retrieve device/stream information.

Parameters:

  • xaddr ONVIF device service address
  • username Camera username (empty for no auth)
  • password Camera password (empty for no auth)

Return: expected Device info as JSON, or error