Milestone SDK Mobile .Net
VideoOS.Mobile.SDK.Portable.Server.Base.Connection.ThumbnailCommands Class Reference

Class wrapping the Thumbnails related commands. More...

Inheritance diagram for VideoOS.Mobile.SDK.Portable.Server.Base.Connection.ThumbnailCommands:
VideoOS.Mobile.SDK.Portable.Server.Interfaces.IErrorResult VideoOS.Mobile.SDK.Portable.Server.Interfaces.IThumbnailAsync VideoOS.Mobile.SDK.Portable.Server.Interfaces.IThumbnailSync

Public Member Functions

IAsyncResult GetThumbnail (VideoParams videoParams, OnResponse< GetThumbnailResponse > onSuccess=null, OnResponse< GetThumbnailResponse > onFail=null)
 Method for request of a camera thumbnail from the Mobile Server.

Implemented by Connection object.
Sends message to the Mobile server and returns IAsyncResult.
If method succeeds IAsyncResult.AsyncState contains BaseCommandResponse object.
Error status message could be obtained with query of IErrorResult (from the resulted IAsyncResult).
Parameters
videoParamsVideo parameters for the Thumbnail.
onSuccessCallback called on success.
onFailCallback called on fail.
Returns
IAsyncResult implementer.

 
GetThumbnailResponse GetThumbnail (VideoParams videoParams, TimeSpan timeout)
 Method for request of a camera thumbnail from the Mobile Server.

Implemented by Connection object.
Sends message to the Mobile server and returns GetThumbnailResponse.
Error status message could be obtained with query of IErrorResult.
Parameters
videoParamsVideo parameters for the Thumbnail.
timeoutTime to wait the responce from the server
Returns
GetThumbnailResponse object

 
IAsyncResult GetThumbnailByTime (VideoParams videoParams, PlaybackParams playbackParams, OnResponse< GetThumbnailResponse > onSuccess=null, OnResponse< GetThumbnailResponse > onFail=null)
 Method for request of a camera thumbnail from the Mobile Server.

Implemented by Connection object.
Sends message to the Mobile server and returns IAsyncResult.
If method succeeds IAsyncResult.AsyncState contains BaseCommandResponse object.
Error status message could be obtained with query of IErrorResult (from the resulted IAsyncResult).
Parameters
videoParamsVideo parameters for the Thumbnail.
playbackParamsPlayback parameters for the Thumbnail.
onSuccessCallback called on success.
onFailCallback called on fail.
Returns
IAsyncResult implementer.

 
GetThumbnailResponse GetThumbnailByTime (VideoParams videoParams, PlaybackParams playbackParams, TimeSpan timeout)
 Method for request of a camera thumbnail from the Mobile Server.

Implemented by Connection object.
Sends message to the Mobile server and returns GetThumbnailResponse.
Error status message could be obtained with query of IErrorResult.
Parameters
videoParamsVideo parameters for the Thumbnail.
playbackParamsPlayback parameters for the Thumbnail.
timeoutTime to wait the responce from the server
Returns
GetThumbnailResponse object

 
 ThumbnailCommands (IConnection connection)
 
- Public Member Functions inherited from VideoOS.Mobile.SDK.Portable.Server.Interfaces.IThumbnailAsync
- Public Member Functions inherited from VideoOS.Mobile.SDK.Portable.Server.Interfaces.IThumbnailSync

Properties

ErrorCodes ErrorCode [get]
 Returns error code (if presents) of the last call.
 
string ErrorMessage [get]
 Returns error string (if presents) of the last call.
 
Command.CommandResultTypes Result [get]
 Returns error status of the last call.
 
- Properties inherited from VideoOS.Mobile.SDK.Portable.Server.Interfaces.IErrorResult

Detailed Description

Class wrapping the Thumbnails related commands.

See also
IErrorResult, IThumbnailAsync, IThumbnailSync

Constructor & Destructor Documentation

◆ ThumbnailCommands()

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

Member Function Documentation

◆ GetThumbnail() [1/2]

IAsyncResult VideoOS.Mobile.SDK.Portable.Server.Base.Connection.ThumbnailCommands.GetThumbnail ( VideoParams videoParams,
OnResponse< GetThumbnailResponse > onSuccess = null,
OnResponse< GetThumbnailResponse > onFail = null )
inline

Method for request of a camera thumbnail from the Mobile Server.

Implemented by Connection object.
Sends message to the Mobile server and returns IAsyncResult.
If method succeeds IAsyncResult.AsyncState contains BaseCommandResponse object.
Error status message could be obtained with query of IErrorResult (from the resulted IAsyncResult).

Parameters
videoParamsVideo parameters for the Thumbnail.
onSuccessCallback called on success.
onFailCallback called on fail.
Returns
IAsyncResult implementer.

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

◆ GetThumbnail() [2/2]

GetThumbnailResponse VideoOS.Mobile.SDK.Portable.Server.Base.Connection.ThumbnailCommands.GetThumbnail ( VideoParams videoParams,
TimeSpan timeout )
inline

Method for request of a camera thumbnail from the Mobile Server.

Implemented by Connection object.
Sends message to the Mobile server and returns GetThumbnailResponse.
Error status message could be obtained with query of IErrorResult.

Parameters
videoParamsVideo parameters for the Thumbnail.
timeoutTime to wait the responce from the server
Returns
GetThumbnailResponse object

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

◆ GetThumbnailByTime() [1/2]

IAsyncResult VideoOS.Mobile.SDK.Portable.Server.Base.Connection.ThumbnailCommands.GetThumbnailByTime ( VideoParams videoParams,
PlaybackParams playbackParams,
OnResponse< GetThumbnailResponse > onSuccess = null,
OnResponse< GetThumbnailResponse > onFail = null )
inline

Method for request of a camera thumbnail from the Mobile Server.

Implemented by Connection object.
Sends message to the Mobile server and returns IAsyncResult.
If method succeeds IAsyncResult.AsyncState contains BaseCommandResponse object.
Error status message could be obtained with query of IErrorResult (from the resulted IAsyncResult).

Parameters
videoParamsVideo parameters for the Thumbnail.
playbackParamsPlayback parameters for the Thumbnail.
onSuccessCallback called on success.
onFailCallback called on fail.
Returns
IAsyncResult implementer.

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

◆ GetThumbnailByTime() [2/2]

GetThumbnailResponse VideoOS.Mobile.SDK.Portable.Server.Base.Connection.ThumbnailCommands.GetThumbnailByTime ( VideoParams videoParams,
PlaybackParams playbackParams,
TimeSpan timeout )
inline

Method for request of a camera thumbnail from the Mobile Server.

Implemented by Connection object.
Sends message to the Mobile server and returns GetThumbnailResponse.
Error status message could be obtained with query of IErrorResult.

Parameters
videoParamsVideo parameters for the Thumbnail.
playbackParamsPlayback parameters for the Thumbnail.
timeoutTime to wait the responce from the server
Returns
GetThumbnailResponse object

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

Property Documentation

◆ ErrorCode

ErrorCodes VideoOS.Mobile.SDK.Portable.Server.Base.Connection.ThumbnailCommands.ErrorCode
get

Returns error code (if presents) of the last call.

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

◆ ErrorMessage

string VideoOS.Mobile.SDK.Portable.Server.Base.Connection.ThumbnailCommands.ErrorMessage
get

Returns error string (if presents) of the last call.

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

◆ Result

Command.CommandResultTypes VideoOS.Mobile.SDK.Portable.Server.Base.Connection.ThumbnailCommands.Result
get

Returns error status of the last call.

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