com.milestonesys.xpmobilesdk

Class XPMobileSDK

java.lang.Object

com.milestonesys.xpmobilesdk.XPMobileSDK

public class XPMobileSDK
extends java.lang.Object

XPMobileSDK class is for communication with the server

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONNECTION_CERTIFICATE_ERROR
static int	CONNECTION_CERTIFICATE_EXPIRED_ERROR
static int	CONNECTION_CERTIFICATE_INVALID_ERROR
static int	CONNECTION_ERROR
static int	CONNECTION_NEGOTIATION_ERROR

Constructor Summary

Constructors

Constructor and Description
XPMobileSDK(android.content.Context applicationContext, java.net.URL url, HttpsCallback httpsCallback, java.security.cert.Certificate trustedCertificate, boolean isTrustedCert, com.milestonesys.xpmobilesdk.callbacks.LiveMsgCallback heartbeatCallback) Deprecated. trustedCertificate and isTrustedCert parameters are not used any more. This constructor will be removed in a future release, as the support for self-signed certificates will be dropped.
XPMobileSDK(android.content.Context applicationContext, java.net.URL url, HttpsCallback httpsCallback, com.milestonesys.xpmobilesdk.callbacks.LiveMsgCallback heartbeatCallback) Constructs a new XPMobileSDK object instance with more details about the Mobile Server.
XPMobileSDK(android.content.Context applicationContext, java.net.URL serverUrl, com.milestonesys.xpmobilesdk.callbacks.LiveMsgCallback heartbeatCallback) Constructs a new XPMobileSDK object instance.
XPMobileSDK(android.content.Context applicationContext, java.net.URL serverUrl, java.lang.String serverAlias) Constructs a new XPMobileSDK object instance.
XPMobileSDK(android.content.Context applicationContext, java.net.URL serverUrl, java.lang.String serverAlias, HttpsCallback httpsCallback, java.security.cert.Certificate trustedCertificate, boolean isTrustedCert, com.milestonesys.xpmobilesdk.callbacks.LiveMsgCallback heartbeatCallback, boolean hasPushNotifications) Deprecated. trustedCertificate and isTrustedCert parameters are not used any more. This constructor will be removed in a future release, as the support for self-signed certificates will be dropped.
XPMobileSDK(android.content.Context applicationContext, java.net.URL serverUrl, java.lang.String serverAlias, HttpsCallback httpsCallback, com.milestonesys.xpmobilesdk.callbacks.LiveMsgCallback heartbeatCallback, boolean hasPushNotifications) Constructs a new XPMobileSDK object instance.
XPMobileSDK(android.content.Context applicationContext, java.net.URL serverUrl, java.lang.String serverAlias, com.milestonesys.xpmobilesdk.callbacks.LiveMsgCallback heartbeatCallback) Constructs a new XPMobileSDK object instance.
XPMobileSDK(android.content.Context applicationContext, java.net.URL url, java.lang.String commAlias, java.lang.String serverUdn, java.lang.String serverName, java.lang.String serverDescription, HttpsCallback httpsCallback, java.security.cert.Certificate trustedCertificate, boolean isTrustedCert, com.milestonesys.xpmobilesdk.callbacks.LiveMsgCallback heartbeatCallback, boolean hasPushNotifications) Deprecated. trustedCertificate and isTrustedCert parameters are not used any more. This constructor will be removed in a future release, as the support for self-signed certificates will be dropped.
XPMobileSDK(android.content.Context applicationContext, java.net.URL url, java.lang.String commAlias, java.lang.String serverUdn, java.lang.String serverName, java.lang.String serverDescription, HttpsCallback httpsCallback, com.milestonesys.xpmobilesdk.callbacks.LiveMsgCallback heartbeatCallback, boolean hasPushNotifications) Constructs a new XPMobileSDK object instance with more details about the Mobile Server.

Method Summary

