Nokia SIP VoIP API provides MIDlets means to manage VoIP accounts and calls


Interface Summary
VoipAudioCall Represents an interface to one VoIP Audio Call.
VoipAudioCallStateListener Interface for receiving asynchronous updates for state changes related to application's Audio Call.
VoipMTCallListener Interface for receiving VoIP calls.
VoipSettings Represents an interface to VoIP Settings
VoipSettingsStateListener Interface for receiving asynchronous updates for state changes related to application's settings.

Class Summary
VoipCauses This class defines all the cause codes for VoipSettings and VoipAudioCall
VoipManager VoipManager
VoipStates This class defines all the state codes for VoipSettings and VoipAudioCall.

Package Description

Nokia SIP VoIP API provides MIDlets means to manage VoIP accounts and calls

This document defines the Nokia SIP VoIP API, version 1.0.

Using Nokia SIP VoIP API MIDlets can:

The version of VoIP API is determined by the system property The system property is intended for verifying the presence of the Nokia VoIP API.

Managing settings

MIDlet can manage settings using VoipSettings class. VoipSettings instance is created using VoipManager. Settings allow MIDlet to write one set of settings in the phone. If MIDlet already has settings stored all write attempts will fail. Settings are service provider specific and this document does not specify the format of the settings scheme.

Image 1. Settings states

Managing calls

After MIDlet has written valid settings and those are online, it can create and manage calls using VoipAudioCall class. VoipAudioCall is MIDlets interface to one call instance. Nokia VoIP API supports multi calls and it is up to MIDlet to decide whether it allows multi calls.

Outgoing calls (MO call)

Midlet can create outgoing call via VoipManager which will create new call instance when MIDlet calls VoipManager.createVoipAudioMOCallInstance(string). VoipAudioCall is related to created call only and all operations using instance will be directed to created call only

Image 2. Creating outgoing call and ending it

Image 3. Creating outgoing call and remote party ends call

Incoming calls (MT call)

MIDlet can receive calls whether MIDlet is running or not. In order for MIDlet to receive calls while it is not running it must add following javax.microedition.content defined JAD tags:

For example:

MicroEdition-Handler-1: TestVoIP, application/

Image 4. Receiving call

Incall operations

While call is ongoing Nokia VoIP API allows MIDlet to perform various incall operations like putting call on hold, retrieve and mute

Image 5. Incall operations


Copyright © 2013 Nokia Corporation. All rights reserved.

Nokia is registered trademark of Nokia Corporation. Java and all Java-based marks are trademarks or registered trademarks of Oracle Corporation. Other product and company names mentioned herein may be trademarks or trade names of their respective owners. This document is confidential information of Nokia Corporation.

The information in this document is provided "as is," with no warranties whatsoever, including any warranty of merchantability, fitness for any particular purpose, or any warranty otherwise arising out of any proposal, specification, or sample. Furthermore, information provided in this document is preliminary, and may be changed substantially prior to final release.

Nokia Corporation disclaims all liability, including liability for infringement of any proprietary rights, relating to this document and implementation of any information presented in this document.

Nokia Corporation retains the right to make changes to this document at any time, without notice.

Subject to above disclaimer, a license is hereby granted to use this documentation solely under existing Limited License Agreement and non-disclosure agreement between the companies for the agreed application development for S40 Nokia phones. No other licenses e.g. to any intellectual property rights are granted herein. Any use of the screen shots of this documentation, including any icons thereof, is subject to Nokia's prior written approval.