com.zoiper.zdk

Class Context

java.lang.Object

com.zoiper.zdk.Context

public class Context
extends java.lang.Object

ZDK's main entry point

Constructor Summary

Constructors

Constructor and Description
Context(long handle) Constructor storing the pointer/address to the underlying native object
Context(java.lang.Object ctx) Constructor initializing the underlying native object

Method Summary

Modifier and Type	Method and Description
AccountProvider	accountProvider() Gets the account information and control provider Manages creation and destruction of user accounts and provides information regarding them.
Activation	activation() Gets the ZDK's Activation process handler
Result	addProtocol(ProtocolType proto, int port) Creates a call manager instance for a protocol Creates a call manager instance for a specific protocol.
AudioEndpointControl	audioControls() Gets the audio endpoint's main entry point Entry point for controlling the audio endpoint
BanafoManager	banafoManager() Gets the ZDK's Banafo manager
CallsProvider	callsProvider() Gets the active calls information provider
ConferenceProvider	conferenceProvider() Gets the conference controlling helper
ContextConfiguration	configuration() Gets the general ZDK/Context configuration The configuration is applied with startContext! Any changes after startContext has been invoked will not take effect until a restart happens - stopContext followed by startContext.
boolean	contextRunning() Returnes whether the context is running and functional
DNSRequestProvider	dnsRequestProvider() Gets the DNS resolving requests provider
EncryptionConfiguration	encryptionConfiguration() Gets the encription specific configuration
protected void	finalize() Ensures the underlying native object destruction
void	forceNativeCrash(int delayMs) Force native crash Forces a native crash to take place.
long	handle() Gets the pointer/address to the underlying native object
java.lang.String	libraryVersion() Get the ZDK version Get the revision of the ZDK's source last commit.
Log	logger() Gets the ZDK's debug logging facility instance Only a single instance of the debug logging facility is created and returned during the life time of the library.
Result	networkChanged() Notify the ZDK for changed network event Handles the network change event - resets the DNS, re-register users, refreshes active calls, etc.
ProxyManager	proxyManager() Gets the ZDK's proxy manager
RingBackToneControl	ringback() Ringback tone's main entry point Entry point for controlling the ringback tone heard by the user when the remote peer starts ringing
void	setStatusListener(ContextEventsHandler value) Configures the context event listener The set listener will be notified for each event.
Result	startContext() Initialize the ZDK Create all internal structures, protocol stacks, network transports and event queues.
Result	stopContext() Destroys the ZDK Closes network transports, terminates worker threads and frees all structures.
Result	testSIPURI(java.lang.String sipUri)
VideoEndpointControl	videoControls() Gets the video endpoint's main entry point Entry point for controlling the video endpoint

Methods inherited from class java.lang.Object

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

Constructor Detail

Context

public Context(java.lang.Object ctx)

Constructor initializing the underlying native object

Parameters:

ctx - Android's context

Context

public Context(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

contextRunning

public boolean contextRunning()

Returnes whether the context is running and functional

Returns:

Context's running state

callsProvider

public CallsProvider callsProvider()

Gets the active calls information provider

Returns:

The calls provider

See Also:

CallsProvider

accountProvider

public AccountProvider accountProvider()

Gets the account information and control provider Manages creation and destruction of user accounts and provides information regarding them.

Returns:

The account provider

See Also:

AccountProvider

conferenceProvider

public ConferenceProvider conferenceProvider()

Gets the conference controlling helper

Returns:

The conference provider

See Also:

ConferenceProvider

dnsRequestProvider

public DNSRequestProvider dnsRequestProvider()

Gets the DNS resolving requests provider

Returns:

The DNS resolving requests provider

See Also:

DNSRequestProvider

configuration

public ContextConfiguration configuration()

Gets the general ZDK/Context configuration The configuration is applied with startContext! Any changes after startContext has been invoked will not take effect until a restart happens - stopContext followed by startContext.

Returns:

The context configuration

See Also:

ContextConfiguration

encryptionConfiguration

public EncryptionConfiguration encryptionConfiguration()

Gets the encription specific configuration

Returns:

The encription configuration

See Also:

EncryptionConfiguration

audioControls

public AudioEndpointControl audioControls()

Gets the audio endpoint's main entry point Entry point for controlling the audio endpoint

Returns:

The audio endpoint control

See Also:

AudioEndpointControl

videoControls

public VideoEndpointControl videoControls()

Gets the video endpoint's main entry point Entry point for controlling the video endpoint

Returns:

The video endpoint control

See Also:

VideoEndpointControl

ringback

public RingBackToneControl ringback()

Ringback tone's main entry point Entry point for controlling the ringback tone heard by the user when the remote peer starts ringing

Returns:

The ringback tone control

See Also:

RingBackToneControl

activation

public Activation activation()

Gets the ZDK's Activation process handler

Returns:

The activation handler

See Also:

Activation

logger

public Log logger()

Gets the ZDK's debug logging facility instance Only a single instance of the debug logging facility is created and returned during the life time of the library.

Returns:

The ZDK's debug logging facility instance

See Also:

Log

proxyManager

public ProxyManager proxyManager()

Gets the ZDK's proxy manager

Returns:

The ZDK's proxy manager instance

See Also:

ProxyManager

banafoManager

public BanafoManager banafoManager()

Gets the ZDK's Banafo manager

Returns:

The ZDK's Banafo manager instance

See Also:

BanafoManager

libraryVersion

public java.lang.String libraryVersion()

Get the ZDK version Get the revision of the ZDK's source last commit.

Returns:

The revision as an ASCII string.

startContext

public Result startContext()

Initialize the ZDK Create all internal structures, protocol stacks, network transports and event queues. It will test the available audio devices. It will spawn necessary processing threads. You must call stopContext to close the network transports, stop all threads and free all structures. Do not call this function more than once in a row - use stopContext to clean up and then you can call startContext again.

Returns:

Result of the initialization

See Also:

Result

stopContext

public Result stopContext()

Destroys the ZDK Closes network transports, terminates worker threads and frees all structures. You can call startContext after this to re-open the library. This is a blocking call and will always take some time to finish but has a hard-limit of 2 seconds for IAX and 4 seconds for SIP which in the worst case means 6-7 seconds with some additional time for thread synchronisation.

Returns:

Result of the initialization

See Also:

Result

addProtocol

public Result addProtocol(ProtocolType proto,
                          int port)

Creates a call manager instance for a protocol Creates a call manager instance for a specific protocol. Protocol MUST be added before creating accounts using it! Will be automatically destroyed by stopContext. Some call managers are automatically created by startContext. SIP cannot be created by this function.

Parameters:

proto - Protocol

port - Port at which to bind the main socket, or 0 for random port to be used

Returns:

Result of the addition

See Also:

Result

testSIPURI

public Result testSIPURI(java.lang.String sipUri)

setStatusListener

public void setStatusListener(ContextEventsHandler value)

Configures the context event listener The set listener will be notified for each event.

Parameters:

value - The context event listener to be added

See Also:

ContextEventsHandler

networkChanged

public Result networkChanged()

Notify the ZDK for changed network event Handles the network change event - resets the DNS, re-register users, refreshes active calls, etc. Each invocation restarts a timer delaying the execution of the handling with 500ms from the last received event - if invoked more then once in the delay period, the handling will happen 500ms after the last call.

Returns:

Result of the invocation

See Also:

Result

forceNativeCrash

public void forceNativeCrash(int delayMs)

Force native crash Forces a native crash to take place.

Parameters:

delayMs - Delay in milliseconds. If 0 - crashes immediately!