Class ONVIFControlX

ONVIF camera control class.

Inheritance

object

ONVIFControlX

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: VisioForge.Core.VideoCapture

Assembly: VisioForge.Core.dll

Syntax

public class ONVIFControlX : IDisposable

Constructors

ONVIFControlX()

Initializes a new instance of the ONVIFControlX class.

Declaration

public ONVIFControlX()

ONVIFControlX(BaseContext)

Initializes a new instance of the ONVIFControlX class.

Declaration

public ONVIFControlX(BaseContext context)

Parameters

Type	Name	Description
BaseContext	context	The context.

Methods

Connect(IPEndPoint, string, string, TimeSpan?)

Connects the specified IP.

Declaration

public bool Connect(IPEndPoint ip, string username, string password, TimeSpan? timeout = null)

Parameters

Type	Name	Description
IPEndPoint	ip	The IP.
string	username	The username.
string	password	The password.
TimeSpan?	timeout	The timeout.

Returns

Type	Description
bool	true if successful, false otherwise.

Connect(string, string, string, TimeSpan?)

Connects to camera.

Declaration

public bool Connect(string url, string username, string password, TimeSpan? timeout = null)

Parameters

Type	Name	Description
string	url	ONVIF url (like http://192.168.1.100/onvif/device_service).
string	username	User name.
string	password	Password.
TimeSpan?	timeout	Timeout. We suggest to use 5-10 seconds.

Returns

Type	Description
bool	The bool.

Connect(Uri, string, string, TimeSpan?)

Connects to camera.

Declaration

public bool Connect(Uri url, string username, string password, TimeSpan? timeout = null)

Parameters

Type	Name	Description
Uri	url	ONVIF url (like http://192.168.1.100/onvif/device_service).
string	username	User name.
string	password	Password.
TimeSpan?	timeout	Timeout. We suggest to use 5-10 seconds.

Returns

Type	Description
bool	The bool.

ConnectAsync(IPEndPoint, string, string, TimeSpan?)

Connects the asynchronous.

Declaration

public Task<bool> ConnectAsync(IPEndPoint ip, string username, string password, TimeSpan? timeout = null)

Parameters

Type	Name	Description
IPEndPoint	ip	The IP.
string	username	The username.
string	password	The password.
TimeSpan?	timeout	The timeout.

Returns

Type	Description
Task<bool>	Task<System.Boolean>.

ConnectAsync(string, string, string, TimeSpan?)

Connects to camera (async).

Declaration

public Task<bool> ConnectAsync(string url, string username, string password, TimeSpan? timeout = null)

Parameters

Type	Name	Description
string	url	ONVIF url (like http://192.168.1.100/onvif/device_service).
string	username	User name.
string	password	Password.
TimeSpan?	timeout	Timeout. We suggest to use 5-10 seconds.

Returns

Type	Description
Task<bool>	The bool.

ConnectAsync(Uri, string, string, TimeSpan?)

Connects to camera (async).

Declaration

public Task<bool> ConnectAsync(Uri url, string username, string password, TimeSpan? timeout = null)

Parameters

Type	Name	Description
Uri	url	ONVIF url (like http://192.168.1.100/onvif/device_service).
string	username	User name.
string	password	Password.
TimeSpan?	timeout	Timeout. We suggest to use 5-10 seconds.

Returns

Type	Description
Task<bool>	The bool.

Disconnect()

Disconnects from camera.

Declaration

public void Disconnect()

DisconnectAsync()

Disconnects from camera (async).

Declaration

public Task DisconnectAsync()

Returns

Type	Description
Task	The Task.

Dispose()

Dispose.

Declaration

public void Dispose()

Dispose(bool)

Dispose.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing	Disposing parameter.

~ONVIFControlX()

Finalizes an instance of the ONVIFControlX class.

Declaration

protected ~ONVIFControlX()

GetDeviceCapabilities()

Gets the device capabilities.

Declaration

public Capabilities GetDeviceCapabilities()

Returns

Type	Description
Capabilities	Capabilities12.

GetDeviceCapabilitiesAsync()

Gets the device capabilities asynchronous.

Declaration

public Task<Capabilities> GetDeviceCapabilitiesAsync()

Returns

Type	Description
Task<Capabilities>	Task<Capabilities12>.

GetDeviceInformation()

Gets device information.

Declaration

public ONVIFDeviceInformation GetDeviceInformation()

Returns

Type	Description
ONVIFDeviceInformation	The ONVIFDeviceInformation.

GetDeviceInformationAsync()

Gets device information (async).

Declaration

public Task<ONVIFDeviceInformation> GetDeviceInformationAsync()

Returns

Type	Description
Task<ONVIFDeviceInformation>	The ONVIFDeviceInformation.

GetMediaEndpoints()

Gets the media endpoints.

Declaration

public MediaEndpointX[] GetMediaEndpoints()

Returns

Type	Description
MediaEndpointX[]	MediaEndpoint[].

GetMediaEndpointsAsync()

Gets the media endpoints asynchronous.

Declaration

public Task<MediaEndpointX[]> GetMediaEndpointsAsync()

Returns

Type	Description
Task<MediaEndpointX[]>	Task<MediaEndpoint[]>.

GetProfiles()

Gets video profiles.

Declaration

public Profile[] GetProfiles()

Returns

Type	Description
Profile[]	The Profile[].

GetProfilesAsync()

Gets video profiles (async).

Declaration

public Task<Profile[]> GetProfilesAsync()

Returns

Type	Description
Task<Profile[]>	The Profile[].

GetVideoURL(int)

Get direct video URL (usually RTSP).

Declaration

public string GetVideoURL(int profileIndex = 0)

Parameters

Type	Name	Description
int	profileIndex	Profile index. First profile used by default.

Returns

Type	Description
string	The string.

GetVideoURL(string)

Get direct video URL (usually RTSP).

Declaration

public string GetVideoURL(string profileName)

Parameters

Type	Name	Description
string	profileName	Profile name.

Returns

Type	Description
string	The string.

GetVideoURLAsync(int)

Get direct video URL (usually RTSP).

Declaration

public Task<string> GetVideoURLAsync(int profileIndex = 0)

Parameters

Type	Name	Description
int	profileIndex	Profile index. First profile used by default.

Returns

Type	Description
Task<string>	The string.

GetVideoURLAsync(string)

Get direct video URL (usually RTSP).

Declaration

public Task<string> GetVideoURLAsync(string profileName)

Parameters

Type	Name	Description
string	profileName	Profile name.

Returns

Type	Description
Task<string>	The string.

PTZ_GetRanges()

Gets PTZ ranges for camera.

Declaration

public ONVIFPTZRanges PTZ_GetRanges()

Returns

Type	Description
ONVIFPTZRanges	The ONVIFPTZRanges.

PTZ_GetRangesAsync()

Gets PTZ ranges for camera (async).

Declaration

public Task<ONVIFPTZRanges> PTZ_GetRangesAsync()

Returns

Type	Description
Task<ONVIFPTZRanges>	The ONVIFPTZRanges.

PTZ_SetAbsolute(float, float, float)

Set absolute pan-tilt-zoom values. Check ranges before usage.

Declaration

public bool PTZ_SetAbsolute(float x, float y, float z)

Parameters

Type	Name	Description
float	x	X.
float	y	Y.
float	z	Zoom.

Returns

Type	Description
bool

PTZ_SetAbsoluteAsync(float, float, float)

Set absolute pan-tilt-zoom values (async). Check ranges before usage.

Declaration

public Task PTZ_SetAbsoluteAsync(float x, float y, float z)

Parameters

Type	Name	Description
float	x	X.
float	y	Y.
float	z	Zoom.

Returns

Type	Description
Task	Task.

PTZ_SetHome()

Sets PTZ home position.

Declaration

public bool PTZ_SetHome()

Returns

Type	Description
bool	The bool.

PTZ_SetHomeAsync()

Sets PTZ home position.

Declaration

public Task<bool> PTZ_SetHomeAsync()

Returns

Type	Description
Task<bool>	The bool.

Implements

IDisposable