com.zoiper.zdk

Class Conference

java.lang.Object

com.zoiper.zdk.Conference

public class Conference
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Conference(long handle) Constructor storing the pointer/address to the underlying native object

Method Summary

Modifier and Type	Method and Description
Result	acceptCall() Accepts an incoming call Accepts an incoming call and opens audio and video channels for communication.
Call	acceptCallTransfer() Accept a call transfer request Accept a call transfer request and creates a new outgoing call to the transfer target.
Result	acceptVideo(boolean accept) Accepts an incoming offer for video
Result	acquireVideoSinkMngrFromCall(Call call) Acquire video sink from call
Result	addCall(Call hCall) Adds a call to the conference Adds a call to the conference.
Result	attendedTransfer(Call transferee) Initiates an attended call transfer Initiates an attended call transfer.
Result	blindTransfer(java.lang.String transferee) Initiates an unattended call transfer Initiates an unattended transfer (also called blind transfer).
BrandingInfo	branding()
void	branding(BrandingInfo value)
java.lang.String	calleeName() Provides the Callee name
java.lang.String	calleeNumber() Provides the Callee number
long	callHandle() Gets call handle
java.util.List<Call>	calls() Gives list with all calls in conference
int	callsCount() Gives the number of calls in conference
AudioVideoCodecs	codecInUse() Provides the used codec
long	conferenceHandle() Gets conference handle The function returns the conference handler
Result	configureCallRecordFormat(AudioFileFormat format) Configures a call recording's encoding format and its specific settings.
Result	confirmZrtpSas(boolean confirmed) Enables ZRTP
void	dropAllEventListeners() Drops all event listeners
void	dropCallStatusListener(CallEventsHandler value) Drops Call status listener
void	dropConferenceEventsListener(ConferenceEventsHandler confEventHandler) Drops Conference Events Listener
Result	enableZrtp(boolean enabled) Enables ZRTP
protected void	finalize() Ensures the underlying native object destruction
long	handle() Gets the pointer/address to the underlying native object
Result	hangUp() Hang up the call
boolean	hasVideo(OriginType origin) Gets if video is present Gets if video is present, local or remote.
boolean	held() Gets the Hold state
void	held(boolean value) Sets the hold state
boolean	isCallFromConference(long hCall) Checks if a call is part of conference
boolean	isFirstClass()
Result	muteCall(Call hCall) Mute a call in the conference
boolean	muted() Gets the Mute state of the local input device Mutes/unmutes the local input device (microphone).
void	muted(boolean value) Sets the Mute state of the local input device Mutes/unmutes the local input device (microphone).
Result	notifyAccountOfOwnershipChange() Notify upon Account ownership changes
Result	offerVideo() Offers Video Offers video to the remote party during a normal (audio) call.
boolean	onSpeaker() Gets the speakers state !!!NOTE!!! Only keeps track of the SPEAKER state.
void	onSpeaker(boolean value) Sets the speakers state !!!NOTE!!! Only keeps track of the SPEAKER state.
Account	owner() Returns the account owner
java.lang.String	recordFileName() Gets the record file name
void	recordFileName(java.lang.String value) Sets the record file name
Result	rejectCallTransfer() Rejects a call transfer request Rejects a call transfer request.For SIP, the call will continue as usual.
Result	removeCall(Call hCall, boolean hangUp) Removes a call from the conference
Result	restartVideoCapture() Restart Video capture
Result	ringing() Notifies the remote party that we are ringing (incoming calls) Sends a ringing notification to the remote party for an incoming call.
Result	sendDTMF(DTMFCodes dtmf) Sends a DTMF signal over a call Sends a DTMF signal over a call.
void	sendVideoFrame(byte[] bytes, int byteCount, VideoFrameFormat type) Send a video frame over the network Send an arbitrary-format frame to the remote party The function will copy the buffer into its internal structures and schedule it for encoding and transmitting over the video call.
void	setCallStatusListener(CallEventsHandler value) Sets Call status listener
void	setConferenceEventsListener(ConferenceEventsHandler confEventHandler) Set Conference Events Listener
void	setVideoRendererNotificationsListener(VideoRendererEventsHandler value)
void	startHandlingVoipPhoneCallEvents() Start handling Call events
Result	startRecording() Start recording call
CallStatus	status() Provides the Call's status information
void	stopHandlingVoipPhoneCallEvents() Stops handling Call events
Result	stopRecording() Stop recording
Result	unmuteCall(Call hCall) Unmute a call in the conference
VideoCallInfo	videoCallInfo() Gets Video call information Gets if video is present, local or remote.
CameraSensorLocation	videoGetCameraLocation() Provides Camera location Provides Camera location ( Front, Back, NA )
Result	videoToggleCamera() Toggles the camera