Modifier and Type	Method and Description
void	changePlaySpeed(java.lang.String videoId, double speed, SuccessCallback successCallback, ErrorCallback errorCallback) ChangePlaySpeed - sends request to the Mobile Server to change the playback speed of the stream.
void	changeVideoStream(java.lang.String videoId, int width, int height, int left, int top, int right, int bottom, SuccessCallback successCallback, ErrorCallback errorCallback) ChangeVideoStream - sends request to the Mobile Server to change the stream depend on passed parameters.
void	closeCommunication() Sends disconnect command to the server and closes the communication.
void	connect(SuccessCallback successCallback, ErrorCallback errorCallback) Connect command sends connect command to the Mobile Server.
ErrorState	connectionSetup(CommunicationCommand receivedCmd)
void	createInvestigation(java.lang.String name, java.lang.String cameraId, java.lang.String startTime, java.lang.String endTime, SuccessCallback successCallback, ErrorCallback errorCallback) CreateInvestigation - sends CreateInvestigation command to the Mobile Server.
void	cropVideo(java.lang.String videoId, int left, int top, int right, int bottom, SuccessCallback successCallback, ErrorCallback errorCallback) CropVideo - sends request to the Mobile Server to crop the video stream.
void	deleteInvestigationExport(java.lang.String investigationId, java.lang.String exportType, SuccessCallback successCallback, ErrorCallback errorCallback) DeleteInvestigationExport - sends DeleteInvestigationExport command to the Mobile Server.
void	deleteInvestigationWithId(java.lang.String guid, SuccessCallback successCallback, ErrorCallback errorCallback) DeleteInvestigationWithId - sends DeleteInvestigation command to the Mobile Server.
void	exportDelete(java.lang.String guid, SuccessCallback successCallback, ErrorCallback errorCallback) ExportDelete - sends DeleteExport command to the Mobile Server.
void	exportStart(java.lang.String guid, java.lang.String exportType, java.lang.String startTime, java.lang.String endTime, SuccessCallback successCallback, ErrorCallback errorCallback) ExportStart - sends StartExport command to the Mobile Server.
void	getAlarms(java.lang.String count, java.lang.String timeStamp, boolean greather, boolean myAlarmsOnly, java.lang.String excludedStates, java.lang.String excludedPriorities, java.lang.String alarmId, SuccessCallback successCallback, ErrorCallback errorCallback) GetAlarms - sends GetAlarmList command to the Mobile Server.
void	getAlarmSettings(SuccessCallback successCallback, ErrorCallback errorCallback) GetAlarmSettings - sends GetAlarmDataSettings command to the Mobile Server.
void	getAllViewsAndCameras(SuccessCallback successCallback, ErrorCallback errorCallback) GetAllViewsAndCameras command - sends GetAllViewsAndCameras command to the Mobile Server.
void	getExportsAsInvestigations(java.lang.String guid, SuccessCallback successCallback, ErrorCallback errorCallback) GetExport - sends GetExport command to the Mobile Server.
void	getInvestigations(java.lang.String guid, boolean includePackages, SuccessCallback successCallback, ErrorCallback errorCallback) GetInvestigations - sends GetInvestigation command to the Mobile Server.
void	getOutputsAndEvents(java.lang.String guid, SuccessCallback successCallback, ErrorCallback errorCallback) GetOutputsAndEvents - sends getOutputsAndEvents command to the Mobile Server.
ConnectionSession	getSession() Returns the connection session that keeps the information about the connected server.
javax.net.ssl.X509TrustManager	getTrustManager() Return the trust manager as X509TrustManager object.
void	getViews(java.lang.String viewId, SuccessCallback successCallback, ErrorCallback errorCallback) GetViews command - sends GetViews command to the Mobile Server.
void	logIn(java.lang.String userName, java.lang.String password, SuccessCallback successCallback, ErrorCallback errorCallback) Login command - sends login command to the Mobile Server and starts heart beat thread.
void	requestAudioStream(java.lang.String fqid, java.util.HashMap<java.lang.String,java.lang.String> vProps, java.lang.String audioType, java.lang.String dataMethod, SuccessCallback successCallback, ErrorCallback errorCallback) Requests channel for audio push.
void	requestAudioStreamIn(java.lang.String fqid, java.lang.String encoding, java.lang.String samplingRate, java.lang.String bitsPerSample, java.lang.String numberOfAudioChannels, SuccessCallback successCallback, ErrorCallback errorCallback) Requests channel for audio push.
void	requestCreateBookmark(java.lang.String videoId, java.lang.String bookmark, SuccessCallback successCallback, ErrorCallback errorCallback) RequestCreateBookmark - sends request to the Mobile Server to stop the video stream.
LiveVideo	requestLiveVideo(VideoReceiver receiver, java.util.HashMap<java.lang.String,java.lang.Object> requestParams) Requests live video.
PlaybackVideo	requestPlaybackVideo(VideoReceiver receiver, java.util.HashMap<java.lang.String,java.lang.Object> requestParams) Requests playback video.
void	requestSecondStepVerificationCode(SuccessCallback successCallback, ErrorCallback errorCallback)
void	requestVideoStream(java.lang.String fqid, java.lang.String fps, java.lang.String quality, java.util.HashMap<java.lang.String,java.lang.String> vProps, java.lang.String videoType, java.lang.String dataMethod, java.lang.String streamType, SuccessCallback successCallback, ErrorCallback errorCallback) RequestStream command - sends RequestStream command to the Mobile Server.
void	rescaleVideo(java.lang.String videoId, int width, int height, SuccessCallback successCallback, ErrorCallback errorCallback) RescaleVideo - sends request to the Mobile Server to rescale the video stream.
void	sendCommand(java.lang.String commandName, java.util.HashMap<java.lang.String,java.lang.String> requestParams, SuccessCallback successCallback, ErrorCallback failCallback) Common command Generic command that follows Mobile Server Protocol command structure.
void	sendLiveMsg(SuccessCallback successCallback, ErrorCallback errorCallback) SendLiveMsg - sends live message to the Mobile Server.
void	setTestConnection(boolean set) Set that the connection will be used for test.
void	stopAudioStream(java.lang.String audioId, SuccessCallback successCallback, ErrorCallback errorCallback) StopAudioStream - sends request to the Mobile Server to stop the audio stream.
void	stopVideoStream(java.lang.String videoId, SuccessCallback successCallback, ErrorCallback errorCallback) StopVideoStream - sends request to the Mobile Server to stop the video stream.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONNECTION_ERROR

