PSIptt - Push-To-Talk Client API Documentation

Transcription

1 PSIptt - Push-To-Talk Client API Documentation Version Stand PSI Transcom GmbH 2009

2 Content 1 INTRODUCTION REQUIREMENTS CONCEPT ONLINE RESOURCES: EXAMPLES J2SE CLIENT API INTEGRATION WEB BASED JAVA APPLET EXAMPLE Applet example HTML code...9 Seite 2 von 10

3 1 Introduction In this document the PSIptt JAVA Client API will be introduced and explained by example. This document only describes the current Version of the API wich may change at any time. So there will be some handworks nessecary to upgrade to a newer version. 1.1 Requirements To use this API you need to have a JAVA RuntimeEnvironment version 1.5 or greater. For integration projects the JAVA version of the project application needs to be at least version 1.5.

4 2 Concept The PSIptt Client API consists of one jar-file, JavaDoc and Examples. At the moment the jar-file being used is the same file as the pttclient.jar from the PC desktop client. It will be separated to a smaller file (not containing the GUI code) to reduce space and netload on web-based applications. 2.1 Online Resources: The current JavaDocs and other manuals and guides can be found at Furthermore there are some examples wich show how to use the API. Location: The current version of the API itself is contained in the restricted area on or can be requested directly from PSI Transcom GmbH via mail to mailto://elco@psi.de.

