Class IOnvifClient

Namespace

VAST.ONVIF

Assembly

VAST.ONVIF.dll

Abstract base class for ONVIF client implementations. Provides common properties and methods for connecting to and communicating with ONVIF-compliant devices.

public abstract class IOnvifClient : IDisposable

Inheritance

object

IOnvifClient

Implements

IDisposable

Derived

OnvifClient1

OnvifClient2

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

IOnvifClient(string, string, string)

Initializes a new instance of the IOnvifClient class.

public IOnvifClient(string uri, string username, string password)

Parameters

uri string

The URI of the ONVIF device.

username string

The username for device authentication.

password string

The password for device authentication.

Properties

CameraControl

Gets or sets the camera control interface for PTZ and encoder operations.

public ICameraControl CameraControl { get; protected set; }

Property Value

ICameraControl

Firmware

Gets or sets the firmware version of the ONVIF device.

public string Firmware { get; protected set; }

Property Value

string

HwID

Gets or sets the hardware identifier of the ONVIF device.

public string HwID { get; protected set; }

Property Value

string

IP

Gets or sets the IP address of the ONVIF device.

public string IP { get; protected set; }

Property Value

string

MACAddress

Gets or sets the MAC address of the ONVIF device.

public string MACAddress { get; protected set; }

Property Value

string

Manufacturer

Gets or sets the manufacturer name of the ONVIF device.

public string Manufacturer { get; protected set; }

Property Value

string

Model

Gets or sets the model name of the ONVIF device.

public string Model { get; protected set; }

Property Value

string

Password

Gets or sets the password used for device authentication.

public string Password { get; protected set; }

Property Value

string

Port

Gets or sets the port number of the ONVIF device.

public int Port { get; protected set; }

Property Value

int

Serial

Gets or sets the serial number of the ONVIF device.

public string Serial { get; protected set; }

Property Value

string

StreamingUris

Gets or sets the list of streaming URIs retrieved from the ONVIF device.

public List<OnvifUri> StreamingUris { get; protected set; }

Property Value

List<OnvifUri>

Username

Gets or sets the username used for device authentication.

public string Username { get; protected set; }

Property Value

string

Methods

Dispose()

Releases all resources used by the IOnvifClient instance.

public abstract void Dispose()

OpenAsync()

Connects to the ONVIF device, retrieves device information, media profiles, and streaming URIs.

public abstract Task OpenAsync()

Returns

Task

A task that represents the asynchronous open operation.

TakeSnapshot()

Takes a snapshot from the ONVIF device and returns it as a stream.

public abstract Task<Stream> TakeSnapshot()

Returns

Task<Stream>

A task that represents the asynchronous operation, containing the snapshot image stream.