Methods inherited from class java.lang.Object

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

Constructor Detail

Conference

public Conference(long handle)

Constructor storing the pointer/address to the underlying native object

Parameters:

handle - Pointer/address to the underlying native object

Method Detail

handle

public long handle()

Gets the pointer/address to the underlying native object

Returns:

Pointer/address to the underlying native object

finalize

protected void finalize()

Ensures the underlying native object destruction

Overrides:

finalize in class java.lang.Object

conferenceHandle

public long conferenceHandle()

Gets conference handle The function returns the conference handler

Returns:

The conference handle

callsCount

public int callsCount()

Gives the number of calls in conference

Returns:

The number of calls

calls

public java.util.List<Call> calls()

Gives list with all calls in conference

Returns:

The list with calls in conference

callHandle

public long callHandle()

Gets call handle

Returns:

ZDKHandle object holding the handle

branding

public BrandingInfo branding()

branding

public void branding(BrandingInfo value)

status

public CallStatus status()

Provides the Call's status information

Returns:

The call status

See Also:

CallStatus

calleeNumber

public java.lang.String calleeNumber()

Provides the Callee number

Returns:

String with the callee number

calleeName

public java.lang.String calleeName()

Provides the Callee name

Returns:

String with the callee name

codecInUse

public AudioVideoCodecs codecInUse()

Provides the used codec

Returns:

AudioVideoCodecs representing the used codec

See Also:

AudioVideoCodecs

onSpeaker

public boolean onSpeaker()

Gets the speakers state !!!NOTE!!! Only keeps track of the SPEAKER state. DOES NOT change the audio routing!!! API user is responsible for changing the audio routing!!!

Returns:

• 0 - disabled
• 1 - enabled

onSpeaker

public void onSpeaker(boolean value)

Sets the speakers state !!!NOTE!!! Only keeps track of the SPEAKER state. DOES NOT change the audio routing!!! API user is responsible for changing the audio routing!!!

Parameters:

value -

• 0 - disabled
• 1 - enabled

held

public boolean held()

Gets the Hold state

Returns:

Bool result of the hold state

held

public void held(boolean value)

Sets the hold state

Parameters:

value -

• 0 - resume
• 1 - hold

muted

public boolean muted()

Gets the Mute state of the local input device Mutes/unmutes the local input device (microphone).

Returns:

• 0 - unmute
• 1 - mute

muted

public void muted(boolean value)

Sets the Mute state of the local input device Mutes/unmutes the local input device (microphone).

Parameters:

value -

• 0 - unmute
• 1 - mute

videoCallInfo

public VideoCallInfo videoCallInfo()

Gets Video call information Gets if video is present, local or remote.

Returns:

Video Call Information object

See Also:

VideoCallInfo

isFirstClass

public boolean isFirstClass()

owner

public Account owner()

Returns the account owner

Returns:

The account owner

See Also:

Account

recordFileName

public java.lang.String recordFileName()

Gets the record file name

Returns:

The record file name as String

recordFileName

public void recordFileName(java.lang.String value)

Sets the record file name

Parameters:

value - The name of the record file to be used

addCall

public Result addCall(Call hCall)

