Getting Started with the Temasys SDK for Android

A step-by-step guide to embedding Real-Time Communication features into your Android application

Fully encrypted, peer-to-peer and multiparty real-time communications features inside your app, in just a few lines of code? YES! Check it out!

This document is designed to help you start using the Temasys SDK for Android. This SDK supports features like video & voice calling, secure messaging, and more INSIDE any Android application.

Step 1: Create an Account on the Temasys Console (Skip to Step 5 if you have already created an account and generated an App key)

The first step to getting started is to create an account on the Temasys Console here: https://console.temasys.io/register.

Use the Temasys Console to create an App Profile and get an App Key. Once you create an account, you will receive a verification email.

Click the link in the verification email, and then log into the Temasys Console to let the fun begin.

Step 2: Create an App Profile

Once you’ve logged into the Temasys Console, choose Manage Apps.

    Here you will see the Create App form where you can create your App Profile.
    Add your Application’s name, brief description, related website, the category and how many users you expect to be using your app.
    Click Create.

Step 3: Select the Free Billing Option

You’ll see a Billing screen with two options.

All plans come with at least 30 days of Free Trial. You get access to all Skylink features for free, during the trial.

Click Subscribe. This confirms your billing option.

Once you’re ready to move your app to production, you can come back to this screen and select the option that best fits your needs.


Step 4: Get an App Key

Once you’ve logged into the Temasys Console, choose Manage Apps.

    Here you will see the Create App form where you can create your App Profile.
    Add your Application’s name, brief description, related website, the category and how many users you expect to be using your app.
    Click Create.

Step 5: Begin Your Project

    1. Add the Android SDK to your project
    2. Implement Listeners in the class receiving events from the Temasys SDK.
      Note: 
      A list of listeners available in the current release and the callbacks they provide can be found here. For older versions just replace “latest” in the URL with the SDK version. 
    3. Always implement LifeCycleListener and RemotePeerListener. The “listeners” are as follows:
          • Audio Call : Implement MediaListener
          • Video Call : Implement MediaListener
          • File Transfer : Implement FileTransferListener
          • Data Transfer : Implement DataTransferListener
          • Messaging : Implement MessageListener
          • Recording : Implement RecordingListener
      public class VideoCallFragment extends Fragment implements
      LifeCycleListener, MediaListener, RemotePeerListener{
      
      /**Implementation of callbacks provided the listeners**/
      ... .....
      }
    4. Initialize SkylinkConfig to specify the desired functionality from the Temasys SDK
      private SkylinkConfig getSkylinkConfig() {
          SkylinkConfig config = new SkylinkConfig();
          config.setAudioVideoSendConfig(SkylinkConfig.AudioVideoConfig.AUDIO_AND_VIDEO);
          config.setAudioVideoReceiveConfig(SkylinkConfig.AudioVideoConfig.AUDIO_AND_VIDEO);
          config.setHasPeerMessaging(true); config.setHasFileTransfer(true);
          config.setHasDataTransfer(true);
          config.setTimeout(60);
          return config;
      }
      There are four configurations available for  AudioVideoConfig

      • SkylinkConfig.AudioVideoConfig.AUDIO_AND_VIDEO
      • SkylinkConfig.AudioVideoConfig.NO_AUDIO_NO_VIDEO
      • SkylinkConfig.AudioVideoConfig.AUDIO_ONLY
      • SkylinkConfig.AudioVideoConfig.VIDEO_ONLY
    5. Initialize SkylinkConnection object. You can initialize the SkylinkConnection object by providing the App key and secret obtained from the Temasys Console and the config object (obtained in step 3). This registers your application key with the Temasys server.
      SkylinkConnection skylinkConnection;
      .....
      .....
      public void onCreate(Bundle savedInstanceState) {
          super.onCreate();
          skylinkConnection = SkylinkConnection.getInstance();
          skylinkConnection.init(getString(R.string.app_key), getSkylinkConfig(),
          this.getActivity().getApplicationContext());
      
          // register respective listeners
      
         skylinkConnection.setLifeCycleListener(this);
         skylinkConnection.setMediaListener(this);
         skylinkConnection.setRemotePeerListener(this);
         .........
         .........
      }
    6. Connect to a room using the Temasys SDK
      A room is where two peers can join and interact with each other. The roomName can be any alpha-numeric value. The next example shows that two peers will enter a room named “MyRoom”, where they can communicate with one another:

      // you will be connected to the room named "roomName" using a user name or user data object.
      skylinkConnection.connectToRoom("secret", "roomName", "userName");

      Note: The Temasys SDK also provides a more secure credentials-based method for connecting to a room. Click here for information on generating credentials from your application server. We strongly recommend using the credentials method for production applications.

    7. Verify connectivity by implementing debug logging in the callbacks of LifeCycleListener
      /***
      * Lifecycle Listener Callbacks -- triggered during events that happen during the SDK's lifecycle
      *//**
      * Triggered when connection is successful
      *
      * @param isSuccess
      * @param message
      */
      @Override
      public void onConnect(boolean isSuccess, String message) {
          if (isSuccess) {
              Toast.makeText(getActivity(), "Connected to room ").show();
          } else {
              Log.d(TAG, "Skylink Connection Failed");
          }
      }
      
      @Override
      public void onWarning(int errorCode, String message) {
          String log = "Warning is errorCode " + errorCode + ". Message: " + message + ".";
          Log.d(TAG, log);
      }
      
      @Override
      public void onDisconnect(int errorCode, String message) {
          String log = "";
          if (errorCode == Errors.DISCONNECT_FROM_ROOM) {
              log += "We have successfully disconnected from the room.";
          } else if (errorCode == Errors.DISCONNECT_UNEXPECTED_ERROR) {
              log += "WARNING! We have been unexpectedly disconnected from the room!";
          }
          log += " Server message: " + message;
          Log.d(TAG, log);
      }
      
      @Override
      public void onReceiveLog(int infoCode, String message) {
          switch (infoCode) {
              case CAM_SWITCH_FRONT:
              case CAM_SWITCH_NON_FRONT:
              case CAM_SWITCH_NO:
                  Toast.makeText(getActivity(), message, Toast.LENGTH_SHORT).show();
                  break;
              default:
              Log.d(TAG, "Received SDK log: " + message);
              break;
          }
      }

We hope this helps you get started with the Temasys SDK for Android! Have fun and please contact us if you need any assistance!

ADDITIONAL RESOURCES

To further demonstrate the possibilities and flexibility of the Temasys SDK for Android, please refer to our simple demo application.  

Temasys Developer Console

Getting Started Guide for the Web

Getting Started Guide for iOS

Leave a Reply

Your email address will not be published. Required fields are marked *