Package com.nokia.mid.voip

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

See:
Description

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 com.nokia.mid.voip 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:

• Write one VoIP settings instance in the phone
• Delete VoIP settings it has created
• Start outgoing call (Mobile Originated)
• Receive incoming call (Mobile Terminated) whether MIDlet is either running or not
• Operate incall operations like hold and retrieve for MIDlet initiated calls

The version of VoIP API is determined by the system property com.nokia.mid.voip.version. 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:

• MicroEdition-Handler-n: MIDlet class, application/vnd.nokia.voip.audio.call
• MicroEdition-Handler-n-ID: The ID of the content handler

For example:

MicroEdition-Handler-1: TestVoIP, application/vnd.nokia.voip.audio.call
MicroEdition-Handler-1-ID: com.nokia.test.voip

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

Terminology

• MO Call - Mobile Originated call. Call has been initiated from own phone
• MT Call - Mobile Terminated call. Call has been initiated from remote end and own phone has received this call.
• COLP - Connected Line Identification presentation. Caller address can be shown
• CLIR - Connected Line Identification restriction. Remote end will not see caller address