Skip to content
master
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
sdk
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Cisco Webex Android SDK

Travis CI license

The Cisco Webex™ Android SDK

The Cisco Webex Android SDK makes it easy to integrate secure and convenient Cisco Webex messaging and calling features in your Android apps.

This SDK is built with Android SDK Tools 27 and requires Android API Level 21 or later.

Table of Contents

Install

Assuming you already have an Android project, e.g. MyWebexApp, for your Android app, here are the steps to integrate the Cisco Webex Android SDK into your project using Gradle:

  1. Add the following repository to your top-level build.gradle file:

    allprojects {
        repositories {
            jcenter()
            maven {
                url 'https://devhub.cisco.com/artifactory/webexsdk/'
            }
        }
    }
  2. Add the webex-android-sdk library as a dependency for your app in the build.gradle file:

    dependencies { 
        compile('com.ciscowebex:androidsdk:2.8.0@aar', {
            transitive = true
        })
    }
  3. Enable multidex support for your app:

    android {
        defaultConfig {
            multiDexEnabled true
        }
    }
  4. Exclude rxjava.properties in your packagingOptions :

    packagingOptions {
        exclude 'META-INF/rxjava.properties'
    }

Usage

To use the SDK, you will need Cisco Webex integration credentials. If you do not already have a Cisco Webex account, visit the Cisco Webex for Developers portal to create your account and register an integration. Your app will need to authenticate users via an OAuth grant flow for existing Cisco Webex users or a JSON Web Token for guest users without a Cisco Webex account.

See the Android SDK area of the Cisco Webex for Developers site for more information about this SDK.

Examples

