Popup application
This tutorial demonstrates how to build a new multimedia application based on the joyn technology.
The idea of the Popup application is to offer a service which allows one to send animated popups to remote joyn contacts who also have the same application on their devices.
A Popup is composed of a text message, an over-the-top picture and an animation used to display the picture in over-the-top.
The application offers several harcoded Popups. A Text-To-Speech synthesis may also be requested on the remote device to play the text message.
See the following video from the last Mobile World Congress (2012):
This application uses the following APIs :
-
The Capability API to define a new capability (e.g. extension) corresponding to the Popup service.
-
The Contact API to extract contacts supporting the Popup service and to know which contact is online or not.
-
The Multimedia Session y API to send and receive Popups.
-
The Android TTS API
How to implement the Popup application?
1. Define a new capability or extension
The new capability is just declared in the Manifest file of the application and that's it. Then when the application is installed on the device, the joyn service in background will detect it and will automatically share this new capability with joyn contacts of your Address Book.
<activity android:name=".SendPopup">
<intent-filter>
<action android:name="com.gsma.services.rcs.capability.EXTENSION"/>
<data android:mimeType="com.gsma.services.rcs/mnc01.mcc208.popup"/>
</intent-filter>
</activity>
2. Display contacts supporting the Popup service
We want to display contacts from the device Address Book supporting the Popup service and which are online in order to interract with them immediately. By using the Contact API, there are directly methods to find joyn contacts for a given capability :
// Service ID for the service
public static final String SERVICE_ID = "mnc01.mcc208.popup";
Set<JoynContact> supportedContacts = contactsApi.getJoynContactsSupporting(PopupManager.SERVICE_ID);
for (JoynContact contact : supportedContacts) {
if (contact.isRegistered()) {
Log.d(TAG, "Add online contact " + contact.getContactId());
items.add(new ContactItem(contact.getContactId()));
}
}
In general a joyn application first displays the list of contacts from its local database and then executes a capability refresh in background in order to update capabilities and availability of contacts.
// Refresh capability task
private class RefreshCapabilitiesAsyncTask extends AsyncTask<Void, Void, Void> {
@Override
protected void onPreExecute() {
super.onPreExecute();
}
@Override
protected Void doInBackground(Void... params) {
Set<JoynContact> rcsContacts = contactsApi.getJoynContacts();
for (JoynContact contact : rcsContacts) {
capabilityApi.requestContactCapabilities(contact.getContactId());
}
...
return null;
}
@Override
protected void onPostExecute(Void result) {
super.onPostExecute(result);
}
}
...
// Then use the CapabilitiesListener to receive the result and to update the list of contacts
3. Define a protocol to implement your new service
Here we just want to send an instant message or a popup, so there is no session lasting over time. In this case the best practice is to use the method MultimediaSessionService.sendMessage which permits to send a SIP MESSAGE to the joyn network :
Then we should also define the format used to transfer the Popup information (text message, TTS option and animation). Here we have decided to use an XML format as the follows :
"<?xml version=\"1.0\" encoding=\"UTF-8\"?>" + CRLF +
"<popup>" + CRLF +
"<message>" + message + "</message>" + CRLF +
"<animation>" + animation + "</animation>" + CRLF +
"<timeout>" + DateUtils.encodeDate(System.currentTimeMillis()) + "</timeout>" + CRLF +
"<tts>" + Boolean.toString(tts) + "</tts>" + CRLF +
"</popup>";
4. Implement the sender side (see class SendPopup)
The end user should select 1 or more contacts from the list of joyn contacts displayed in step 2. Then we use the Multimedia Session API to send the selected Popup to each contact sequentially.
for(int i=0; i < selectedContacts.size(); i++) {
...
ContactItem contact = selectedContacts.get(i);
boolean result = sessionApi.sendMessage(PopupManager.SERVICE_ID,
contact.number,
PopupManager.generatePopup(message, animation, tts));
...
}
The static PopupManager.SERVICE_ID contains the capability extension defined in step 1.
5. Implement the receiver side (see class PopupReceiver)
An incoming Popup is catched via the Intent MultimediaMessageIntent. See the following Intent receiver defined in the Manisfest file :
<receiver android:name=".PopupReceiver">
<intent-filter>
<action android:name="com.gsma.services.rcs.session.action.NEW_MESSAGE" />
<data android:mimeType="com.gsma.services.rcs/orange.popup" />
<category android:name="android.intent.category.LAUNCHER" />
category android:name="android.intent.category.DEFAULT" />
</intent-filter>
</receiver>
Then the XML content received in the incoming Intent is parsed and the Popup is displayed in over-the-top :
// Parse received popup
String content = getIntent().getStringExtra("content");
InputSource input = new InputSource(new ByteArrayInputStream(content.getBytes()));
PopupParser parser = new PopupParser(input);
// Display message
String remote = getIntent().getStringExtra("contact");
String txt = parser.getMessage();
String msg = getString(R.string.label_remote, remote) + "\n" + txt;
TextView msgView = (TextView)findViewById(R.id.message);
msgView.setText(msg);
// Play TTS
if (parser.isTTS() && !TextUtils.isEmpty(txt)) {
Intent ttsIntent = new Intent(getApplicationContext(), PlayTTS.class);
ttsIntent.putExtra("message", txt);
startService(ttsIntent);
}
// Make a vibration
Vibrator vibrator = (Vibrator)getSystemService(Context.VIBRATOR_SERVICE);
long[] pattern = {500L, 200L, 500L};
vibrator.vibrate(pattern, -1);
// Display animation
ImageView imageView = (ImageView)findViewById(R.id.picture);
imageView.setClickable(true);
imageView.setFocusable(true);
imageView.setOnClickListener(this);
String animation = parser.getAnimation();
InputStream stream = getResources().getAssets().open(animation.toLowerCase() + ".png");
Drawable d = Drawable.createFromStream(stream, null);
imageView.setImageDrawable(d);
// Play animation
Animation hyperspaceJumpAnimation = AnimationUtils.loadAnimation(this, R.anim.zoom);
imageView.startAnimation(hyperspaceJumpAnimation);
See the complete source code of the application here.
Follow @androidrcsstack