com.milestonesys.xpmobilesdk.communication

Class LiveVideo

java.lang.Object

com.milestonesys.xpmobilesdk.communication.LiveVideo

Direct Known Subclasses:

PlaybackVideo

public class LiveVideo
extends java.lang.Object

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CAMERA_ID_PROPERTY Property keywords for the video streaming.
static java.lang.String	FPS_PROPERTY
static java.lang.String	VIDEO_PROPERTIES

Constructor Summary

Constructors

Constructor and Description
LiveVideo(XPMobileSDK connection, VideoReceiver receiver, java.util.HashMap<java.lang.String,java.lang.Object> requestParams) Constructs a new LiveVideo object instance.

Method Summary

Modifier and Type	Method and Description
boolean	Crop(int left, int top, int right, int bottom) Sends Crop request.
ErrorState	getError() Gets the last occurred error.
boolean	getIsPull() Gets the type of streaming.
java.lang.String	getVideoId() Gets the video id which is set when the requestVideo is executed successfully.
ErrorState	requestVideo() Requests a video from the Mobile server and if the request is successfully executed then it sets the value for the videoId variable.
boolean	Rescale(int width, int height) Sends Rescale request.
void	setIsPull(boolean isPull) Sets the type of streaming.

Methods inherited from class java.lang.Object

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

Field Detail

CAMERA_ID_PROPERTY

public static final java.lang.String CAMERA_ID_PROPERTY

Property keywords for the video streaming.

See Also:

Constant Field Values

VIDEO_PROPERTIES

public static final java.lang.String VIDEO_PROPERTIES

See Also:

Constant Field Values

FPS_PROPERTY

public static final java.lang.String FPS_PROPERTY

See Also:

Constant Field Values

Constructor Detail

LiveVideo

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

Constructs a new LiveVideo object instance.

Parameters:

connection - the connection to the Mobile server.

receiver - the object that implements VideoReceiver interface and will receive the Frames from the Mobile server.

requestParams - the parameters that will be included when the request is created.

Method Detail

requestVideo

public ErrorState requestVideo()

Requests a video from the Mobile server and if the request is successfully executed then it sets the value for the videoId variable.

Returns:

ErrorState object with the information of the fail request or null if there is working VideoChannelThread or successfully created.

Rescale

public boolean Rescale(int width,
                       int height)
                throws java.lang.InterruptedException

Sends Rescale request.

Parameters:

width - the width of the Frame that will be requested.

height - the height of the Frame that will be requested.

Returns:

boolean true if the request is sent successfully false if it is not sent successfully .

Throws:

java.lang.InterruptedException

Crop

public boolean Crop(int left,
                    int top,
                    int right,
                    int bottom)

Sends Crop request.

Parameters:

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.

Returns:

boolean true if the request is sent successfully false if it is not sent successfully .

setIsPull

public void setIsPull(boolean isPull)

Sets the type of streaming. There are two types of stream requests depending on parameter:

Parameters:

isPull - true - Mobile server pushes only one frame on client request. false - Mobile server pushes unlimited stream of frames to the client on its request.

getIsPull

public boolean getIsPull()

Gets the type of streaming.

Returns:

boolean true - Mobile server pushes only one frame on client request. false - Mobile server pushes unlimited stream of frames to the client on its request.

getVideoId

public java.lang.String getVideoId()

Gets the video id which is set when the requestVideo is executed successfully.

Returns:

current video id.

getError

public ErrorState getError()

Gets the last occurred error.

Returns:

ErrorState object with the information of the last occurred error.