26 |
27 |
28 | ## Build Instructions
29 |
30 | Clone this project to your local filesystem.
31 |
32 | ```sh
33 | % git clone git@github.com:sightcall/Communicator-for-Android.git
34 | ```
35 |
36 | These instructions are for Eclipse.
37 |
38 | - Create a new workspace.
39 |
40 | - Select "File >> Import"
41 |
42 | - Then select "Android >> Existing Android Code into Workspace"
43 | - click the "Next>" button
44 |
45 | - Navigate to the 'Root Directory' where you cloned the code.
46 |
47 | - Press the "Finish" button.
48 |
49 | This will import the project to your Eclipse workspace.
50 |
51 |
52 |
53 | Now, select the file `Communicator/src/com.sightcall.api/Api.java` for editing.
54 |
55 | Change the following line to match the URL of your Communicator-for-Rails instance.
56 |
57 | final String baseurl = "https://sightcall-communicator.herokuapp.com/api";
58 |
59 | You can Run the App on an Android device with an Arm7 processor. (Note:
60 | you cannot run this app on an emulator.)
61 |
62 |
63 |
64 | ## Short Feature Overview
65 |
66 | Communicator-for-Android implements the functionality required to be a
67 | good partner to Communicator-for-Rails. It can make and receive
68 | calls, and it displays the online presence of all the users in the
69 | group.
70 |
71 | Some features, like conferencing and texting have a reduced user
72 | interface that make it better-suited to be a subordinate of a
73 | Web-based user.
74 |
75 | ### Login
76 |
77 | The login page asks for the same Username and Password that you use to log into Communicator-for-Rails on the web.
78 |
79 | 
80 |
81 | After you log in you will see the following blank page. Your Username
82 | and Presence status will be shown at the top. At the bottom is one of
83 | the friends in the list of your contacts. Each contact shows their
84 | online presence as a colored circle. The two buttons at the bottom
85 | make a call and hangup a call.
86 |
87 | 
88 |
89 | To logout, use the menu item.
90 |
91 |
92 |
93 | ### Make an outgoing call
94 |
95 | Put your finger on the spinner to reveal your list of friends. Select
96 | the friend you want to call and press the "Call" button.
97 |
98 | 
99 |
100 | If the other party accepts, you will be connected in a one-to-one
101 | video call, and the name of the party will be highlighted in the
102 | Friend selector.
103 |
104 |
105 |
106 |
107 | ### Receive an incoming call
108 |
109 | If someone tries to call you, you will be presented an Incoming Call
110 | dialog. You can choose to accept or reject the call.
111 |
112 | 
113 |
114 |
115 | ### Receive a Text Message
116 |
117 | A web-based user can send you a text message. You can respond with
118 | one of three pre-defined answers.
119 |
120 | 
121 |
122 |
123 |
124 | ### Join a conference call
125 |
126 | A web-based user can invite you to join a multi-way conference call.
127 | In that case, you will be presented the following dialog. In a
128 | conference, you will see one user at a time --- the user who is
129 | speaking. We call this the "active speaker."
130 |
131 | 
132 |
133 | All SightCall conference calls can be **Recorded** to Amazon S3. A
134 | mobile call from Android is no different. The controls for recording
135 | are in the web interface, so the conference and its recording should be
136 | set there.
137 |
138 |
139 | ## The API provided by Communicator-for-Rails
140 |
141 | The API that Communicator-for-Android makes use of queries the
142 | following four endpoints. Implement similar endpoints in your own
143 | web-application if you would like to connect Communicator-for-Android
144 | to it.
145 |
146 | /api/me -- check my password and return
147 | /api/token -- obtain a SightCall authentication token
148 | /api/appid -- retrieve the SightCall App ID of this installation
149 | /api/friends -- get a list of my friends
150 |
151 |
152 | If you want to learn about the API consumed by
153 | Communicator-for-Android you can explore it using `curl`. Try these commands to learn about the JSON data returned.
154 |
155 |
156 | curl -u bob:bobpassword https://thawing-harbor-4536.herokuapp.com/api/me
157 |
158 | Using the username 'bob' with the password 'bobpassword' you should receive your username and UID in return.
159 |
160 | curl -u bob:bobpassword https://thawing-harbor-4536.herokuapp.com/api/friends
161 |
162 | This should return bob's list of friends.
163 |
164 | curl -u bob:bobpassword https://thawing-harbor-4536.herokuapp.com/api/token
165 |
166 | This should return an authentication token for user 'bob'.
167 |
168 | curl -u bob:bobpassword https://thawing-harbor-4536.herokuapp.com/api/token
169 |
170 | This should return the AppID of the instance of Communicator-for-Rails.
171 |
172 |
173 | ## Implementation Notes
174 |
175 | See the following document
176 | [Implementation Notes](doc/IMPLEMENTATIONNOTES.md) in the `doc/`
177 | directory of this repository. It talks about some of the design
178 | decisions made in the construction of this source code.
179 |
180 |
181 |
--------------------------------------------------------------------------------
/doc/screenshot_login.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xaccc/Communicator-for-Android/0a732cef527183d3f6cea1ca3577a0f5d6e757b3/doc/screenshot_login.png
--------------------------------------------------------------------------------
/ic_launcher-web.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xaccc/Communicator-for-Android/0a732cef527183d3f6cea1ca3577a0f5d6e757b3/ic_launcher-web.png
--------------------------------------------------------------------------------
/images/screenshot_chooser.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xaccc/Communicator-for-Android/0a732cef527183d3f6cea1ca3577a0f5d6e757b3/images/screenshot_chooser.png
--------------------------------------------------------------------------------
/images/screenshot_incoming_call.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xaccc/Communicator-for-Android/0a732cef527183d3f6cea1ca3577a0f5d6e757b3/images/screenshot_incoming_call.png
--------------------------------------------------------------------------------
/images/screenshot_incoming_conference.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xaccc/Communicator-for-Android/0a732cef527183d3f6cea1ca3577a0f5d6e757b3/images/screenshot_incoming_conference.png
--------------------------------------------------------------------------------
/images/screenshot_incoming_text.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xaccc/Communicator-for-Android/0a732cef527183d3f6cea1ca3577a0f5d6e757b3/images/screenshot_incoming_text.png
--------------------------------------------------------------------------------
/images/screenshot_login.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xaccc/Communicator-for-Android/0a732cef527183d3f6cea1ca3577a0f5d6e757b3/images/screenshot_login.png
--------------------------------------------------------------------------------
/images/screenshot_main.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xaccc/Communicator-for-Android/0a732cef527183d3f6cea1ca3577a0f5d6e757b3/images/screenshot_main.png
--------------------------------------------------------------------------------
/images/screenshot_quiescent.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xaccc/Communicator-for-Android/0a732cef527183d3f6cea1ca3577a0f5d6e757b3/images/screenshot_quiescent.png
--------------------------------------------------------------------------------
/libs/android-support-v4.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xaccc/Communicator-for-Android/0a732cef527183d3f6cea1ca3577a0f5d6e757b3/libs/android-support-v4.jar
--------------------------------------------------------------------------------
/libs/armeabi-v7a/libRtcc-5.4.730.so:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/xaccc/Communicator-for-Android/0a732cef527183d3f6cea1ca3577a0f5d6e757b3/libs/armeabi-v7a/libRtcc-5.4.730.so
--------------------------------------------------------------------------------
/libs/javadoc/html/com/weemo/sdk/event/WeemoEventListener.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | @Documented 87 | @Retention(value=RUNTIME) 88 | @Target(value=METHOD) 89 | public @interface WeemoEventListener90 |
WeemoEvent (or subclass)void or a primitive boolean valueWeemoEventBus.WeemoEventBus will fail fast by throwing runtime exceptions in these cases.WeemoEventBuspublic class WeemoGlobalEvent 108 | extends WeemoEvent109 |
toStringWeemoGlobalEvent event subclassesSee: Description
70 || Class | 78 |Description | 79 |
|---|---|
| AuthenticatedEvent | 83 |
84 | Event that is fired when the authentication has succeded or failed.
85 | |
86 |
| CanCreateCallChangedEvent | 89 |Deprecated
90 | Replaced by
91 | AuthenticatedEvent. |
92 |
| ConnectedEvent | 95 |
96 | Event that is fired when the connection / initialization has succeded or failed.
97 | |
98 |
| DataChannelEvent | 101 |
102 | This event is fired when you receive data through the DataChannel.
103 | |
104 |
| StatusEvent | 107 |
108 | This event is fired in response to a
109 | WeemoEngine.getStatus(String) request. |
110 |
| WeemoGlobalEvent | 113 |
114 | Base class for all Weemo global events.
115 | |
116 |
| WeemoGlobalResultEvent<T extends WeemoError> | 119 |
120 | Base class for events that can fail.
121 | |
122 |
| Enum | 131 |Description | 132 |
|---|---|
| AuthenticatedEvent.Error | 136 |
137 | Errors that can be returned if authentication fails.
138 | |
139 |
| CanCreateCallChangedEvent.Error | 142 |Deprecated | 143 |
| ConnectedEvent.Error | 146 |
147 | Errors that can be returned if connection fails
148 | |
149 |
WeemoGlobalEvent event subclasses| Class | 74 |Description | 75 |
|---|---|
| MeetingPointErrorEvent | 79 |80 | |
| MeetingPointFoundEvent | 83 |84 | |
| MeetingPointRequestAcceptedEvent | 87 |88 | |
| MeetingPointRequestDeniedEvent | 91 |92 | |
| MeetingPointRequestEvent | 95 |96 | |
| WeemoMeetingPointEvent | 99 |
100 | Base class for all
101 | WeemoMeetingPoint events. |
102 |
WeemoEvent manipulationSee: Description
70 || Class | 78 |Description | 79 |
|---|---|
| WeemoEvent | 83 |
84 | Base class for all Weemo events.
85 | |
86 |
| WeemoEventBus | 89 |
90 | Event bus for Weemo Dispatches events to listeners, and provides ways for listeners to register themselves.
91 | |
92 |
| Annotation Type | 101 |Description | 102 |
|---|---|
| WeemoEventListener | 106 |
107 | Marks a method as a WeemoEvent handler.
108 | |
109 |
WeemoEvent manipulation| Exception | 74 |Description | 75 |
|---|---|
| WeemoIllegalArgumentException | 79 |
80 | Mimics the
81 | IllegalArgumentException. |
82 |
| WeemoIllegalStateException | 85 |
86 | Mimics the
87 | IllegalStateException. |
88 |
| WeemoPermissionRequiredException | 91 |
92 | This exception is thrown by the WeemoEngine at
93 | Weemo.initialize(String, android.content.Context) when the requested Manifest.permissions can not be found in the AndroidManifest.xml file |
94 |
| WeemoRuntimeException | 97 |
98 | The
99 | RuntimeException used by Weemo SDK |
100 |
| WeemoUnsupportedOperationException | 103 |
104 | Mimics the
105 | UnsupportedOperationException. |
106 |
public static interface WeemoScreenShareInFrame.OnWeemoScreenShareInFrameTouchListener
95 | | Modifier and Type | 114 |Method and Description | 115 |
|---|---|
void |
118 | onWeemoScreenShareInFrameTouch(MotionEvent event)
119 | Called when a touch event is dispatched to a view.
120 | |
121 |
void onWeemoScreenShareInFrameTouch(MotionEvent event)144 |
event - the event being performed.public static interface WeemoVideoInFrame.OnWeemoVideoInFrameTouchListener
95 | | Modifier and Type | 114 |Method and Description | 115 |
|---|---|
void |
118 | onWeemoVideoInFrameTouch(MotionEvent event)
119 | Called when a touch event is dispatched to a view.
120 | |
121 |
void onWeemoVideoInFrameTouch(MotionEvent event)144 |
event - the event being performed.See: Description
70 || Interface | 78 |Description | 79 |
|---|---|
| WeemoScreenShareInFrame.OnWeemoScreenShareInFrameTouchListener | 83 |
84 | Interface definition for a callback to be invoked when a touch event is dispatched to this view.
85 | |
86 |
| WeemoVideoInFrame.OnWeemoVideoInFrameTouchListener | 89 |
90 | Interface definition for a callback to be invoked when a touch event is dispatched to this view.
91 | |
92 |
| Class | 101 |Description | 102 |
|---|---|
| WeemoScreenShareInFrame | 106 |
107 | This
108 | FrameLayout will display screen share from the remote contact. |
109 |
| WeemoVideoInFrame | 112 |
113 | This
114 | FrameLayout will display video from the remote contact. |
115 |
| WeemoVideoOutPreviewFrame | 118 |
119 | This
120 | FrameLayout will display preview of the video that is sent to the remote contact. |
121 |
The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
73 |Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
77 |Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
89 |Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
109 |Each annotation type has its own separate page with the following sections:
113 |Each enum has its own separate page with the following sections:
124 |There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
142 |The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
146 |These links take you to the next or previous class, interface, package, or related page.
150 |These links show and hide the HTML frames. All pages are available with or without frames.
154 |The All Classes link shows all classes and interfaces except non-static nested types.
158 |Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
162 |The Constant Field Values page lists the static final fields and their values.
166 |25 | 26 | 27 | -------------------------------------------------------------------------------- /libs/javadoc/html/overview-summary.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 |
| Package | 69 |Description | 70 |
|---|---|
| com.weemo.sdk | 74 |
75 | Base package for Weemo SDK for Android
76 | |
77 |
| com.weemo.sdk.event | 80 |
81 | Package that defines global
82 | WeemoEvent manipulation |
83 |
| com.weemo.sdk.event.call | 86 |
87 | Package that holds all
88 | WeemoCallEvent event subclasses |
89 |
| com.weemo.sdk.event.global | 92 |
93 | Package that holds all
94 | WeemoGlobalEvent event subclasses |
95 |
| com.weemo.sdk.event.meetingpoint | 98 |99 | |
| com.weemo.sdk.exception | 102 |103 | |
| com.weemo.sdk.view | 106 |
107 | Base package for Weemo SDK Views for Android
108 | |
109 |