Adds a call to the conference Adds a call to the conference. If the call is already part of another conference, it will be moved.

Parameters:

hCall - The call to add to the conference

Returns:

The result of the function

See Also:

Result

removeCall

public Result removeCall(Call hCall,
                         boolean hangUp)

Removes a call from the conference

Parameters:

hCall - The call to remove from the conference

hangUp - boolean to hang up or not

Returns:

The result of the function

See Also:

Result

muteCall

public Result muteCall(Call hCall)

Mute a call in the conference

Parameters:

hCall - The call to be muted

Returns:

The result of muting

See Also:

Result

unmuteCall

public Result unmuteCall(Call hCall)

Unmute a call in the conference

Parameters:

hCall - The call to be Unmute

Returns:

The result of Unmute

See Also:

Result

isCallFromConference

public boolean isCallFromConference(long hCall)

Checks if a call is part of conference

Parameters:

hCall - The call to be checked

Returns:

True if the call is part of the conference, false otherwise

acquireVideoSinkMngrFromCall

public Result acquireVideoSinkMngrFromCall(Call call)

Acquire video sink from call

Parameters:

call - The call which video sink to be aquired

Returns:

Result of the acquiring

setConferenceEventsListener

public void setConferenceEventsListener(ConferenceEventsHandler confEventHandler)

Set Conference Events Listener

Parameters:

confEventHandler - The conference event handler

See Also:

ConferenceEventsHandler

dropConferenceEventsListener

public void dropConferenceEventsListener(ConferenceEventsHandler confEventHandler)

Drops Conference Events Listener

Parameters:

confEventHandler - The conference event handler

See Also:

ConferenceEventsHandler

setCallStatusListener

public void setCallStatusListener(CallEventsHandler value)

Sets Call status listener

Parameters:

value - The call events handler

See Also:

CallEventsHandler

dropCallStatusListener

public void dropCallStatusListener(CallEventsHandler value)

Drops Call status listener

Parameters:

value - The call events handler to drop

See Also:

CallEventsHandler

dropAllEventListeners

public void dropAllEventListeners()

Drops all event listeners

setVideoRendererNotificationsListener

public void setVideoRendererNotificationsListener(VideoRendererEventsHandler value)

ringing

public Result ringing()

Notifies the remote party that we are ringing (incoming calls) Sends a ringing notification to the remote party for an incoming call. The call must not be accepted yet.

Returns:

The result of the ringing notification

See Also:

Result

acceptCall

public Result acceptCall()

Accepts an incoming call Accepts an incoming call and opens audio and video channels for communication.

Returns:

The result of accepting call up

See Also:

Result

hangUp

public Result hangUp()

Hang up the call

Returns:

The result of hanging up

See Also:

Result

acceptCallTransfer

public Call acceptCallTransfer()

Accept a call transfer request Accept a call transfer request and creates a new outgoing call to the transfer target. The notification listeners will be coppied to the newly created call! The new call will get all the relevant callbacks as if it was normally created outgoing call. The old call will be hung up only after the new call is succesful.

Returns:

The newly created transferring call or NULL in case of transfer failure

See Also:

Call

rejectCallTransfer

public Result rejectCallTransfer()

Rejects a call transfer request Rejects a call transfer request.For SIP, the call will continue as usual.

Returns:

The result of rejecting the call transfer

See Also:

Result

attendedTransfer

public Result attendedTransfer(Call transferee)