Here are some examples of how to use the Android SDK in your app.

  1. Create a new Webex instance using Webex ID authentication (OAuth-based):

    String clientId = "YOUR_CLIENT_ID";
    String clientSecret = "YOUR_CLIENT_SECRET";
    String scope = "spark:all";
    String redirectUri = "https://webexdemoapp.com";
    
    OAuthWebViewAuthenticator authenticator = new OAuthWebViewAuthenticator(clientId, clientSecret, scope, redirectUri);
    Webex webex = new Webex(activity.getApplication(), authenticator)
    if (!authenticator.isAuthorized()) {
        authenticator.authorize(webView, new CompletionHandler<Void>() {
            @Override
            public void onComplete(Result<Void> result) {
                if (!result.isSuccessful()) {
                    System.out.println("User not authorized");
                }
            }
        });
    }
  2. Create a new Webex instance using Guest ID authentication (JWT-based):

    JWTAuthenticator authenticator = new JWTAuthenticator();
    Webex webex = new Webex(activity.getApplication(), authenticator);
    if (!authenticator.isAuthorized()) {
        authenticator.authorize(myJwt);
    }
  3. Register the device to Webex platform:

    webex.phone().register(new CompletionHandler<Void>() {
        @Override
        public void onComplete(Result<Void> result) {
            if (result.isSuccessful()) {
                // Device registered
            }
            else {
                // Device not registered, and calls will not be sent or received
            }
        }
    });
  4. Create a new Cisco Webex space, add users to the space, and send a message:

    // Create a Cisco Webex space:
    
    webex.spaces().create("Hello World", null, new CompletionHandler<Space>() {
        @Override
        public void onComplete(Result<Space> result) {
            if (result.isSuccessful()) {
                Space space = result.getData();
            }
            else {
                WebexError error = result.getError();
            }
        }
    });
    
    // Add a user to a space:
    
    webex.memberships().create(spaceId, null, "person@example.com", true, new CompletionHandler<Membership>() {
        @Override
        public void onComplete(Result<Membership> result) {
            if (result.isSuccessful()) {
                Membership membership = result.getData();
            }
            else {
                WebexError error = result.getError();
            }
        }
    });
    
    // Send a message to a space:
    
    webex.messages().postToSpace(spaceId, Message.Text.html("<strong>Hello</strong>", "Hello"), null, null, new CompletionHandler<Message>() {
        @Override
        public void onComplete(Result<Message> result) {
            if (result.isSuccessful()) {
                Message message = result.getData();
            }
            else {
                WebexError error = result.getError();
            }
        }
    });
  5. Make an outgoing call:

    webex.phone().dial("person@example.com", MediaOption.audioVideo(local, remote), new CompletionHandler<Call>() {
        @Override
        public void onComplete(Result<Call> result) {
            Call call = result.getData();
            if (call != null) {
                call.setObserver(new CallObserver() {
                    @Override
                    public void onRinging(Call call) {
    
                    }
    
                    @Override
                    public void onConnected(Call call) {
    
                    }
    
                    @Override
                    public void onDisconnected(CallDisconnectedEvent callDisconnectedEvent) {
    
                    }
    
                    @Override
                    public void onMediaChanged(MediaChangedEvent mediaChangedEvent) {
    
                    }
                });
            }
            else {
                WebexError error = result.getError();
            }
        }
    });
  6. Receive a call:

    webex.phone().setIncomingCallListener(new Phone.IncomingCallListener() {
        @Override
        public void onIncomingCall(Call call) {
            call.answer(MediaOption.audioVideo(local, remote), new CompletionHandler<Void>() {
                @Override
                public void onComplete(Result<Void> result) {
                    if (result.isSuccessful()) {
                        // success
                    }
                    else {
                        WebexError error = result.getError();
                    }
                }
            });
        }
    });
  7. Make an space call:

    webex.phone().dial(spaceId, MediaOption.audioVideoSharing(new Pair<>(localView,remoteView),shareView), new CompletionHandler<Call>() {
        @Override
        public void onComplete(Result<Call> result) {
            Call call = result.getData();
            if (call != null) {
                call.setObserver(new CallObserver() {
                    @Override
                    public void onConnected(Call call) {
    
                    }
    
                 	//...
    
                    @Override
                    public void onCallMembershipChanged(CallMembershipChangedEvent callMembershipChangeEvent) {
                        CallMembership membership = callMembershipChangeEvent.getCallMembership();
                        if (callMembershipChangeEvent instanceof MembershipJoinedEvent) {
    
                        } else if (callMembershipChangeEvent instanceof MembershipLeftEvent) {
    
                        } else if (callMembershipChangeEvent instanceof MembershipDeclinedEvent) {
    
                        } else if (callMembershipChangeEvent instanceof MembershipSendingVideoEvent) {
    
                        } else if (callMembershipChangeEvent instanceof MembershipSendingAudioEvent) {
    
                        } else if (callMembershipChangeEvent instanceof MembershipSendingSharingEvent) {
    
                        }
                    }
                });
            }
            else {
                WebexError error = result.getError();
            }
        }
    });
  8. Receive screen share:

    webex.phone().dial(spaceId, MediaOption.audioVideoSharing(new Pair<>(localView,remoteView),shareView), new CompletionHandler<Call>() {
        @Override
        public void onComplete(Result<Call> result) {
            Call call = result.getData();
            if (call != null) {
                call.setObserver(new CallObserver() {
                    @Override
                    public void onConnected(Call call) {
    
                    }
    
                 	//...
    
                    @Override
                    public void onMediaChanged(MediaChangedEvent mediaChangedEvent) {
                        if (mediaChangedEvent instanceof RemoteSendingSharingEvent) {
                            if (((RemoteSendingSharingEvent) mediaChangedEvent).isSending()) {
                                mediaChangedEvent.getCall().setSharingRenderView(shareView);
                            } else if (!((RemoteSendingSharingEvent) mediaChangedEvent).isSending()) {
                                mediaChangedEvent.getCall().setSharingRenderView(null);
                            }
                        }
                    }
                });
            }
            else {
                WebexError error = result.getError();
            }
        }
    });
    
  9. Start/stop sharing screen:

    activeCall.startSharing(r -> Ln.d("startSharing result: " + r));
    boolean isSharing = activeCall.isSendingSharing();
    activeCall.stopSharing(r -> Ln.d("stopSharing result: " + r));
  10. Post a message

    webex.message().post(
                targetId,
                Message.draft(Message.Text.markdown("**Hello**", "<strong>Hello</strong>", "Hello"))
                .addAttachments(localFile),
                new CompletionHandler<Message>() {
                    @Override
                    public void onComplete(Result<Message> result) {
                        if (result.isSuccessful()) {
                            // message sent success
                    ...
                        } else {
                            // message sent failed
                    ...
                        }
                    }
                });
  11. Post a threaded message

    webex.message().post(
                targetId,
                Message.draft(Message.Text.markdown("**Hello**", "<strong>Hello</strong>", "Hello"))
                .addAttachments(localFile)
                .setParent(parentMessage),
                new CompletionHandler<Message>() {
                    @Override
                    public void onComplete(Result<Message> result) {
                        if (result.isSuccessful()) {
                            // message sent success
                    ...
                        } else {
                            // message sent failed
                    ...
                        }
                    }
                });
  12. Receive a message

    webex.message().setMessageObserver(
        new MessageObserver() {
            void onEvent(MessageEvent event) {
                if (event instanceof MessageReceived) {
                    Message message = event.getMessage();
                    // new message arrived
                    if(message.getParentId() != null){
                        // threaded message
                    }
                } else if (event instanceof MessageDeleted) {
                    // message deleted
                }
            }
        }
    );
  13. Send Read Receipts

    //Mark all exist messages in space as read
    webex.message().markAsRead(spaceId);
    
    //Mark exist messages before pointed message(include) in space as read
    webex.message().markAsRead(spaceId, messageId);
  14. Multi-Stream to receive more video streams

    activeCall.setMultiStreamObserver(new MultiStreamObserver() {
        @Override
        public void onAuxStreamChanged(AuxStreamChangedEvent event) {
            if (event instanceof MultiStreamObserver.AuxStreamOpenedEvent) {
                if ((MultiStreamObserver.AuxStreamOpenedEvent)event.isSuccessful()) {
                    // success to open a stream
                    ...
                } else {
                    // fail to open a stream
                    ...
                }
            } else if (event instanceof MultiStreamObserver.AuxStreamClosedEvent) {
                if ((MultiStreamObserver.AuxStreamClosedEvent)event.isSuccessful()) {
                    // success to close a stream
                    ...
                } else {
                    // fail to close a stream
                    ...
                }
            } else if (event instanceof MultiStreamObserver.AuxStreamSendingVideoEvent) {
                ...
            } else if (event instanceof MultiStreamObserver.AuxStreamPersonChangedEvent) {
                ...
            } else if (event instanceof MultiStreamObserver.AuxStreamSizeChangedEvent) {
                ...
            }
        }
    
        @Override
        public View onAuxStreamAvailable() {
            // should return a MediaRenderView for rendering 
            return mediaRenderView;
        }
    
        @Override
        public View onAuxStreamUnavailable() {
        // should return a MediaRenderView to stop rendering or return null to let SDK handle it
            return null;
        }
    });
  15. Set MembershipObserver to receive Membership events

    webex.memberships().setMembershipObserver(new MembershipObserver() {
            @Override
            public void onEvent(MembershipEvent event) {
                //The WebexEventPayload.
                WebexEvent.Payload payload = event.getPayload();
                ...
                if (event instanceof MembershipCreated) {
                    //The event when a new membership has added to a space.
                    ...
                } else if (event instanceof MembershipDeleted) {
                    //The event when a membership has removed from a space.
                    ...
                } else if (event instanceof MembershipUpdated) {
                    //The event when a membership moderator status changed
                    ...
                }else if (event instanceof MembershipSeen){
                    //The event when a user has sent a read receipt
                    ...
                }
            }
        });
  16. Set SpaceObserver to receive Space events

    webex.spaces().setSpaceObserver(new SpaceObserver() {
            @Override
            public void onEvent(SpaceEvent event) {
                //The WebexEventPayload.
                WebexEvent.Payload payload = event.getPayload();
                
                if (event instanceof SpaceCreated){
                    //The event when a new space was created
                    ...
                }else if (event instanceof SpaceUpdated){
                    //The event when a space was changed (usually a rename)
                    ...
                }
            }
        });
  17. Get space meeting details

    webex.spaces().getMeeting(spaceId, new CompletionHandler<SpaceMeeting>() {
            @Override
            public void onComplete(Result<SpaceMeeting> result) {
                if (result.isSuccessful()){
                    SpaceMeeting spaceMeeting = result.getData();
                    ...
                }
            }
        });
  18. Get read status of a space

    webex.spaces().getWithReadStatus(spaceId, new CompletionHandler<SpaceReadStatus>() {
            @Override
            public void onComplete(Result<SpaceReadStatus> result) {
                if (result.isSuccessful()){
                    SpaceReadStatus spaceReadStatus = result.getData();
                    ...
                }
            }
        });
  19. Join password-protected meetings

    mediaOption.setModerator(boolean moderator);
    
    mediaOption.setPin(String pin);
  20. Change the video layout during a call

    activeCall.setVideoLayout(MediaOption.VideoLayout layout);
  21. Specify how the remote video adjusts its content to be render in a view

    activeCall.setRemoteVideoRenderMode(VideoRenderMode mode);
  22. Change the max sending fps for video

    webex.phone().setAdvancedSetting(new VideoMaxTxFPS(int value));
  23. Enable(disable) android.hardware.camera2

    webex.phone().setAdvancedSetting(new VideoEnableCamera2(boolean enable));
  24. Whether the app can continue video streaming when app in background

    webex.phone().enableBackgroundStream(boolean enable);
  25. Get a list of spaces that have ongoing call

    webex.spaces().listWithActiveCalls(r -> {});
  26. Check if the message mentioned everyone in space

    message.isAllMentioned()
  27. Get all people mentioned in the message

    message.getMentions()
  28. Change the max capture fps when screen sharing

    webex.phone().setAdvancedSetting(new ShareMaxCaptureFPS(int value));
  29. Switch the audio play output mode during a call

    activeCall.switchAudioOutput(AudioOutputMode audioOutputMode);
  30. Enable Background Noise Removal(BNR)

    webex.phone().enableAudioBNR(boolean enable);
  31. Set Background Noise Removal(BNR) mode

    webex.phone().setAudioBNRMode(Phone.AudioBRNMode mode);
  32. Edit message

     messageClient.edit(originalMessage, Message.Text.plain("edit"), mentions, rst -> {
                                        if (rst.isSuccessful()) {
                                            ...
                                        }
                                    });
  33. Enable background connection

    webex.phone().enableBackgroundConnection(boolean);

