Skip to content

Latest commit

 

History

History
177 lines (132 loc) · 13.3 KB

Quick_Start.md

File metadata and controls

177 lines (132 loc) · 13.3 KB

SIP Account

If you are a newbie and don't have a SIP account I recommend using sip2sip.info.
To create an account: https://mdns.sipthor.net/register_sip_account.phtml.

SIP Configuration

Before starting to use the client you should configure your identity and the network settings. This short guide explain how to do this.
If you don't have enough time and:

Identity

At the home screen, go to Options (http://imsdroid.googlecode.com/svn/branches/1.0/imsdroid/res/drawable/options_48.png) -> Identity (http://imsdroid.googlecode.com/svn/branches/1.0/imsdroid/res/drawable/identity_48.png) to open the Identity screen.

Identity Screen

Display Name: Your nickname. Useless in this beta version.

IMS Public Identity (IMPU): As its name says, it’s your public visible identifier where you are willing to receive calls or any demands. An IMPU could be either a SIP or tel URI (e.g. tel:+33100000 or sip:[email protected]).
For those using IMSDroid as a basic SIP client, the IMPU should coincide with their SIP URI (a.k.a SIP address).

IMS Private Identity (IMPI): The IMPI is a unique identifier assigned to a user (or UE) by the home network. It could be either a SIP URI (e.g. sip:[email protected]), a tel URI (e.g. tel:+33100000) or any alphanumeric string (e.g. [email protected] or bob).
For those using IMSDroid as a basic SIP client, the IMPI should coincide with their authentication name. If you don't know what is your IMPI, then fill the field with your SIP address as above.

Password: Your password.

Realm: The realm is the name of the domain to authenticate to. It should be a valid SIP URI (e.g. sip:open-ims.test).

3GPP Early IMS Security: If you are not using an IMS server you should use this option to disable some heavy IMS authentication procedures.

Network Settings

At the home screen, go to Options (http://imsdroid.googlecode.com/svn/branches/1.0/imsdroid/res/drawable/options_48.png) -> Network(http://imsdroid.googlecode.com/svn/branches/1.0/imsdroid/res/drawable/network_48.png) to open the Network screen.

Network Screen

Enable WiFi: To enable WiFi.

Enable 4G/3G/2.G: To enable 4G (e.g. LTE), 3G (e.g. UMTS) and 2.5G (e.g. EDGE) networks. You should enable this option when testing on the emulator.

IPv4 or IPv6: Define the IP version of the proxy-cscf host. If you don't know what is the right value, then keep IPv4 checked.

Proxy-CSCF Host: This is the IPv4/IPv6 address or FQDN (Fully-Qualified Domain Name) of your SIP server or outbound proxy (e.g. 88.89.125.125 or example.com or 2a01:e35:8b32:7050:212:f0ff:fe99:c9fc).

Proxy-CSCF Port: The port associated to the proxy host. Should be 5060.

Transport: The transport type (TCP or UDP) to use.

Proxy-CSCF Discovery: Should be None.

Enable SigComp: Will enable Signaling Compression. Only check if your server support this feature. Should not be checked.

Connecting

Return to the home screen and click on Sign In item to connect to your SIP server.
If the connection succeed, you will have new items in the home screen (see below) and a green notification icon will be added in the status bar.

Voice/Video Call

This beta version (v1.0.0) already supports both audio and video calls.

  • Supported Audio Codecs: AMR-NB, GSM, PCMA, PCMU, Speex-NB
  • Supported Video codecs: H264, Theora, H.263, H.263-1998, H.261

Codecs

To choose which audio/video codecs to enable/disable you should go to Options(http://imsdroid.googlecode.com/svn/branches/1.0/imsdroid/res/drawable/options_48.png) -> Codecs(http://imsdroid.googlecode.com/svn/branches/1.0/imsdroid/res/drawable/codecs_48.png) screen page as shown below.

Codecs Screen

To have decent video quality, you should only check Theora or H.264 codecs. However, these codecs require at least a 600MHz processor.
If you are using an old Android device (e.g. Android G1), then you should only select H.263 and H.263+.
Of course the remote party should also support the same codecs.
If you are using one-way video services (e.g. VoD, IPTV) you can use any device because the video decoding process require less CPU resources.

Audio/Video call

You can place a call from the dialer, address book or the history screen.

From the Dialer

The dialer is accessible from the home screen ().
The dialer screen is shown below.
You can enter any phone number (e.g. '+33100000000' or '0600000000'), SIP URI (e.g. 'sip:[email protected]'). If the SIP Uri is incomplete (e.g. 'bob') the application will automatically append the scheme ('sip:') and domain name('@open-ims.test') before placing the call.
If you put a telephone number with 'tel:' prefix, the client will try to map it to a SIP URI using ENUM protocol.

Dialer Screen

From the Dialer screen you can click on:
http://imsdroid.googlecode.com/svn/branches/1.0/imsdroid/res/drawable/avatar_24.png to select the phone number from the native address book.
http://imsdroid.googlecode.com/svn/branches/1.0/imsdroid/res/drawable/voice_call_48.png to make audio call.
http://imsdroid.googlecode.com/svn/branches/1.0/imsdroid/res/drawable/visio_call_48.png to make audio/video call.
http://imsdroid.googlecode.com/svn/branches/1.0/imsdroid/res/drawable/message_48.png to send a SIP MESSAGE (Short IM).

From the History

All incoming, outgoing and missed calls and message will be logged in the history screen.
To redial a number from the history screen, click on the history icon (http://imsdroid.googlecode.com/svn/branches/1.0/imsdroid/res/drawable/history_48.png) from the home screen.

History Screen History Screen with context menu

The context menu is opened when you select an entry and make a long click.

From the Address Book

The entries in the address book come from the phone unless you have enabled XCAP.

Contacts Screen Contacts Screen with context menu

In Call Screen

Once the call is placed a new screen (In Call Screen) will be automatically opened and a notification icon will be added in the status bar (http://imsdroid.googlecode.com/svn/branches/1.0/imsdroid/res/drawable/phone_call_25.png). As long as you are in call this icon will remain in the status bar. This icon will allow you to reopen the 'In Call Screen'. The Audio stream will continue even if you leave this screen or the application but the video stream will be stopped (restarted when you come back).

In Call Screen
As you can remark, your preview image only contains a white box. It's because you have to explicitly start the outgoing video stream.
This is done by clicking on the Android menu button and selecting ![http://imsdroid.googlecode.com/svn/branches/1.0/imsdroid/res/drawable/video_start_48.png](http://imsdroid.googlecode.com/svn/branches/1.0/imsdroid/res/drawable/video_start_48.png) item.
![http://imsdroid.googlecode.com/svn/branches/1.0/imsdroid/res/drawable/video_stop_48.png](http://imsdroid.googlecode.com/svn/branches/1.0/imsdroid/res/drawable/video_stop_48.png) item will be used to stop the video.
Select ![http://imsdroid.googlecode.com/svn/branches/1.0/imsdroid/res/drawable/image_gallery_48.png](http://imsdroid.googlecode.com/svn/branches/1.0/imsdroid/res/drawable/image_gallery_48.png) to share content (image, video, vcard, ...) with the remote party.
In Call Screen with context menu In Call Screen with full-duplex video
### Video Quality ### The application can decode any video size (SQCIF, QCIF, CIF, 4CIF, ...).
By default, it will encode/send QCIF video for performance reasons. To allow high quality video (CIF and above), go to Options (![http://imsdroid.googlecode.com/svn/branches/1.0/imsdroid/res/drawable/options_48.png](http://imsdroid.googlecode.com/svn/branches/1.0/imsdroid/res/drawable/options_48.png)) -> QoS/QoE (![http://imsdroid.googlecode.com/svn/branches/1.0/imsdroid/res/drawable/qos_qoe_48.png](http://imsdroid.googlecode.com/svn/branches/1.0/imsdroid/res/drawable/qos_qoe_48.png)) and change **Bandwidth** value from **Low** to **Medium** or **High**.
CIF video encoding requires at least a 600MHz processor.
* SQCIF=128x96 (Bandwidth value should be equal to **Low** or higher) * QCIF=176x144 (Bandwidth value should be equal to **Low** or higher) * CIF=352x288 (Bandwidth value should be equal to **Medium** or higher)

Content Sharing

This feature allow you to share any content. A content could be a picture, video, vcard, ...
You can share a content from these screens: Dialer, Contacts, History and In Call.
At any time you can see the pending transfers by selecting http://imsdroid.googlecode.com/svn/branches/1.0/imsdroid/res/drawable/image_gallery_25.png from the home screen or status bar.
You can select an item from the list to get more information about the transfer.

Select Content to share Pending Transfers

Calling iPhone/iPod Touch devices

If you are an iOS developer there is the aplha version of idoubs (http://code.google.com/p/idoubs/) which allows face to face chat with iPhone/iPod Touch devices.