5 3 Examples Following this examples show the possibility to integrate PSIptt into nearly any JAVA application. The examples shown here are very basic and cover only simple features such as connection establishment. To See a complete List of possible API functions and listeners see online JavaDoc. 3.1 J2SE Client API Integration In this example we show a simple setup to connect with the API to a PSIptt server. The only thing it does is printing successful connection to stdout. Groupcalls are also being played so you are able to listen already, if your VM supports the Java MM API. package de.psi.telco.voip.clientapi.examples; import de.psi.telco.voip.clientapi.pttabstractclientlistener; import de.psi.telco.voip.clientapi.pttclientimpl; import de.psi.telco.voip.clientapi.pttclientinterface; import de.psi.telco.voip.clientapi.pttclientlistener; import de.psi.telco.voip.protocol.descriptors.clientdescriptor; /** * This example shows how to create a PTTClient connection using the PTT Client API. will * */ public class PTTClientApiExample { public static void main(string[] args) { // create client instance PTTClientInterface client = new PTTClientImpl(); // create some example listeners // see PTTClientListener for useabel functions PTTClientListener examplelistener = new public void onpttconnected(clientdescriptor arg0) { System.out.println("PTTClient conenction established"); public void onpttdisconnected(int arg0) { System.out.println("PTTClient disconnected");

6 // register listener client.addlistener(examplelistener); // do some connection config client.sethost("ptt.psi.de"); client.setport(4374); client.setcredentials("customer", "username", "password"); // and connect client.startpttclient(); 3.2 Web Based JAVA Applet Example This Example is a PSIptt client via Java Applet in a brwoser. package de.psi.telco.voip.clientapi.examples; import java.awt.dimension; import java.awt.event.mouseevent; import java.awt.event.mouselistener; import javax.swing.japplet; import javax.swing.jbutton; import javax.swing.jlabel; import javax.swing.jpanel; import org.apache.log4j.appender; import org.apache.log4j.consoleappender; import org.apache.log4j.logger; import org.apache.log4j.patternlayout; import de.psi.telco.util.noobfuscate; import de.psi.telco.voip.clientapi.pttabstractclientlistener;

7 import de.psi.telco.voip.clientapi.pttclientimpl; import de.psi.telco.voip.clientapi.pttclientinterface; import de.psi.telco.voip.clientapi.pttclientlistener; import de.psi.telco.voip.protocol.descriptors.clientdescriptor; /** * This example demonstrate how to integrate PSIptt client into an Web Application using a JavaApplet. will * */ public class PTTClientAppletExample extends JApplet implements NoObfuscate{ // config public static String HOST = "ptt.psi.de"; public static int PORT = 4374; public static String CUSTOMER = "customer"; public static String USER = "username"; public static String PASSWORD = "password"; // controller PTTClientInterface client; PTTClientListener clientlistener; // view JPanel mainpanel; JButton sendbutton; JLabel label; public void init(){ // reassign log4j Appender appender = new ConsoleAppender(new PatternLayout(), "System.out"); Logger.getRootLogger().removeAllAppenders(); Logger.getRootLogger().addAppender(appender); /* * Init Applet GUI */ mainpanel = new JPanel(); mainpanel.setpreferredsize(new Dimension(200,100)); label = new JLabel("PTTClient: conencting"); mainpanel.add(label); sendbutton = new JButton(); sendbutton.settext("send"); sendbutton.setenabled(false); // not connected at first mainpanel.add(sendbutton); addbuttonlistener(); /* * Now PTT stuff */ client = new PTTClientImpl(); addclientlistener(); // see funtion below // load applet config (given via HTML) loadparams();

8 this.add(mainpanel); private void loadparams() { if (getparameter("host")!= null){ HOST = getparameter("host"); if (getparameter("port")!= null){ PORT = Integer.parseInt(getParameter("port")); if (getparameter("customer")!= null){ CUSTOMER = getparameter("customer"); if (getparameter("username")!= null){ USER = getparameter("username"); if (getparameter("password")!= null){ PASSWORD = getparameter("password"); // and tell client to use values client.sethost(host); client.setport(port); client.setcredentials(customer, USER, PASSWORD); public void start(){ client.startpttclient(); mainpanel.setvisible(true); public void stop(){ client.stoppttclient(); mainpanel.setvisible(false); /** * This method defines and binds our example client listener that enables and disables the button. * */ private void addclientlistener(){ clientlistener = new public void onpttconnected(clientdescriptor arg0) { sendbutton.setenabled(true); label.settext("pttclient: connected"); public void onpttdisconnected(int arg0) { sendbutton.setenabled(false); label.settext("pttclient: disconnected");

9 client.addlistener(clientlistener); private void addbuttonlistener(){ sendbutton.addmouselistener(new MouseListener(){ public void mouseclicked(mouseevent e) { public void mouseentered(mouseevent e) { public void mouseexited(mouseevent e) { public void mousepressed(mouseevent e) { client.startgroupcall(); public void mousereleased(mouseevent e) { client.stopgroupcall(); ); Applet example HTML code Following HTML code loads the applet using credentials parameters from HTML. This is useful for external user management from calling Web-Applications. So, make sure you edit the parameters custmer, username, password (XXX, YYY, ZZZ in code below) accordingly to match your PSIptt account! <html> <head> <title>pttclientapplet Example</title> </head> <body> <h1>pttclientapplet Example</h1> <!-- Applet Code --> <OBJECT classid="clsid:8ad9c e-11d1-b3e f499d93" width="200px" height="100px" codebase=" /jinstall-1_2_2-win.cab#Version=1,2,2,0"> <PARAM name="java_code" value="de.psi.telco.voip.clientapi.examples.pttclientappletexample.class"> <PARAM name="java_archive" value="pttclient.jar"> <PARAM name="type" value="application/x-javaapplet;version=1.5"> <PARAM name="customer" value="xxx"> <PARAM name="username" value="yyy"> <PARAM name="password" value="zzz"> <COMMENT> <EMBED type="application/x-java-applet;version=1.5" width="200px" height="100px" pluginspage=" java_code="de.psi.telco.voip.clientapi.examples.pttclientappletexample.clas s" java_archive="pttclient.jar" customer="xxx" username="yyy" password="zzz" /> <NOEMBED>Your browser does not support this JAVA applet.</noembed> </COMMENT> </OBJECT> </body>

10 </html>