public static final int CONNECTION_ERROR

See Also:

Constant Field Values

CONNECTION_NEGOTIATION_ERROR

public static final int CONNECTION_NEGOTIATION_ERROR

See Also:

Constant Field Values

CONNECTION_CERTIFICATE_ERROR

public static final int CONNECTION_CERTIFICATE_ERROR

See Also:

Constant Field Values

CONNECTION_CERTIFICATE_EXPIRED_ERROR

public static final int CONNECTION_CERTIFICATE_EXPIRED_ERROR

See Also:

Constant Field Values

CONNECTION_CERTIFICATE_INVALID_ERROR

public static final int CONNECTION_CERTIFICATE_INVALID_ERROR

See Also:

Constant Field Values

Constructor Detail

XPMobileSDK

public XPMobileSDK(android.content.Context applicationContext,
                   java.net.URL serverUrl,
                   java.lang.String serverAlias)

Constructs a new XPMobileSDK object instance.

Parameters:

applicationContext - The context of the application. Used for reading and writing preferences.

serverUrl - Url of the server. public XPMobileSDK(Context applicationContext, URL serverUrl){ this(applicationContext, serverUrl, defaultServerAlias, null, null, false, null, false); } /** Constructs a new XPMobileSDK object instance.

applicationContext - The context of the application. Used for reading and writing preferences.

serverUrl - Url of the server.

serverAlias - Alias of the server.

XPMobileSDK

public XPMobileSDK(android.content.Context applicationContext,
                   java.net.URL serverUrl,
                   com.milestonesys.xpmobilesdk.callbacks.LiveMsgCallback heartbeatCallback)

Constructs a new XPMobileSDK object instance.

Parameters:

applicationContext - The context of the application. Used for reading and writing preferences.

serverUrl - Url of the server.

heartbeatCallback - Callback for the Heartbeat thread that will handle live messages and other messages from server.

XPMobileSDK

public XPMobileSDK(android.content.Context applicationContext,
                   java.net.URL serverUrl,
                   java.lang.String serverAlias,
                   com.milestonesys.xpmobilesdk.callbacks.LiveMsgCallback heartbeatCallback)

Constructs a new XPMobileSDK object instance.

Parameters:

applicationContext - The context of the application. Used for reading and writing preferences.

serverUrl - Url of the server.

serverAlias - Alias of the server.

heartbeatCallback - Callback for the Heartbeat thread that will handle live messages and other messages from server.

XPMobileSDK

public XPMobileSDK(android.content.Context applicationContext,
                   java.net.URL serverUrl,
                   java.lang.String serverAlias,
                   HttpsCallback httpsCallback,
                   com.milestonesys.xpmobilesdk.callbacks.LiveMsgCallback heartbeatCallback,
                   boolean hasPushNotifications)

Constructs a new XPMobileSDK object instance.

Parameters:

applicationContext - The context of the application. Used for reading and writing preferences.

serverUrl - Url of the server.

serverAlias - Alias of the server.

httpsCallback - HTTPS callback for secure connection.

heartbeatCallback - Callback for the Heartbeat thread that will handle live messages and other messages from server.

hasPushNotifications - flag that indicates if push notifications will be used or not.

XPMobileSDK

@Deprecated
public XPMobileSDK(android.content.Context applicationContext,
                                java.net.URL serverUrl,
                                java.lang.String serverAlias,
                                HttpsCallback httpsCallback,
                                java.security.cert.Certificate trustedCertificate,
                                boolean isTrustedCert,
                                com.milestonesys.xpmobilesdk.callbacks.LiveMsgCallback heartbeatCallback,
                                boolean hasPushNotifications)

Deprecated. trustedCertificate and isTrustedCert parameters are not used any more. This constructor will be removed in a future release, as the support for self-signed certificates will be dropped.

Constructs a new XPMobileSDK object instance.

Parameters:

applicationContext - The context of the application. Used for reading and writing preferences.

serverUrl - Url of the server.

serverAlias - Alias of the server.

httpsCallback - HTTPS callback for secure connection.

trustedCertificate - The certificate that must be trusted for successful communication between the client and the server.

isTrustedCert - flag that indicates if the certificate has been trusted or not.

heartbeatCallback - Callback for the Heartbeat thread that will handle live messages and other messages from server.

hasPushNotifications - flag that indicates if push notifications will be used or not.

XPMobileSDK

public XPMobileSDK(android.content.Context applicationContext,
                   java.net.URL url,
                   HttpsCallback httpsCallback,
                   com.milestonesys.xpmobilesdk.callbacks.LiveMsgCallback heartbeatCallback)

Constructs a new XPMobileSDK object instance with more details about the Mobile Server.

Parameters:

applicationContext - The context of the application. Used for reading and writing preferences.

url - Url of the server.

httpsCallback - HTTPS callback for secure connection.

heartbeatCallback - Callback for the Heartbeat thread that will handle live messages and other messages from server.

XPMobileSDK

@Deprecated
public XPMobileSDK(android.content.Context applicationContext,
                                java.net.URL url,
                                HttpsCallback httpsCallback,
                                java.security.cert.Certificate trustedCertificate,
                                boolean isTrustedCert,
                                com.milestonesys.xpmobilesdk.callbacks.LiveMsgCallback heartbeatCallback)

Deprecated. trustedCertificate and isTrustedCert parameters are not used any more. This constructor will be removed in a future release, as the support for self-signed certificates will be dropped.

Constructs a new XPMobileSDK object instance with more details about the Mobile Server.

Parameters:

applicationContext - The context of the application. Used for reading and writing preferences.

url - Url of the server.

httpsCallback - HTTPS callback for secure connection.

trustedCertificate - The certificate that must be trusted for successful communication between the client and the server.

isTrustedCert - flag that indicates if the certificate has been trusted or not.

heartbeatCallback - Callback for the Heartbeat thread that will handle live messages and other messages from server.

XPMobileSDK

public XPMobileSDK(android.content.Context applicationContext,
                   java.net.URL url,
                   java.lang.String commAlias,
                   java.lang.String serverUdn,
                   java.lang.String serverName,
                   java.lang.String serverDescription,
                   HttpsCallback httpsCallback,
                   com.milestonesys.xpmobilesdk.callbacks.LiveMsgCallback heartbeatCallback,
                   boolean hasPushNotifications)

Constructs a new XPMobileSDK object instance with more details about the Mobile Server.

Parameters:

applicationContext - The context of the application. Used for reading and writing preferences.

url - Url of the server.

commAlias - Alias of the server.

serverUdn - Unique server id.

serverName - Name of the server.

serverDescription - Description for the server.

httpsCallback - HTTPS callback for secure connection.

heartbeatCallback - Callback for the Heartbeat thread that will handle live messages and other messages from server.

hasPushNotifications - flag that indicates if push notifications will be used or not.

XPMobileSDK

@Deprecated
public XPMobileSDK(android.content.Context applicationContext,
                                java.net.URL url,
                                java.lang.String commAlias,
                                java.lang.String serverUdn,
                                java.lang.String serverName,
                                java.lang.String serverDescription,
                                HttpsCallback httpsCallback,
                                java.security.cert.Certificate trustedCertificate,
                                boolean isTrustedCert,
                                com.milestonesys.xpmobilesdk.callbacks.LiveMsgCallback heartbeatCallback,
                                boolean hasPushNotifications)

Deprecated. trustedCertificate and isTrustedCert parameters are not used any more. This constructor will be removed in a future release, as the support for self-signed certificates will be dropped.

Constructs a new XPMobileSDK object instance with more details about the Mobile Server.

Parameters:

applicationContext - The context of the application. Used for reading and writing preferences.

url - Url of the server.

commAlias - Alias of the server.

serverUdn - Unique server id.

serverName - Name of the server.

serverDescription - Description for the server.

httpsCallback - HTTPS callback for secure connection.

trustedCertificate - The certificate that must be trusted for successful communication between the client and the server.

isTrustedCert - flag that indicates if the certificate has been trusted or not.

heartbeatCallback - Callback for the Heartbeat thread that will handle live messages and other messages from server.

hasPushNotifications - flag that indicates if push notifications will be used or not.

Method Detail

getTrustManager

public javax.net.ssl.X509TrustManager getTrustManager()

Return the trust manager as X509TrustManager object.

setTestConnection

public void setTestConnection(boolean set)

Set that the connection will be used for test.

getSession

public ConnectionSession getSession()

Returns the connection session that keeps the information about the connected server.

connectionSetup

public ErrorState connectionSetup(CommunicationCommand receivedCmd)

closeCommunication

public void closeCommunication()

Sends disconnect command to the server and closes the communication.

sendCommand

public void sendCommand(java.lang.String commandName,
                        java.util.HashMap<java.lang.String,java.lang.String> requestParams,
                        SuccessCallback successCallback,
                        ErrorCallback failCallback)

Common command Generic command that follows Mobile Server Protocol command structure. This command allow to send commands to the Milestone Mobile Server that are not yet implemented in the Mobile SDK.

Parameters:

commandName - Name of the command.

requestParams - Parameters for the command.

successCallback - success callback that will handle the successful response.

failCallback - fail callback that will handle the fail response.

connect

public void connect(SuccessCallback successCallback,
                    ErrorCallback errorCallback)
             throws java.io.IOException

Connect command sends connect command to the Mobile Server.

Parameters:

successCallback - success callback that will handle the successful response.

errorCallback - fail callback that will handle the fail response. More details about the command could be found in the Viking Protocol documentation.

Throws:

java.io.IOException

logIn

public void logIn(java.lang.String userName,
                  java.lang.String password,
                  SuccessCallback successCallback,
                  ErrorCallback errorCallback)

Login command - sends login command to the Mobile Server and starts heart beat thread.

Parameters:

userName - username for authentication to the server.

password - password for authentication to the server.

successCallback - success callback that will handle the successful response.

errorCallback - fail callback that will handle the fail response. More details about the command could be found in the Viking Protocol documentation.

getViews

public void getViews(java.lang.String viewId,
                     SuccessCallback successCallback,
                     ErrorCallback errorCallback)

GetViews command - sends GetViews command to the Mobile Server.

Parameters:

viewId - Id of the requested view.

successCallback - success callback that will handle the successful response.

errorCallback - fail callback that will handle the fail response. More details about the command could be found in the Viking Protocol documentation.

getAllViewsAndCameras

public void getAllViewsAndCameras(SuccessCallback successCallback,
                                  ErrorCallback errorCallback)

GetAllViewsAndCameras command - sends GetAllViewsAndCameras command to the Mobile Server.

Parameters:

successCallback - - success callback that will handle the successful response.

errorCallback - - fail callback that will handle the fail response. More details about the command could be found in the Viking Protocol documentation.

requestVideoStream

public void requestVideoStream(java.lang.String fqid,
                               java.lang.String fps,
                               java.lang.String quality,
                               java.util.HashMap<java.lang.String,java.lang.String> vProps,
                               java.lang.String videoType,
                               java.lang.String dataMethod,
                               java.lang.String streamType,
                               SuccessCallback successCallback,
                               ErrorCallback errorCallback)

RequestStream command - sends RequestStream command to the Mobile Server.

Parameters:

fqid - ID of the camera, which capabilities is requested (GUID)

fps - Frame-rate of the requested video (frames per second)

quality - Compression level of the received JPEG images (1 - 100)

vProps - Video properties for the requested stream.

videoType - Type of the requested signal - Live, Playback or Upload

dataMethod - Type of the method for retrieving video data - Push or Pull

streamType - - type of the stream that will be requested - Segmented/Native/Transcoded

successCallback - success callback that will handle the successful response.

errorCallback - fail callback that will handle the fail response. More details about the command could be found in the Viking Protocol documentation.

requestAudioStream

public void requestAudioStream(java.lang.String fqid,
                               java.util.HashMap<java.lang.String,java.lang.String> vProps,
                               java.lang.String audioType,
                               java.lang.String dataMethod,
                               SuccessCallback successCallback,
                               ErrorCallback errorCallback)

Requests channel for audio push.

Parameters:

fqid - Id of the item (microphone), which stream is requested (GUID)

vProps - Audio properties for the requested stream.

audioType - Type of the requested signal - Live, Playback

dataMethod - Type of the method for retrieving video data - Push or Pull

successCallback - success callback that will handle the successful response.

errorCallback - fail callback that will handle the fail response.

requestAudioStreamIn

public void requestAudioStreamIn(java.lang.String fqid,
                                 java.lang.String encoding,
                                 java.lang.String samplingRate,
                                 java.lang.String bitsPerSample,
                                 java.lang.String numberOfAudioChannels,
                                 SuccessCallback successCallback,
                                 ErrorCallback errorCallback)

Requests channel for audio push.

Parameters:

fqid - Id of the item (speaker), which stream is requested (GUID)

encoding - Shows the encoding of the output. Possible values - Pcm, Mp3.

samplingRate - The audio sampling rate in Hz value

bitsPerSample - 8/16 - Audio bits per sample

numberOfAudioChannels - 1/2 - Number of audio channels (mon or stereo)

successCallback - success callback that will handle the successful response.

errorCallback - fail callback that will handle the fail response.

requestLiveVideo

public LiveVideo requestLiveVideo(VideoReceiver receiver,
                                  java.util.HashMap<java.lang.String,java.lang.Object> requestParams)

Requests live video.

Parameters:

receiver - object that implements VideoReceiver interface and will receive the frames for the live video stream.

requestParams - parameters for the video stream.

Returns:

instance of the High level video object for quick set-up and start a live video.

requestPlaybackVideo

public PlaybackVideo requestPlaybackVideo(VideoReceiver receiver,
                                          java.util.HashMap<java.lang.String,java.lang.Object> requestParams)

Requests playback video.

Parameters:

receiver - object that implements VideoReceiver interface and will receive the frames for the playback video stream.

requestParams - parameters for the video stream.

Returns:

instance of the High level video object for quick set-up and start a playback video.

changeVideoStream

public void changeVideoStream(java.lang.String videoId,
                              int width,
                              int height,
                              int left,
                              int top,
                              int right,
                              int bottom,
                              SuccessCallback successCallback,
                              ErrorCallback errorCallback)

ChangeVideoStream - sends request to the Mobile Server to change the stream depend on passed parameters.

Parameters:

videoId - ID of the video connection (GUID)

width - Width of the requested video (in pixels)

height - Height of the requested video (in pixels)

left - Left coordinate (X) of the cropping rectangle.

top - Top coordinate (Y) of the cropping rectangle.

right - Right coordinate (X) of the cropping rectangle.

bottom - Bottom coordinate (Y) of the cropping rectangle.

successCallback - success callback that will handle the successful response.

errorCallback - fail callback that will handle the fail response. More details about the ChangeStream command could be found in the Viking Protocol documentation.

changePlaySpeed

public void changePlaySpeed(java.lang.String videoId,
                            double speed,
                            SuccessCallback successCallback,
                            ErrorCallback errorCallback)

ChangePlaySpeed - sends request to the Mobile Server to change the playback speed of the stream.

Parameters:

videoId - ID of the video connection (GUID)

speed - Speed of the playback (floating point). Sign determines the direction.

successCallback - success callback that will handle the successful response.

errorCallback - fail callback that will handle the fail response. More details about the ChangeStream command could be found in the Viking Protocol documentation.

cropVideo

public void cropVideo(java.lang.String videoId,
                      int left,
                      int top,
                      int right,
                      int bottom,
                      SuccessCallback successCallback,
                      ErrorCallback errorCallback)

CropVideo - sends request to the Mobile Server to crop the video stream.

Parameters:

videoId - ID of the video connection (GUID)

left - Left coordinate (X) of the cropping rectangle.

top - Top coordinate (Y) of the cropping rectangle.

right - Right coordinate (X) of the cropping rectangle.

bottom - Bottom coordinate (Y) of the cropping rectangle.

successCallback - success callback that will handle the successful response.

errorCallback - fail callback that will handle the fail response. More details about the ChangeStream command could be found in the Viking Protocol documentation.

rescaleVideo

public void rescaleVideo(java.lang.String videoId,
                         int width,
                         int height,
                         SuccessCallback successCallback,
                         ErrorCallback errorCallback)

RescaleVideo - sends request to the Mobile Server to rescale the video stream.

Parameters:

videoId - ID of the video connection (GUID)

width - Width of the requested video (in pixels)

height - Height of the requested video (in pixels)

successCallback - success callback that will handle the successful response.

errorCallback - fail callback that will handle the fail response. More details about the ChangeStream command could be found in the Viking Protocol documentation.

stopVideoStream

public void stopVideoStream(java.lang.String videoId,
                            SuccessCallback successCallback,
                            ErrorCallback errorCallback)

StopVideoStream - sends request to the Mobile Server to stop the video stream.

Parameters:

videoId - ID of the video connection (GUID)

successCallback - success callback that will handle the successful response.

errorCallback - fail callback that will handle the fail response. More details about the CloseStream command could be found in the Viking Protocol documentation.

stopAudioStream

public void stopAudioStream(java.lang.String audioId,
                            SuccessCallback successCallback,
                            ErrorCallback errorCallback)

StopAudioStream - sends request to the Mobile Server to stop the audio stream.

Parameters:

audioId - ID of the video connection (GUID)

successCallback - success callback that will handle the successful response.

errorCallback - fail callback that will handle the fail response. More details about the CloseStream command could be found in the Viking Protocol documentation.

requestCreateBookmark

public void requestCreateBookmark(java.lang.String videoId,
                                  java.lang.String bookmark,
                                  SuccessCallback successCallback,
                                  ErrorCallback errorCallback)

RequestCreateBookmark - sends request to the Mobile Server to stop the video stream.

Parameters:

videoId - Id of the stream to bookmark (Guid)

bookmark - Bookmark description. "Mobile bookmark" will be used if input param is empty

successCallback - success callback that will handle the successful response.

errorCallback - fail callback that will handle the fail response. More details about the CreateBookmark command could be found in the Viking Protocol documentation.

sendLiveMsg

public void sendLiveMsg(SuccessCallback successCallback,
                        ErrorCallback errorCallback)

SendLiveMsg - sends live message to the Mobile Server.

Parameters:

successCallback - success callback that will handle the successful response.

errorCallback - fail callback that will handle the fail response. More details about the LiveMessage command could be found in the Viking Protocol documentation.

getExportsAsInvestigations

public void getExportsAsInvestigations(java.lang.String guid,
                                       SuccessCallback successCallback,
                                       ErrorCallback errorCallback)

GetExport - sends GetExport command to the Mobile Server.

Parameters:

guid - ID of the export operation (GUID).

successCallback - success callback that will handle the successful response.

errorCallback - fail callback that will handle the fail response. More details about the GetExport command could be found in the Viking Protocol documentation.

createInvestigation

public void createInvestigation(java.lang.String name,
                                java.lang.String cameraId,
                                java.lang.String startTime,
                                java.lang.String endTime,
                                SuccessCallback successCallback,
                                ErrorCallback errorCallback)

CreateInvestigation - sends CreateInvestigation command to the Mobile Server.

Parameters:

name - Name of the investigation.

cameraId - Id of the camera part of this investigation

startTime - Start time of the investigation (milliseconds since Unix epoch).

endTime - EndTime

successCallback - success callback that will handle the successful response.

errorCallback - fail callback that will handle the fail response. More details about the CreateInvestigation command could be found in the Viking Protocol documentation.

getInvestigations

public void getInvestigations(java.lang.String guid,
                              boolean includePackages,
                              SuccessCallback successCallback,
                              ErrorCallback errorCallback)

GetInvestigations - sends GetInvestigation command to the Mobile Server.

Parameters:

guid - Id of the investigation

includePackages - Indicates whether exports should be included as investigations child items

successCallback - success callback that will handle the successful response.

errorCallback - fail callback that will handle the fail response. More details about the GetInvestigation command could be found in the Viking Protocol documentation.

deleteInvestigationWithId

public void deleteInvestigationWithId(java.lang.String guid,
                                      SuccessCallback successCallback,
                                      ErrorCallback errorCallback)

DeleteInvestigationWithId - sends DeleteInvestigation command to the Mobile Server.

Parameters:

guid - Id of the investigation for which an export will be deleted

successCallback - success callback that will handle the successful response.

errorCallback - fail callback that will handle the fail response. More details about the DeleteInvestigation command could be found in the Viking Protocol documentation.

deleteInvestigationExport

public void deleteInvestigationExport(java.lang.String investigationId,
                                      java.lang.String exportType,
                                      SuccessCallback successCallback,
                                      ErrorCallback errorCallback)

DeleteInvestigationExport - sends DeleteInvestigationExport command to the Mobile Server.

Parameters:

investigationId - Id of the investigation for which an export will be deleted

exportType - Enumeration. Type of the export to be deleted.

successCallback - success callback that will handle the successful response.

errorCallback - fail callback that will handle the fail response. More details about the DeleteInvestigationExport command could be found in the Viking Protocol documentation.

exportStart

public void exportStart(java.lang.String guid,
                        java.lang.String exportType,
                        java.lang.String startTime,
                        java.lang.String endTime,
                        SuccessCallback successCallback,
                        ErrorCallback errorCallback)

ExportStart - sends StartExport command to the Mobile Server.

Parameters:

guid - ID of the camera.

exportType - Type of the export - enumeration.

startTime - Start Time of the export (in milliseconds since Unix epoch).

endTime - End Time of the export (in milliseconds since Unix epoch).

successCallback - success callback that will handle the successful response.

errorCallback - fail callback that will handle the fail response. More details about the StartExport command could be found in the Viking Protocol documentation.

exportDelete

public void exportDelete(java.lang.String guid,
                         SuccessCallback successCallback,
                         ErrorCallback errorCallback)

ExportDelete - sends DeleteExport command to the Mobile Server.

Parameters:

guid - ID of the export operation.

successCallback - success callback that will handle the successful response.

errorCallback - fail callback that will handle the fail response. More details about the DeleteExport command could be found in the Viking Protocol documentation.

getOutputsAndEvents

public void getOutputsAndEvents(java.lang.String guid,
                                SuccessCallback successCallback,
                                ErrorCallback errorCallback)

GetOutputsAndEvents - sends getOutputsAndEvents command to the Mobile Server.

Parameters:

guid - CameraId

successCallback - success callback that will handle the successful response.

errorCallback - fail callback that will handle the fail response. More details about the GetOutputsAndEvents command could be found in the Viking Protocol documentation.

getAlarms

public void getAlarms(java.lang.String count,
                      java.lang.String timeStamp,
                      boolean greather,
                      boolean myAlarmsOnly,
                      java.lang.String excludedStates,
                      java.lang.String excludedPriorities,
                      java.lang.String alarmId,
                      SuccessCallback successCallback,
                      ErrorCallback errorCallback)

GetAlarms - sends GetAlarmList command to the Mobile Server.

Parameters:

count - Max alarms count to return

timeStamp - Target time

greather - LessThan/GreaterThan - condition on target timestamp

myAlarmsOnly - YES/NO - flag whether to send only my Alarms

excludedStates - state guilds to be excluded.

excludedPriorities - priority guilds to be excluded.

alarmId - GUID of the Alarm in case of single Alarm request

successCallback - success callback that will handle the successful response.

errorCallback - fail callback that will handle the fail response. More details about the GetAlarmList command could be found in the Viking Protocol documentation.

getAlarmSettings

public void getAlarmSettings(SuccessCallback successCallback,
                             ErrorCallback errorCallback)

GetAlarmSettings - sends GetAlarmDataSettings command to the Mobile Server.

Parameters:

successCallback - success callback that will handle the successful response.

errorCallback - fail callback that will handle the fail response. More details about the GetAlarmDataSettings command could be found in the Viking Protocol documentation.

requestSecondStepVerificationCode

public void requestSecondStepVerificationCode(SuccessCallback successCallback,
                                              ErrorCallback errorCallback)