Class for wrapping the Ptz related commands. More...

Inheritance diagram for VideoOS.Mobile.SDK.Portable.Server.Base.Connection.Ptz:

Public Member Functions

IAsyncResult ControlPtz (PtzParams tPtzParams, OnResponse< BaseCommandResponse > onSuccess=null, OnResponse< BaseCommandResponse > onFail=null)

Method for set of ptz on camera or current stream from the Mobile Server (should be live stream).

Implemented by the Video object.
Sends message to the Mobile and returns IAsyncResult.
If method succeeds IAsyncResult.AsyncState contains null object.

Parameters

ptzParams	PTZ paramters for move.
onSuccess	Callback called on success.
onFail	Callback called on fail.

Returns: IAsyncResult implementer.

BaseCommandResponse ControlPtz (PtzParams tPtzParams, TimeSpan timeout)

Method for set of ptz on camera or current stream from the Mobile Server (should be live stream).

Implemented by the Video & Ptz objects.
Sends message to the Mobile server and returns BaseCommandResponse.
Error status message could be obtained with query of IErrorResult.

Parameters

ptzParams	PTZ paramters for move.
timeout

Returns: BaseCommandResponse object

async Task< BaseCommandResponse > ControlPtzAsync (PtzParams tPtzParams, TimeSpan timeout)

Method for set of ptz on camera or current stream from the Mobile Server (should be live stream).

Implemented by the Video & Ptz objects.
Sends message to the Mobile server and returns Task<BaseCommandResponse>.
Error status message could be obtained with query of IErrorResult.

Parameters

ptzParams	PTZ paramters for move.
timeout	Time to wait the responce from the server

Returns: Task<BaseCommandResponse> object

IAsyncResult GetPtzPresets (Guid cameraId, OnResponse< GetPtzPresetsResponse > onSuccess=null, OnResponse< GetPtzPresetsResponse > onFail=null)

Method for get of ptz presets on camera or current stream from the Mobile Server (should be live stream)

Implemented by the Video object.
Sends message to the Mobile and returns IAsyncResult.
If method succeeds IAsyncResult.AsyncState contains GetPtzPresetsResponse object.

Parameters

cameraId	Id of the camera
onSuccess	Callback called on success.
onFail	Callback called on fail.

Returns: IAsyncResult implementer.

GetPtzPresetsResponse GetPtzPresets (Guid cameraId, TimeSpan timeout)

Method for get of ptz presets on camera or current stream from the Mobile Server (should be live stream).

Implemented by the Video & Ptz object.
Sends message to the Mobile server and returns GetPtzPresetsResponse.
If the method succeeds result is not null and consist all the supported presets.
Error status message could be obtained with query of IErrorResult.

Parameters

cameraId	Id of the camera
timeout

Returns: GetPtzPresetsResponse object

async Task< GetPtzPresetsResponse > GetPtzPresetsAsync (Guid cameraId, TimeSpan timeout)

Method for get of ptz presets on camera or current stream from the Mobile Server (should be live stream).

Implemented by the Video & Ptz object.
Sends message to the Mobile server and returns Task<GetPtzPresetsResponse>.
If the method succeeds result is not null and consist all the supported presets.
Error status message could be obtained with query of IErrorResult.

Parameters

cameraId	Id of the camera
timeout	Time to wait the responce from the server

Returns: Task<GetPtzPresetsResponse> object

Ptz (IConnection connection)

Constructor.

Ptz (IConnection connection, Guid videoId)

COnstructor.

Public Member Functions inherited from VideoOS.Mobile.SDK.Portable.Server.Interfaces.IPtzSync

Public Member Functions inherited from VideoOS.Mobile.SDK.Portable.Server.Interfaces.IPtzAsync

Public Member Functions inherited from VideoOS.Mobile.SDK.Portable.Server.Interfaces.IPtzAwait

Detailed Description

Class for wrapping the Ptz related commands.

See also: IPtzSync, IPtzAsync, IPtzAwait

Constructor & Destructor Documentation

◆ Ptz() [1/2]

VideoOS.Mobile.SDK.Portable.Server.Base.Connection.Ptz.Ptz ( IConnection connection )

inline

Constructor.

Parameters

connection IConnection implementer

◆ Ptz() [2/2]

VideoOS.Mobile.SDK.Portable.Server.Base.Connection.Ptz.Ptz	(	IConnection	connection,
		Guid	videoId )

inline

COnstructor.

Parameters

connection	IConnection implementer
videoId	Id of the video stream

Member Function Documentation

◆ ControlPtz() [1/2]