Migrating from Cisco Spark Android SDK

The purpose of this guide is to help you to migrate from Cisco Spark Android SDK to Cisco Webex Android SDK.

Install

Assuming you already have an Android project with Spark Android SDK integrated. For your Android app, here are the steps to migrate to use Webex Android SDK:

  1. Change the maven repository url in your top-level build.gradle file:

    allprojects {
        repositories {
            jcenter()
            maven {
                // url 'https://devhub.cisco.com/artifactory/sparksdk/'
                url 'https://devhub.cisco.com/artifactory/webexsdk/'
            }
        }
    }
  2. Update the library dependency for your app in the build.gradle file:

    dependencies { 
        // compile('com.ciscospark:androidsdk:1.4.0@aar', {
        //     transitive = true
        // })
        implementation('com.ciscowebex:androidsdk:2.7.0@aar', {
            transitive = true
        })
    }

Usage

Here are API changes list from Spark Android SDK to Webex Android SDK.

Description Spark Android SDK Webex Android SDK
Package name com.ciscospark.androidsdk com.ciscowebex.androidsdk
Create a new instance Spark spark = new Spark(application, authenticator) Webex webex = new Webex(application, authenticator)
Get error response SparkError error = result.getError() WebexError error = result.getError()
Rename Room to Space spark.rooms().get(roomId, CompletionHandler< Room > handler) webex.spaces().get(spaceId, CompletionHandler< Space > handler)

Contribute

Pull requests welcome. To suggest changes to the SDK, please fork this repository and submit a pull request with your changes. Your request will be reviewed by one of the project maintainers.

License

© 2016-2021 Cisco Systems, Inc. and/or its affiliates. All Rights Reserved.

See LICENSE for details.