net.java.sip.communicator.service.protocol
Interface OperationSetDesktopStreaming

All Superinterfaces:

OperationSet, OperationSetVideoTelephony

All Known Subinterfaces:

OperationSetDesktopSharingServer

All Known Implementing Classes:

OperationSetDesktopSharingServerJabberImpl, OperationSetDesktopSharingServerSipImpl, OperationSetDesktopStreamingJabberImpl, OperationSetDesktopStreamingSipImpl

public interface OperationSetDesktopStreaming
extends OperationSetVideoTelephony

Represents an OperationSet giving access to desktop streaming specific functionality.

Author:

Sebastien Vincent, Yana Stamcheva

Field Summary

Fields inherited from interface net.java.sip.communicator.service.protocol.OperationSetVideoTelephony

LOCAL_VIDEO_STREAMING

Method Summary

Call	createVideoCall(Contact callee, MediaDevice mediaDevice) Create a new video call and invite the specified CallPeer to it.
Call	createVideoCall(String uri, MediaDevice mediaDevice) Create a new video call and invite the specified CallPeer to it.
boolean	isPartialStreaming(Call call) If the streaming is partial (not the full desktop).
void	movePartialDesktopStreaming(Call call, int x, int y) Move origin of a partial desktop streaming.
void	setLocalVideoAllowed(Call call, MediaDevice mediaDevice, boolean allowed) Sets the indicator which determines whether the streaming of local video in a specific Call is allowed.

Methods inherited from interface net.java.sip.communicator.service.protocol.OperationSetVideoTelephony

addPropertyChangeListener, addVideoListener, answerVideoCallPeer, createLocalVisualComponent, createVideoCall, createVideoCall, createVideoCall, createVideoCall, disposeLocalVisualComponent, getQualityControl, getVisualComponent, getVisualComponents, isLocalVideoAllowed, isLocalVideoStreaming, removePropertyChangeListener, removeVideoListener, setLocalVideoAllowed

Method Detail

createVideoCall

Call createVideoCall(String uri,
                     MediaDevice mediaDevice)
                     throws OperationFailedException,
                            ParseException

Create a new video call and invite the specified CallPeer to it.

Parameters:

uri - the address of the callee that we should invite to a new call.

mediaDevice - the media device to use for the desktop streaming

Returns:

CallPeer the CallPeer that will represented by the specified uri. All following state change events will be delivered through that call peer. The Call that this peer is a member of could be retrieved from the CallParticipatnt instance with the use of the corresponding method.

Throws:

OperationFailedException - with the corresponding code if we fail to create the video call.

ParseException - if callee is not a valid address string.

createVideoCall

Call createVideoCall(Contact callee,
                     MediaDevice mediaDevice)
                     throws OperationFailedException

Create a new video call and invite the specified CallPeer to it.

Parameters:

callee - the address of the callee that we should invite to a new call.

mediaDevice - the media device to use for the desktop streaming

Returns:

CallPeer the CallPeer that will represented by the specified uri. All following state change events will be delivered through that call peer. The Call that this peer is a member of could be retrieved from the CallParticipant instance with the use of the corresponding method.

Throws:

OperationFailedException - with the corresponding code if we fail to create the video call.

setLocalVideoAllowed

void setLocalVideoAllowed(Call call,
                          MediaDevice mediaDevice,
                          boolean allowed)
                          throws OperationFailedException

Sets the indicator which determines whether the streaming of local video in a specific Call is allowed. The setting does not reflect the availability of actual video capture devices, it just expresses the desire of the user to have the local video streamed in the case the system is actually able to do so.

Parameters:

call - the Call to allow/disallow the streaming of local video for

mediaDevice - the media device to use for the desktop streaming

allowed - true to allow the streaming of local video for the specified Call; false to disallow it

Throws:

OperationFailedException - if initializing local video fails.

isPartialStreaming

boolean isPartialStreaming(Call call)

If the streaming is partial (not the full desktop).

Parameters:

call - the Call whose video transmission properties we are interested in.

Returns:

true if streaming is partial, false otherwise

movePartialDesktopStreaming

void movePartialDesktopStreaming(Call call,
                                 int x,
                                 int y)

Move origin of a partial desktop streaming.

Parameters:

call - the Call whose video transmission properties we are interested in.

x - new x coordinate origin

y - new y coordinate origin