IAsyncResult VideoOS.Mobile.SDK.Portable.Server.Base.Connection.Ptz.ControlPtz	(	PtzParams	tPtzParams,
		OnResponse< BaseCommandResponse >	onSuccess = null,
		OnResponse< BaseCommandResponse >	onFail = null )

inline

Method for set of ptz on camera or current stream from the Mobile Server (should be live stream).

Implemented by the Video object.
Sends message to the Mobile and returns IAsyncResult.
If method succeeds IAsyncResult.AsyncState contains null object.

Parameters

ptzParams	PTZ paramters for move.
onSuccess	Callback called on success.
onFail	Callback called on fail.

Returns: IAsyncResult implementer.

Implements VideoOS.Mobile.SDK.Portable.Server.Interfaces.IPtzAsync.

◆ ControlPtz() [2/2]

BaseCommandResponse VideoOS.Mobile.SDK.Portable.Server.Base.Connection.Ptz.ControlPtz	(	PtzParams	tPtzParams,
		TimeSpan	timeout )

inline

Method for set of ptz on camera or current stream from the Mobile Server (should be live stream).

Implemented by the Video & Ptz objects.
Sends message to the Mobile server and returns BaseCommandResponse.
Error status message could be obtained with query of IErrorResult.

Parameters

ptzParams	PTZ paramters for move.
timeout

Returns: BaseCommandResponse object

Implements VideoOS.Mobile.SDK.Portable.Server.Interfaces.IPtzSync.

◆ ControlPtzAsync()

async Task< BaseCommandResponse > VideoOS.Mobile.SDK.Portable.Server.Base.Connection.Ptz.ControlPtzAsync	(	PtzParams	tPtzParams,
		TimeSpan	timeout )

inline

Method for set of ptz on camera or current stream from the Mobile Server (should be live stream).

Implemented by the Video & Ptz objects.
Sends message to the Mobile server and returns Task<BaseCommandResponse>.
Error status message could be obtained with query of IErrorResult.

Parameters

ptzParams	PTZ paramters for move.
timeout	Time to wait the responce from the server

Returns: Task<BaseCommandResponse> object

Implements VideoOS.Mobile.SDK.Portable.Server.Interfaces.IPtzAwait.

◆ GetPtzPresets() [1/2]

IAsyncResult VideoOS.Mobile.SDK.Portable.Server.Base.Connection.Ptz.GetPtzPresets	(	Guid	cameraId,
		OnResponse< GetPtzPresetsResponse >	onSuccess = null,
		OnResponse< GetPtzPresetsResponse >	onFail = null )

inline

Method for get of ptz presets on camera or current stream from the Mobile Server (should be live stream)

Implemented by the Video object.
Sends message to the Mobile and returns IAsyncResult.
If method succeeds IAsyncResult.AsyncState contains GetPtzPresetsResponse object.

Parameters

cameraId	Id of the camera
onSuccess	Callback called on success.
onFail	Callback called on fail.

Returns: IAsyncResult implementer.

Implements VideoOS.Mobile.SDK.Portable.Server.Interfaces.IPtzAsync.

◆ GetPtzPresets() [2/2]

GetPtzPresetsResponse VideoOS.Mobile.SDK.Portable.Server.Base.Connection.Ptz.GetPtzPresets	(	Guid	cameraId,
		TimeSpan	timeout )

inline

Method for get of ptz presets on camera or current stream from the Mobile Server (should be live stream).

Implemented by the Video & Ptz object.
Sends message to the Mobile server and returns GetPtzPresetsResponse.
If the method succeeds result is not null and consist all the supported presets.
Error status message could be obtained with query of IErrorResult.

Parameters

cameraId	Id of the camera
timeout

Returns: GetPtzPresetsResponse object

Implements VideoOS.Mobile.SDK.Portable.Server.Interfaces.IPtzSync.

◆ GetPtzPresetsAsync()

async Task< GetPtzPresetsResponse > VideoOS.Mobile.SDK.Portable.Server.Base.Connection.Ptz.GetPtzPresetsAsync	(	Guid	cameraId,
		TimeSpan	timeout )

inline

Method for get of ptz presets on camera or current stream from the Mobile Server (should be live stream).

Implemented by the Video & Ptz object.
Sends message to the Mobile server and returns Task<GetPtzPresetsResponse>.
If the method succeeds result is not null and consist all the supported presets.
Error status message could be obtained with query of IErrorResult.

Parameters

cameraId	Id of the camera
timeout	Time to wait the responce from the server

Returns: Task<GetPtzPresetsResponse> object

Implements VideoOS.Mobile.SDK.Portable.Server.Interfaces.IPtzAwait.