Initiates an attended call transfer Initiates an attended call transfer. There have to be two calls using the same user account (call direction doesn't matter). The calls must have been accepted. They can be currently on hold. The library will put the calls on hold if they already weren't. If the transfer fails the first call will be retrieved back. For SIP calls the REFER message will be sent to the first call.

Parameters:

transferee - The call to which the current call to be transfered to

Returns:

The result of the attended transfer

See Also:

Result

blindTransfer

public Result blindTransfer(java.lang.String transferee)

Initiates an unattended call transfer Initiates an unattended transfer (also called blind transfer). This function can be used for incoming SIP calls to redirect them. Incoming AX2 calls cannot be redirected. Calls that were answered (incoming or outgoing) can be transferred using this function (both SIP and AX2). The function returns immediately. If there is no error the process of unattended transfer will start.

Parameters:

transferee - The name of the Peer to which the current call to be transfered to

Returns:

The result of the unattended transfer

See Also:

Result

acceptVideo

public Result acceptVideo(boolean accept)

Accepts an incoming offer for video

Parameters:

accept - Flag indicating whether to accept or reject the offered video

Returns:

The result of accepted video

See Also:

Result

offerVideo

public Result offerVideo()

Offers Video Offers video to the remote party during a normal (audio) call.

Returns:

The result of the video offer

See Also:

Result

sendVideoFrame

public void sendVideoFrame(byte[] bytes,
                           int byteCount,
                           VideoFrameFormat type)

Send a video frame over the network Send an arbitrary-format frame to the remote party The function will copy the buffer into its internal structures and schedule it for encoding and transmitting over the video call. It will return immediately.

Parameters:

bytes - The buffer that holds the bytes

byteCount - The buffer size in number of bytes

type - The format of the frame we are sending

See Also:

VideoFrameFormat

videoToggleCamera

public Result videoToggleCamera()

Toggles the camera

Returns:

The result of toggling the camera

See Also:

Result

videoGetCameraLocation

public CameraSensorLocation videoGetCameraLocation()

Provides Camera location Provides Camera location ( Front, Back, NA )

Returns:

The camera seonsor object that holds the camera location information

See Also:

CameraSensorLocation

restartVideoCapture

public Result restartVideoCapture()

Restart Video capture

Returns:

Result of the restarting video capture

See Also:

Result

hasVideo

public boolean hasVideo(OriginType origin)

Gets if video is present Gets if video is present, local or remote.

Parameters:

origin - The side that we want to check if video is present (local or remote)

Returns:

bool with the result of the state

See Also:

OriginType

stopHandlingVoipPhoneCallEvents

public void stopHandlingVoipPhoneCallEvents()

Stops handling Call events

startHandlingVoipPhoneCallEvents

public void startHandlingVoipPhoneCallEvents()

Start handling Call events

notifyAccountOfOwnershipChange

public Result notifyAccountOfOwnershipChange()

Notify upon Account ownership changes

Returns:

result of notification

See Also:

Result

sendDTMF

public Result sendDTMF(DTMFCodes dtmf)

Sends a DTMF signal over a call Sends a DTMF signal over a call. The BS (backspace) key is only supported by SIP/KPML. To select the DTMF type use accountConfig::DTMFBand. The function returns immediately. If there is no immediate error the function will return OK and the actual status of the DTMF send operation will be delivered via a callback. By default The ZDK will not produce an audible local signal to reflect the DTMF transmission. You can configure the ZDK to produce an audible signal by using accountConfig::DTMFAutoplay.

Parameters:

dtmf - The DTMF you want to send

Returns:

result of sending DTMF

See Also:

Result DTMFCodes

startRecording

public Result startRecording()

Start recording call

Returns:

Result of StartRecoding

See Also:

Result

stopRecording

public Result stopRecording()

Stop recording

Returns:

Result of StopRecoding

See Also:

Result

enableZrtp

public Result enableZrtp(boolean enabled)

Enables ZRTP

Parameters:

enabled -

• 0 - disabled
• 1 - enabled

Returns:

Result of enabling zrtp

See Also:

Result

confirmZrtpSas

public Result confirmZrtpSas(boolean confirmed)

Enables ZRTP

Parameters:

confirmed -

• 0 - disabled
• 1 - enabled

Returns:

Result of enabling zrtp

See Also:

Result

configureCallRecordFormat

public Result configureCallRecordFormat(AudioFileFormat format)

Configures a call recording's encoding format and its specific settings.

Parameters:

format - The format in which the call recording to be stored

Returns:

Result of enabling configuring the call record format

See Also:

AudioFileFormat