42 | * Created by benrandall76@gmail.com on 26/04/2016.
43 | */
44 | public class MyIntentService extends IntentService {
45 |
46 | /**
47 | * TAG
48 | */
49 | private final String CLS_NAME = MyIntentService.class.getSimpleName();
50 |
51 | /**
52 | * Constants to identify keyphrases
53 | */
54 | public static final int DO_NOT_USE_ZERO = 0;
55 | public static final int DO_SOMETHING_1 = 1;
56 | public static final int DO_SOMETHING_2 = 2;
57 | public static final int DO_SOMETHING_3 = 3;
58 |
59 | /**
60 | * Compulsory Constructor
61 | */
62 | public MyIntentService() {
63 | super(MyIntentService.class.getSimpleName());
64 | }
65 |
66 | @Override
67 | public void onCreate() {
68 | Log.i(CLS_NAME, "onCreate");
69 | super.onCreate();
70 | }
71 |
72 | @Override
73 | protected void onHandleIntent(final Intent intent) {
74 | Log.i(CLS_NAME, "onHandleIntent");
75 |
76 | if (intent != null && intent.getExtras() != null) {
77 | examineIntent(intent.getExtras());
78 |
79 | switch (intent.getIntExtra(SaiyKeyphrase.SAIY_ACTION, 0)) {
80 |
81 | case DO_SOMETHING_1:
82 | Log.i(CLS_NAME, "onHandleIntent: DO_SOMETHING_1");
83 | // Do whatever you like here!
84 | simulateDoingSomething(intent.getExtras());
85 | break;
86 | case DO_SOMETHING_2:
87 | Log.i(CLS_NAME, "onHandleIntent: DO_SOMETHING_2");
88 | // Do whatever you like here!
89 | simulateDoingSomething(intent.getExtras());
90 | break;
91 | case DO_SOMETHING_3:
92 | Log.i(CLS_NAME, "onHandleIntent: DO_SOMETHING_3");
93 | // Do whatever you like here!
94 | simulateDoingSomething(intent.getExtras());
95 | break;
96 | case DO_NOT_USE_ZERO:
97 | Log.e(CLS_NAME, "onHandleIntent: DO_NOT_USE_ZERO");
98 | // Don't deliberately use zero as the 'action number'. It's the default number
99 | // set above if the SAIY_ACTION is missing - which it shouldn't be.
100 | break;
101 | }
102 | } else {
103 | Log.e(CLS_NAME, "onHandleIntent: intent should not be null!?!");
104 | }
105 | }
106 |
107 | /**
108 | * Reacting to the keyphrase callback, you obviously can kick off any functionality
109 | * your application provides. Here we'll simply send the results
110 | * to {@link ai.saiy.android.apiexample.ui.fragment.FragmentDemoCommand} (via the parent activity)
111 | * and display them in the text view.
112 | *
113 | * @param bundle the bundle of extras returned with
114 | */
115 | private void simulateDoingSomething(@NonNull final Bundle bundle) {
116 |
117 | final Intent intent = new Intent(getApplicationContext(), MainActivity.class);
118 | intent.putExtras(bundle);
119 | intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
120 | getApplicationContext().startActivity(intent);
121 | }
122 |
123 | /**
124 | * For debugging the intent extras
125 | *
126 | * @param bundle containing potential extras
127 | */
128 | private void examineIntent(final Bundle bundle) {
129 | Log.i(CLS_NAME, "examineIntent");
130 |
131 | if (bundle != null) {
132 | final Set keys = bundle.keySet();
133 | for (final String key : keys) {
134 | Log.v(CLS_NAME, "examineIntent: " + key + " ~ " + bundle.get(key));
135 |
136 | }
137 | } else {
138 | Log.w(CLS_NAME, "examineIntent: bundle was null. This should not happen, as the speech results" +
139 | "and confidence should be returned, in addition to any parameters you originally set");
140 | }
141 | }
142 | }
143 |
--------------------------------------------------------------------------------
/app/src/main/res/layout/fragment_demo_basic.xml:
--------------------------------------------------------------------------------
1 |
2 |
17 |
18 |
25 |
26 |
43 |
44 |
57 |
58 |
71 |
72 |
73 |
103 |
104 |
105 |
116 |
117 |
118 |
144 |
145 |
--------------------------------------------------------------------------------
/app/src/main/java/ai/saiy/android/apiexample/configuration/SaiyConfiguration.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2016 Saiy™ Ltd
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package ai.saiy.android.apiexample.configuration;
18 |
19 | import android.content.Context;
20 | import android.net.Uri;
21 | import android.support.annotation.NonNull;
22 |
23 | import java.util.Locale;
24 |
25 | import ai.saiy.android.api.Defaults;
26 | import ai.saiy.android.api.language.nlu.NLULanguageNuance;
27 | import ai.saiy.android.api.language.tts.TTSLanguageNuance;
28 | import ai.saiy.android.api.language.vr.VRLanguageNuance;
29 | import ai.saiy.android.api.request.SaiyRequestParams;
30 | import ai.saiy.android.apiexample.R;
31 |
32 | /**
33 | * Class containing your Text to Speech and Voice Recognition API keys. Obviously structured like this
34 | * for testing purposes only.
35 | *
36 | * Created by benrandall76@gmail.com on 12/02/2016.
37 | */
38 | public class SaiyConfiguration {
39 |
40 | /**
41 | * MUST BE SET TO FALSE FOR PRODUCTION!
42 | */
43 | private static boolean DEBUG = false;
44 |
45 | public static void setLogging(final boolean enabled) {
46 | DEBUG = enabled;
47 | }
48 |
49 | public static boolean getLogging() {
50 | return DEBUG;
51 | }
52 |
53 | /**
54 | * Used with {@link android.content.Intent#ACTION_VIEW}
55 | */
56 | public static String SAIY_PLAYSTORE_URL = "https://play.google.com/store/apps/details?id=ai.saiy.android";
57 |
58 | /**
59 | * Enter your Google Chromium Speech API key below. You need to register in the Google Group and
60 | * enable this in your API console. Without doing both, it WILL NOT WORK!
61 | */
62 | public static String GOOGLE_CHROMIUM_API_KEY = "_your_key_here_";
63 |
64 | /**
65 | * Saiy will not handle refreshing your access token. If you want to use Google's Cloud Speech API
66 | * you will need to introduce your own code to fetch an access token from your server. For testing purposes,
67 | * you can enter the details below.
68 | */
69 | public static String GOOGLE_CLOUD_ACCESS_TOKEN = "_your_access_token_here";
70 | public static long GOOGLE_CLOUD_ACCESS_EXPIRY = -1L;
71 |
72 | /**
73 | * Enter your Nuance App configuration details below. Your credentials can be found in your
74 | * Nuance Developers portal, under "Manage My Apps
75 | */
76 | public static final String NUANCE_APP_KEY = "_your_app_key_here_";
77 | public static final String NUANCE_APP_ID = "_your_app_id_here_";
78 | public static final String NUANCE_SERVER_HOST = "hiy.nmdp.nuancemobility.net";
79 | public static final String NUANCE_SERVER_HOST_NLU = "nmsps.dev.nuance.com";
80 | public static final String NUANCE_SERVER_PORT = "443";
81 |
82 | public static final Uri NUANCE_SERVER_URI = Uri.parse("nmsps://" + NUANCE_APP_ID + "@"
83 | + NUANCE_SERVER_HOST + ":" + NUANCE_SERVER_PORT);
84 | public static final Uri NUANCE_SERVER_URI_NLU = Uri.parse("nmsps://" + NUANCE_APP_ID + "@"
85 | + NUANCE_SERVER_HOST_NLU + ":" + NUANCE_SERVER_PORT);
86 |
87 | // Only needed if using NLU
88 | public static final String NUANCE_CONTEXT_TAG = "_your_context_tag_here_";
89 |
90 | /**
91 | * Enter your API AI configuration details below.
92 | */
93 | public static final String API_AI_CLIENT_ACCESS_TOKEN = "_your_access_token_here_";
94 |
95 | /**
96 | * Enter your Microsoft configuration details below.
97 | */
98 | public static final String OXFORD_KEY_1 = "_your_key_here_";
99 | public static final String OXFORD_KEY_2 = "_your_key_here_";
100 |
101 | // Only needed if using NLU
102 | public static final String LUIS_APP_ID = "_your_app_id_here_";
103 | public static final String LUIS_SUBSCRIPTION_ID = "_your_subscription_id_here_";
104 |
105 | /**
106 | * Enter your IBM configuration details below.
107 | */
108 | public static String IBM_SERVICE_USER_NAME = "_your_user_name_here";
109 | public static String IBM_SERVICE_PASSWORD = "_your_password_here";
110 |
111 | /**
112 | * Enter your Wit configuration details below.
113 | */
114 | public static String WIT_SERVER_ACCESS_TOKEN = "_your_access_token_here";
115 | public static final String WIT_SPEECH_URL = "https://api.wit.ai/speech?v=20160526";
116 |
117 | /**
118 | * Enter your own personal server configuration details below.
119 | */
120 | public static final Uri REMOTE_SERVER_URI = Uri.parse("_your_server_uri_here");
121 | public static final String REMOTE_ACCESS_TOKEN = "_your_remote_access_token_here";
122 |
123 |
124 | /**
125 | * An example of fixed parameters you would use in production.
126 | *
127 | * @param ctx the application context
128 | * @param locale the resolved {@link Locale} of the request
129 | * @return populated {@link SaiyRequestParams}
130 | */
131 | public static SaiyRequestParams getProductionParams(@NonNull final Context ctx, @NonNull final Locale locale) {
132 |
133 | final SaiyRequestParams productionParams = new SaiyRequestParams();
134 |
135 | // Local
136 | productionParams.setTTSProvider(Defaults.TTS.LOCAL);
137 | productionParams.setVRProvider(Defaults.VR.NATIVE);
138 | productionParams.setLanguageModel(Defaults.LanguageModel.LOCAL);
139 |
140 | productionParams.setTTSLanguageLocal(locale);
141 | productionParams.setVRLanguageNative(locale);
142 |
143 | productionParams.setAction(Defaults.ACTION.SPEAK_LISTEN);
144 | productionParams.setUtterance(ctx.getApplicationContext().getString(R.string.default_intro));
145 |
146 | return productionParams;
147 |
148 | }
149 |
150 | /**
151 | * If you are likely to repeatedly use the same Text to Speech and Voice Recognition provider
152 | * then change the values below. You'll be able to use them in the {@link ai.saiy.android.api.request.SaiyRequest}
153 | * constructor.
154 | *
155 | * Obviously, only leave in the parameters you are going to use.
156 | *
157 | * @param ctx the application context
158 | * @return populated {@link SaiyRequestParams}
159 | */
160 | public static SaiyRequestParams getDefaultParams(@NonNull final Context ctx) {
161 |
162 | final Locale locale = Locale.getDefault();
163 |
164 | final SaiyRequestParams defaultParams = new SaiyRequestParams();
165 |
166 | // Local
167 | defaultParams.setTTSLanguageLocal(locale);
168 | defaultParams.setTTSProvider(Defaults.TTS.LOCAL);
169 | defaultParams.setVRProvider(Defaults.VR.NATIVE);
170 | defaultParams.setVRLanguageNative(locale);
171 | defaultParams.setLanguageModel(Defaults.LanguageModel.LOCAL);
172 | defaultParams.setAction(Defaults.ACTION.SPEAK_LISTEN);
173 | defaultParams.setUtterance(ctx.getApplicationContext().getString(R.string.default_intro));
174 |
175 | // Google Cloud
176 | defaultParams.setGOOGLE_CLOUD_ACCESS_TOKEN(GOOGLE_CLOUD_ACCESS_TOKEN);
177 | defaultParams.setGOOGLE_CLOUD_ACCESS_EXPIRY(GOOGLE_CLOUD_ACCESS_EXPIRY);
178 |
179 | // Google Chromium
180 | defaultParams.setGOOGLE_CHROMIUM_API_KEY(GOOGLE_CHROMIUM_API_KEY);
181 |
182 | // Google (both)
183 | defaultParams.setVRLanguageGoogle(locale);
184 |
185 | // Nuance
186 | defaultParams.setNUANCE_APP_KEY(NUANCE_APP_KEY);
187 | defaultParams.setNUANCE_CONTEXT_TAG(NUANCE_CONTEXT_TAG);
188 | defaultParams.setNUANCE_SERVER_URI(NUANCE_SERVER_URI);
189 | defaultParams.setNUANCE_SERVER_URI_NLU(NUANCE_SERVER_URI_NLU);
190 | defaultParams.setVRLanguageNuance(VRLanguageNuance.ENGLISH_US);
191 | defaultParams.setTTSLanguageNuance(TTSLanguageNuance.FRENCH_AUDREY_ML);
192 | defaultParams.setNLULanguageNuance(NLULanguageNuance.English_US);
193 |
194 | // Microsoft
195 | defaultParams.setVRLanguageMicrosoft(locale);
196 | defaultParams.setNLULanguageMicrosoft(locale);
197 | defaultParams.setOXFORD_KEY_1(OXFORD_KEY_1);
198 | defaultParams.setOXFORD_KEY_2(OXFORD_KEY_2);
199 | defaultParams.setLUIS_APP_ID(LUIS_APP_ID);
200 | defaultParams.setLUIS_SUBSCRIPTION_ID(LUIS_SUBSCRIPTION_ID);
201 |
202 | // API AI
203 | defaultParams.setNLULanguageAPIAI(locale);
204 | defaultParams.setAPI_AI_ACCESS_TOKEN(API_AI_CLIENT_ACCESS_TOKEN);
205 |
206 | // Wit
207 | defaultParams.setVRLanguageWit(locale);
208 | defaultParams.setNLULanguageWit(locale);
209 | defaultParams.setWIT_SERVER_ACCESS_TOKEN(WIT_SERVER_ACCESS_TOKEN);
210 |
211 | // IBM
212 | defaultParams.setVRLanguageIBM(locale);
213 | defaultParams.setIBM_SERVICE_USER_NAME(IBM_SERVICE_USER_NAME);
214 | defaultParams.setIBM_SERVICE_PASSWORD(IBM_SERVICE_PASSWORD);
215 |
216 | // Remote
217 | defaultParams.setREMOTE_ACCESS_TOKEN(REMOTE_ACCESS_TOKEN);
218 | defaultParams.setREMOTE_SERVER_URI(REMOTE_SERVER_URI);
219 | defaultParams.setVRLanguageRemote(locale);
220 |
221 | return defaultParams;
222 | }
223 | }
224 |
225 |
--------------------------------------------------------------------------------
/app/src/main/java/ai/saiy/android/apiexample/ui/fragment/FragmentDemoCommand.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2016 Saiy™ Ltd
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package ai.saiy.android.apiexample.ui.fragment;
18 |
19 | import android.app.Activity;
20 | import android.os.Bundle;
21 | import android.os.Handler;
22 | import android.os.Looper;
23 | import android.support.annotation.NonNull;
24 | import android.support.annotation.Nullable;
25 | import android.support.v4.app.Fragment;
26 | import android.text.method.ScrollingMovementMethod;
27 | import android.util.Log;
28 | import android.view.LayoutInflater;
29 | import android.view.View;
30 | import android.view.ViewGroup;
31 | import android.widget.Button;
32 | import android.widget.TextView;
33 |
34 | import java.util.ArrayList;
35 | import java.util.Locale;
36 | import java.util.Set;
37 |
38 | import ai.saiy.android.api.remote.Request;
39 | import ai.saiy.android.api.request.Regex;
40 | import ai.saiy.android.api.request.SaiyKeyphrase;
41 | import ai.saiy.android.api.request.SaiyKeyphraseListener;
42 | import ai.saiy.android.apiexample.R;
43 | import ai.saiy.android.apiexample.ui.activity.MainActivity;
44 |
45 | import static ai.saiy.android.apiexample.service.MyIntentService.DO_NOT_USE_ZERO;
46 | import static ai.saiy.android.apiexample.service.MyIntentService.DO_SOMETHING_1;
47 | import static ai.saiy.android.apiexample.service.MyIntentService.DO_SOMETHING_2;
48 | import static ai.saiy.android.apiexample.service.MyIntentService.DO_SOMETHING_3;
49 |
50 | /**
51 | * Demonstration of registering a keyphrase that will trigger your application. This
52 | * example includes a simple keyword registration, as well as circumstances where you will use
53 | * the additional speech provided to react to the voice command.
54 | *
55 | * Specifically, 'Spotify playlist' and 'Spotify album' are demonstrated and the voice data
56 | * extracted to show which playlist/album would be started.
57 | *
58 | * Created by benrandall76@gmail.com on 03/10/2016.
59 | */
60 |
61 | public class FragmentDemoCommand extends Fragment implements SaiyKeyphraseListener, View.OnClickListener {
62 |
63 | /**
64 | * TAG
65 | */
66 | private final String CLS_NAME = FragmentDemoCommand.class.getSimpleName();
67 |
68 | /**
69 | * String phrases that will be registered in this example
70 | */
71 | private static final String SAUSAGES = "sausages";
72 | private static final String SPOTIFY_PLAYLIST = "spotify playlist";
73 | private static final String SPOTIFY_ALBUM = "spotify album";
74 |
75 | /**
76 | * Constant ids for each keyphrase
77 | */
78 | private static final int KEYPHRASE_ID_1 = 123;
79 | private static final int KEYPHRASE_ID_2 = 456;
80 | private static final int KEYPHRASE_ID_3 = 789;
81 |
82 | /**
83 | * UI component
84 | */
85 | private TextView tvResults;
86 |
87 | /**
88 | * Standard empty fragment constructor
89 | */
90 | public FragmentDemoCommand() {
91 | }
92 |
93 | /**
94 | * Suggested static instantiation method
95 | *
96 | * @return a new instance of this fragment
97 | */
98 | public static FragmentDemoCommand newInstance() {
99 | return new FragmentDemoCommand();
100 | }
101 |
102 | @Override
103 | public void onCreate(final Bundle savedInstanceState) {
104 | super.onCreate(savedInstanceState);
105 | Log.i(CLS_NAME, "onCreate");
106 | }
107 |
108 | @Override
109 | public View onCreateView(@NonNull final LayoutInflater inflater, final ViewGroup container,
110 | final Bundle savedInstanceState) {
111 | Log.i(CLS_NAME, "onCreateView");
112 |
113 | final View rootView = inflater.inflate(R.layout.fragment_demo_command, container, false);
114 |
115 | final Button buttonC1 = rootView.findViewById(R.id.buttonC1);
116 | buttonC1.setOnClickListener(this);
117 | final Button buttonC2 = rootView.findViewById(R.id.buttonC2);
118 | buttonC2.setOnClickListener(this);
119 | final Button buttonC3 = rootView.findViewById(R.id.buttonC3);
120 | buttonC3.setOnClickListener(this);
121 |
122 | tvResults = rootView.findViewById(R.id.tvResults);
123 | tvResults.setMovementMethod(ScrollingMovementMethod.getInstance());
124 |
125 | return rootView;
126 | }
127 |
128 | /**
129 | * Called when a view has been clicked.
130 | *
131 | * @param v The view that was clicked.
132 | */
133 | @Override
134 | public void onClick(final View v) {
135 | registerKeyphrase(v.getId());
136 | }
137 |
138 | /**
139 | * Handle the button click and register the corresponding keyphrase
140 | *
141 | * @param id of the view that was clicked
142 | */
143 | @SuppressWarnings("ConstantConditions")
144 | public void registerKeyphrase(final int id) {
145 | Log.i(CLS_NAME, "registerKeyphrase");
146 |
147 | if (MainActivity.saiyAvailable) {
148 |
149 | final SaiyKeyphrase keyphraseRequest = new SaiyKeyphrase(getActivity().getApplicationContext(),
150 | this);
151 |
152 | switch (id) {
153 | case R.id.buttonC1:
154 | keyphraseRequest.setDefinedAction(DO_SOMETHING_1);
155 | keyphraseRequest.setSaiyKeyphrase(SAUSAGES);
156 | keyphraseRequest.setRegex(Regex.MATCHES);
157 | break;
158 | case R.id.buttonC2:
159 | keyphraseRequest.setDefinedAction(DO_SOMETHING_2);
160 | keyphraseRequest.setSaiyKeyphrase(SPOTIFY_PLAYLIST);
161 | keyphraseRequest.setRegex(Regex.STARTS_WITH);
162 | break;
163 | case R.id.buttonC3:
164 | keyphraseRequest.setDefinedAction(DO_SOMETHING_3);
165 | keyphraseRequest.setSaiyKeyphrase(SPOTIFY_ALBUM);
166 | keyphraseRequest.setRegex(Regex.STARTS_WITH);
167 | break;
168 | }
169 |
170 | /*
171 | * When registering a keyphrase, you can include a bundle containing
172 | * any type of parameter. When the keyphrase is detected, a bundle will
173 | * be returned containing these original parameters, which can be used
174 | * to handle the action you intend to make.
175 | */
176 | final Bundle bundle = new Bundle();
177 |
178 | bundle.putString("some bundle String", "random String value");
179 | bundle.putBoolean("some bundle boolean", true);
180 | bundle.putInt("some bundle int", Integer.MAX_VALUE);
181 | keyphraseRequest.setExtraBundle(bundle);
182 |
183 | /*
184 | * In production, you would identify the keyphrase detected by the
185 | * constant set here.
186 | */
187 | final int myUniqueId;
188 |
189 | switch (id) {
190 | case R.id.buttonC1:
191 | myUniqueId = KEYPHRASE_ID_1;
192 | break;
193 | case R.id.buttonC2:
194 | myUniqueId = KEYPHRASE_ID_2;
195 | break;
196 | case R.id.buttonC3:
197 | myUniqueId = KEYPHRASE_ID_3;
198 | break;
199 | default:
200 | myUniqueId = 666;
201 | break;
202 | }
203 |
204 | final boolean interimSuccess = keyphraseRequest.sendRequest(myUniqueId);
205 |
206 | if (interimSuccess) {
207 | Log.i(CLS_NAME, "The keyphrase request initially returned: true from the library ~ However, " +
208 | "if the request fails to work, please view the logcat for " +
209 | "information, as on receipt of the request, Saiy will perform more stringent tests which " +
210 | "are subject to change. The final outcome will be received in onEnrollKeyphrase");
211 | } else {
212 | Log.e(CLS_NAME, "The keyphrase request was declined. Check the logcat for more information");
213 | }
214 |
215 | } else {
216 | Log.w(CLS_NAME, "Saiy is unavailable. Please check the log for more information");
217 | }
218 | }
219 |
220 | @Override
221 | public void onEnrollKeyphrase(final int result, final int requestId) {
222 | appendText(null);
223 |
224 | switch (result) {
225 | case Activity.RESULT_OK:
226 | Log.i(CLS_NAME, "onEnrollKeyphrase: RESULT_OK: " + requestId);
227 | appendText("onEnrollKeyphrase: RESULT_OK: " + requestId);
228 | break;
229 | case Activity.RESULT_CANCELED:
230 | Log.e(CLS_NAME, "onEnrollKeyphrase: RESULT_CANCELED: " + requestId);
231 | appendText("onEnrollKeyphrase: RESULT_CANCELED: " + requestId);
232 | break;
233 | default:
234 | Log.w(CLS_NAME, "onEnrollKeyphrase: default? Should not happen");
235 | appendText("onEnrollKeyphrase: default? Should not happen");
236 | break;
237 | }
238 | }
239 |
240 | /**
241 | * This example method is exposed to simulate a callback from your Intent Service, once a keyphrase
242 | * has been detected.
243 | *
244 | * @param bundle containing associated keyphrase extras
245 | */
246 | public void onExampleCallback(final Bundle bundle) {
247 |
248 | if (getActivity() != null && tvResults != null && bundle != null && !bundle.isEmpty()) {
249 |
250 | appendText(null);
251 |
252 | final ArrayList voiceData = bundle.getStringArrayList(Request.RESULTS_RECOGNITION);
253 | final float[] confidenceScore = bundle.getFloatArray(Request.CONFIDENCE_SCORES);
254 |
255 | if (confidenceScore != null && voiceData != null && confidenceScore.length == voiceData.size()) {
256 | for (int i = 0; i < voiceData.size(); i++) {
257 | Log.i(CLS_NAME, "onSpeechResults: " + voiceData.get(i) + " ~ " + confidenceScore[i]);
258 | appendText(voiceData.get(i) + " ~ " + confidenceScore[i]);
259 | }
260 | } else if (voiceData != null) {
261 | for (int i = 0; i < voiceData.size(); i++) {
262 | Log.i(CLS_NAME, "onSpeechResults: " + voiceData.get(i));
263 | appendText(voiceData.get(i));
264 | }
265 | } else {
266 | Log.w(CLS_NAME, "onSpeechResults: values error");
267 | appendText("onSpeechResults: values error");
268 | }
269 |
270 | appendText("\n");
271 |
272 | bundle.remove(Request.RESULTS_RECOGNITION);
273 | bundle.remove(Request.CONFIDENCE_SCORES);
274 |
275 | final Set keys = bundle.keySet();
276 | for (final String key : keys) {
277 | appendText(key + ": " + bundle.get(key));
278 | }
279 |
280 | if (voiceData != null && !voiceData.isEmpty()) {
281 |
282 | switch (bundle.getInt(SaiyKeyphrase.SAIY_ACTION, 0)) {
283 |
284 | case DO_SOMETHING_1:
285 | Log.i(CLS_NAME, "onHandleIntent: DO_SOMETHING_1");
286 | appendText("Heard: " + SAUSAGES + "!");
287 | break;
288 | case DO_SOMETHING_2:
289 | Log.i(CLS_NAME, "onHandleIntent: DO_SOMETHING_2");
290 | appendText("\nStart the playlist: " + voiceData.get(0).toLowerCase(Locale.US)
291 | .replaceFirst(SPOTIFY_PLAYLIST, "") + "!");
292 | break;
293 | case DO_SOMETHING_3:
294 | Log.i(CLS_NAME, "onHandleIntent: DO_SOMETHING_3");
295 | appendText("\nStart the album: " + voiceData.get(0).toLowerCase(Locale.US)
296 | .replaceFirst(SPOTIFY_ALBUM, "") + "!");
297 | break;
298 | case DO_NOT_USE_ZERO:
299 | Log.e(CLS_NAME, "onHandleIntent: DO_NOT_USE_ZERO");
300 | break;
301 | }
302 | } else {
303 | Log.e(CLS_NAME, "onHandleIntent: voice data empty - should not happen");
304 | }
305 | }
306 | }
307 |
308 | /**
309 | * Append results on the main thread.
310 | */
311 | private void appendText(@Nullable final String words) {
312 |
313 | if (getActivity() != null) {
314 | new Handler(Looper.getMainLooper()).post(new Runnable() {
315 | @Override
316 | public void run() {
317 | if (words != null) {
318 | tvResults.append("\n" + words);
319 | } else {
320 | tvResults.setText("");
321 | }
322 | }
323 | });
324 | }
325 | }
326 |
327 | @Override
328 | public void onPause() {
329 | super.onPause();
330 | Log.i(CLS_NAME, "onPause");
331 | }
332 |
333 | @Override
334 | public void onResume() {
335 | super.onResume();
336 | Log.i(CLS_NAME, "onResume");
337 | }
338 |
339 | @Override
340 | public void onDestroy() {
341 | super.onDestroy();
342 | Log.i(CLS_NAME, "onDestroy");
343 | }
344 | }
345 |
--------------------------------------------------------------------------------
/app/src/main/java/ai/saiy/android/apiexample/utils/UtilsColour.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2016 Saiy™ Ltd
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package ai.saiy.android.apiexample.utils;
18 |
19 | import android.graphics.Color;
20 | import android.support.annotation.NonNull;
21 |
22 | import java.util.ArrayList;
23 | import java.util.Locale;
24 |
25 | /**
26 | * Created by benrandall76@gmail.com on 03/10/2016.
27 | *
28 | * Example code extracted from the link below. License unknown, assumed Apache. If you are the copyright
29 | * holder of this work, or your attribution is missing, please contact me, so I can correct the file
30 | * as necessary.
31 | *
32 | * Java Code to get a color name from rgb/hex value/awt color
33 | *
50 | * If the language by which you interact with will become complex or diverse, you should consider
51 | * using a machine learning NLU provider, rather than just basic string examination.
52 | *
53 | * Created by benrandall76@gmail.com on 03/10/2016.
54 | */
55 |
56 | public class FragmentDemoInteraction extends Fragment implements View.OnClickListener {
57 |
58 | /**
59 | * TAG
60 | */
61 | private final String CLS_NAME = FragmentDemoInteraction.class.getSimpleName();
62 |
63 | /**
64 | * UI components
65 | */
66 | private TextView tvResults;
67 | private Button button;
68 |
69 | /**
70 | * Will increment. Set your own in production that will correspond to an action
71 | * when a request has finished processing.
72 | */
73 | private int testRequestID = 777;
74 |
75 | /**
76 | * Locale US used for the sake of example, as it's supported by all
77 | * TTS, VR and NLU options.
78 | */
79 | private final Locale locale = Locale.US;
80 |
81 | /**
82 | * Standard empty fragment constructor
83 | */
84 | public FragmentDemoInteraction() {
85 | }
86 |
87 | /**
88 | * Suggested static instantiation method
89 | *
90 | * @return a new instance of this fragment
91 | */
92 | public static FragmentDemoInteraction newInstance() {
93 | return new FragmentDemoInteraction();
94 | }
95 |
96 | @Override
97 | public void onCreate(final Bundle savedInstanceState) {
98 | super.onCreate(savedInstanceState);
99 | Log.i(CLS_NAME, "onCreate");
100 | }
101 |
102 | @Override
103 | public View onCreateView(@NonNull final LayoutInflater inflater, final ViewGroup container, final Bundle savedInstanceState) {
104 | Log.i(CLS_NAME, "onCreateView");
105 |
106 | final View rootView = inflater.inflate(R.layout.fragment_demo_interaction, container, false);
107 |
108 | button = rootView.findViewById(R.id.button);
109 | button.setOnClickListener(this);
110 |
111 | tvResults = rootView.findViewById(R.id.tvResults);
112 | tvResults.setMovementMethod(ScrollingMovementMethod.getInstance());
113 |
114 | return rootView;
115 | }
116 |
117 | /**
118 | * Called when a view has been clicked.
119 | *
120 | * @param v The view that was clicked.
121 | */
122 | @Override
123 | public void onClick(final View v) {
124 | runAPI();
125 | }
126 |
127 | /**
128 | * Run the API.
129 | */
130 | @SuppressWarnings("ConstantConditions")
131 | private void runAPI() {
132 | Log.i(CLS_NAME, "runAPI");
133 |
134 | appendText(null);
135 |
136 | if (MainActivity.saiyAvailable) {
137 |
138 | final SaiyRequest saiyRequest = ((MainActivity) getActivity()).getSaiyRequest();
139 | final SaiyRequestParams params = ((MainActivity) getActivity()).getParams();
140 |
141 | params.setUtterance("Please say your favourite colour");
142 | params.setRequestId(String.valueOf(testRequestID));
143 | params.setAction(Defaults.ACTION.SPEAK_LISTEN);
144 | params.setTTSProvider(Defaults.TTS.LOCAL);
145 | params.setTTSLanguageLocal(locale);
146 | params.setVRProvider(Defaults.VR.NATIVE);
147 | params.setVRLanguageNative(locale);
148 | params.setLanguageModel(Defaults.LanguageModel.LOCAL);
149 | saiyRequest.setParams(params);
150 | saiyRequest.execute();
151 | testRequestID++;
152 |
153 | } else {
154 | Log.e(CLS_NAME, "Saiy is reporting unavailable. " +
155 | "If you don't know why, please check the logcat in more detail");
156 | appendText("BAD REQUEST");
157 | }
158 | }
159 |
160 | /**
161 | * The {@link ai.saiy.android.api.remote.SaiyListener} is implemented in the Main Activity
162 | * class and passed here to the method of its namesake. You could implement the listener
163 | * directly here should you wish, depending on your design pattern. This callback will not
164 | * be on the main thread.
165 | *
166 | * @param requestId the unique request id sent with each API request
167 | */
168 | public void onUtteranceCompleted(final String requestId) {
169 | Log.d(CLS_NAME, "onUtteranceCompleted: " + requestId);
170 | appendText("onUtteranceCompleted: id: " + requestId + "\n");
171 | }
172 |
173 | /**
174 | * As above
175 | *
176 | * @param results the {@link Bundle} containing result information
177 | * @param requestId the unique request id sent with each API request
178 | */
179 | public void onSpeechResults(final Bundle results, final String requestId) {
180 | Log.d(CLS_NAME, "onSpeechResults: id: " + requestId);
181 | appendText("onSpeechResults: id: " + requestId + "\n");
182 |
183 | final ArrayList voiceData = results.getStringArrayList(Request.RESULTS_RECOGNITION);
184 | final float[] confidenceScore = results.getFloatArray(Request.CONFIDENCE_SCORES);
185 |
186 | if (confidenceScore != null && voiceData != null && confidenceScore.length == voiceData.size()) {
187 | for (int i = 0; i < voiceData.size(); i++) {
188 | Log.i(CLS_NAME, "onSpeechResults: " + voiceData.get(i) + " ~ " + confidenceScore[i]);
189 | appendText(voiceData.get(i) + " ~ " + confidenceScore[i]);
190 | }
191 | } else if (voiceData != null) {
192 | for (int i = 0; i < voiceData.size(); i++) {
193 | Log.i(CLS_NAME, "onSpeechResults: " + voiceData.get(i));
194 | appendText(voiceData.get(i));
195 | }
196 | } else {
197 | Log.w(CLS_NAME, "onSpeechResults: values error");
198 | appendText("onSpeechResults: values error");
199 | }
200 |
201 | if (voiceData != null && !voiceData.isEmpty()) {
202 | setColour(UtilsColour.getColourFromName(voiceData));
203 | }
204 | }
205 |
206 | /**
207 | * As above
208 | *
209 | * @param error one of {@link Defaults.ERROR}
210 | * @param requestId the unique request id sent with each API request
211 | */
212 | public void onError(final Defaults.ERROR error, final String requestId) {
213 | Log.d(CLS_NAME, "onError: id: " + requestId);
214 |
215 | switch (error) {
216 |
217 | case ERROR_NO_MATCH:
218 | Log.w(CLS_NAME, "onError: ERROR_NO_MATCH");
219 | appendText("onError: ERROR_NO_MATCH");
220 |
221 | /*
222 | The speech recogniser returned empty results. The most common reason for this,
223 | would be the user failing to speak or using naughty words with the profanity
224 | filter enabled....
225 |
226 | Saiy will announce this to the user and direct them as to how to correct the issue.
227 | */
228 |
229 | break;
230 | case ERROR_BUSY:
231 | Log.w(CLS_NAME, "onError: ERROR_BUSY");
232 | appendText("onError: ERROR_BUSY");
233 |
234 | /*
235 | Your request was returned due to Saiy either listening or speaking. In this
236 | situation, an instruction to cancel the listening or speech was made, but it is not
237 | guaranteed to have been successful.
238 |
239 | The user will be aware of this scenario.
240 | */
241 |
242 | break;
243 | case ERROR_INTERRUPTED:
244 | Log.w(CLS_NAME, "onError: ERROR_INTERRUPTED");
245 | appendText("onError: ERROR_INTERRUPTED");
246 |
247 |
248 | /*
249 | Your request was cancelled mid process, due most probably, to an incoming call. The
250 | user will be aware of this scenario.
251 | */
252 |
253 | break;
254 | case ERROR_NETWORK:
255 | Log.w(CLS_NAME, "onError: ERROR_NETWORK");
256 | appendText("onError: ERROR_NETWORK");
257 |
258 | /*
259 | Your request could not be processed due to network conditions. Saiy will have informed
260 | the user of this issue.
261 | */
262 |
263 | break;
264 | case ERROR_SAIY:
265 | Log.w(CLS_NAME, "onError: ERROR_SAIY");
266 | appendText("onError: ERROR_SAIY");
267 |
268 | /*
269 | An error has occurred which Saiy has handled and directed the user to the solution.
270 | This will mean your request has failed, but hopefully the user is taking action via
271 | Saiy to resolve the problem and it may be resolved for the next request.
272 |
273 | Examples of such errors are missing voice/language installations or a hardware error.
274 | */
275 |
276 | break;
277 | case ERROR_DEVELOPER:
278 | Log.w(CLS_NAME, "onError: ERROR_DEVELOPER");
279 | appendText("onError: ERROR_DEVELOPER");
280 |
281 | /*
282 | This is returned if parameters included in the default configuration
283 | of the TTS or VR (etc) provider haven't worked or are invalid. Double check the API keys
284 | you provided are functioning and other parameters are correct. Check the logcat output
285 | for Saiy, to see if a more specific error has been reported.
286 |
287 | Make sure you declare
288 | in your Manifest.
289 |
290 | This error should not happen in production, as such things should become
291 | apparent in testing, but it is here just in case.
292 | */
293 |
294 | MainActivity.saiyAvailable = false;
295 |
296 | break;
297 | case ERROR_DENIED:
298 | Log.w(CLS_NAME, "onError: REQUEST_DENIED");
299 | appendText("onError: REQUEST_DENIED");
300 |
301 | /*
302 | Whilst the parameters passed for the remote request to Saiy were validated
303 | correctly (as far as not null or missing), the further request to the TTS or
304 | VR (etc) provider was returned as declined. Check the logcat output
305 | for Saiy, to see if a more specific error has been reported.
306 |
307 | One valid scenario here, would be your API key being over its usage quota.
308 |
309 | A further reason could be your application has been 'blacklisted' by Saiy. This can
310 | occur if too many misconfigured requests have been sent within a short period of time.
311 | Saiy will decline all further requests, to make sure the performance of the app
312 | remains unaffected.
313 |
314 | Any blacklisted apps can be 'released' by the user from within the Saiy Application
315 | Settings. The blacklist is cleared each time the Saiy Service restarts, or a application
316 | is updated - giving the previously misbehaving app a chance to right its wrongs.
317 | */
318 |
319 | MainActivity.saiyAvailable = false;
320 |
321 | break;
322 | case ERROR_UNKNOWN:
323 | default:
324 | Log.e(CLS_NAME, "onError: ERROR_UNKNOWN");
325 | appendText("onError: ERROR_UNKNOWN");
326 |
327 | /*
328 | Saiy will default to this error if something inexplicable has happened. There is no
329 | guarantee that Saiy will have announced an issue to the user, but it should have.
330 | */
331 |
332 | MainActivity.saiyAvailable = false;
333 | break;
334 | }
335 | }
336 |
337 | /**
338 | * Update the colour of the button on the main thread based on the voice results.
339 | *
340 | * @param colour the integer representation of the chosen colour.
341 | */
342 | private void setColour(final int colour) {
343 |
344 | if (getActivity() != null) {
345 | new Handler(Looper.getMainLooper()).post(new Runnable() {
346 | @Override
347 | public void run() {
348 | button.setBackgroundColor(colour);
349 | }
350 | });
351 | }
352 | }
353 |
354 | /**
355 | * Append results on the main thread.
356 | */
357 | private void appendText(@Nullable final String words) {
358 |
359 | if (getActivity() != null) {
360 | new Handler(Looper.getMainLooper()).post(new Runnable() {
361 | @Override
362 | public void run() {
363 | if (words != null) {
364 | tvResults.append("\n" + words);
365 | } else {
366 | tvResults.setText("");
367 | }
368 | }
369 | });
370 | }
371 | }
372 |
373 | @Override
374 | public void onPause() {
375 | super.onPause();
376 | Log.i(CLS_NAME, "onPause");
377 | }
378 |
379 | @Override
380 | public void onResume() {
381 | super.onResume();
382 | Log.i(CLS_NAME, "onResume");
383 | }
384 |
385 | @Override
386 | public void onDestroy() {
387 | super.onDestroy();
388 | Log.i(CLS_NAME, "onDestroy");
389 | }
390 | }
391 |
--------------------------------------------------------------------------------
/app/src/main/java/ai/saiy/android/apiexample/ui/activity/MainActivity.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2016 Saiy™ Ltd
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package ai.saiy.android.apiexample.ui.activity;
18 |
19 | import android.content.ActivityNotFoundException;
20 | import android.content.DialogInterface;
21 | import android.content.Intent;
22 | import android.content.pm.PackageManager;
23 | import android.net.Uri;
24 | import android.os.Bundle;
25 | import android.support.annotation.NonNull;
26 | import android.support.design.widget.NavigationView;
27 | import android.support.design.widget.Snackbar;
28 | import android.support.v4.app.ActivityCompat;
29 | import android.support.v4.app.Fragment;
30 | import android.support.v4.view.GravityCompat;
31 | import android.support.v4.widget.DrawerLayout;
32 | import android.support.v7.app.ActionBarDrawerToggle;
33 | import android.support.v7.app.AlertDialog;
34 | import android.support.v7.app.AppCompatActivity;
35 | import android.support.v7.widget.Toolbar;
36 | import android.util.Log;
37 | import android.util.Pair;
38 | import android.view.MenuItem;
39 | import android.view.View;
40 |
41 | import ai.saiy.android.api.Defaults;
42 | import ai.saiy.android.api.remote.SaiyListener;
43 | import ai.saiy.android.api.request.SaiyKeyphrase;
44 | import ai.saiy.android.api.request.SaiyRequest;
45 | import ai.saiy.android.api.request.SaiyRequestParams;
46 | import ai.saiy.android.apiexample.R;
47 | import ai.saiy.android.apiexample.configuration.SaiyConfiguration;
48 | import ai.saiy.android.apiexample.ui.fragment.FragmentDemoBasic;
49 | import ai.saiy.android.apiexample.ui.fragment.FragmentDemoCommand;
50 | import ai.saiy.android.apiexample.ui.fragment.FragmentDemoInteraction;
51 |
52 | import static ai.saiy.android.apiexample.configuration.SaiyConfiguration.SAIY_PLAYSTORE_URL;
53 |
54 | public class MainActivity extends AppCompatActivity implements NavigationView.OnNavigationItemSelectedListener,
55 | SaiyListener {
56 |
57 | /**
58 | * TAG
59 | */
60 | private final String CLS_NAME = MainActivity.class.getSimpleName();
61 |
62 | /**
63 | * Arbitrary request id.
64 | */
65 | private static final int PERMISSIONS_SAIY_REQUEST = 23;
66 |
67 | /**
68 | * Required permissions that must be declared in your manifest
69 | */
70 | private static final String[] PERMISSIONS_SAIY = {android.Manifest.permission.RECORD_AUDIO,
71 | SaiyRequest.CONTROL_SAIY};
72 |
73 | /**
74 | * Fragment Index Constants
75 | */
76 | public static final int INDEX_FRAGMENT_DEMO_BASIC = 0;
77 | public static final int INDEX_FRAGMENT_DEMO_COMMAND = 1;
78 | public static final int INDEX_FRAGMENT_DEMO_INTERACTION = 2;
79 |
80 | private DrawerLayout drawer;
81 | private Toolbar toolbar;
82 | private NavigationView navigationView;
83 |
84 | /**
85 | * If you want to prompt the user to install Saiy, it's best only to do it once
86 | */
87 | private boolean showInstallSaiyDialog = true;
88 |
89 | /**
90 | * Both parameters are needed in order to interact with Saiy. We initialise them
91 | * only once in the parent activity. Child fragments can use getters {@link #getSaiyRequest()}
92 | * and {@link #getParams()}
93 | */
94 | public SaiyRequest saiyRequest;
95 | public SaiyRequestParams params;
96 |
97 | /**
98 | * Updated from different threads, an identifier as to whether you are able to
99 | * connect to the Saiy API service.
100 | */
101 | public static volatile boolean saiyAvailable = false;
102 |
103 | @Override
104 | protected void onCreate(Bundle savedInstanceState) {
105 | super.onCreate(savedInstanceState);
106 | setContentView(R.layout.activity_main);
107 |
108 | // Do not set to true in production!!
109 | Defaults.setLogging(true);
110 |
111 | // Set up the UI
112 | setupUI();
113 |
114 | // Start the initial Fragment
115 | doFragmentReplaceTransaction(FragmentDemoBasic.newInstance(), INDEX_FRAGMENT_DEMO_BASIC);
116 | }
117 |
118 | @Override
119 | protected void onNewIntent(final Intent intent) {
120 | Log.i(CLS_NAME, "onNewIntent");
121 |
122 | if (intent == null || !intent.hasExtra(SaiyKeyphrase.SAIY_ACTION)) {
123 | return;
124 | }
125 |
126 | final FragmentDemoCommand fragment = (FragmentDemoCommand) getSupportFragmentManager()
127 | .findFragmentByTag(String.valueOf(INDEX_FRAGMENT_DEMO_COMMAND));
128 |
129 | if (fragment != null) {
130 | fragment.onExampleCallback(intent.getExtras());
131 | } else {
132 | Log.w(CLS_NAME, "onNewIntent: received example keyphrase intent, but Fragment is no longer " +
133 | "visible");
134 | }
135 | }
136 |
137 | /**
138 | * Self explanatory utility
139 | */
140 | private void setupUI() {
141 | Log.i(CLS_NAME, "setupUI");
142 |
143 | setupToolbar();
144 | setupDrawer();
145 | setupNavigation();
146 | }
147 |
148 | /**
149 | * Self explanatory utility
150 | */
151 | private void setupToolbar() {
152 | Log.i(CLS_NAME, "setupToolbar");
153 |
154 | toolbar = findViewById(R.id.toolbar);
155 | setSupportActionBar(toolbar);
156 | }
157 |
158 | /**
159 | * Self explanatory utility
160 | */
161 | private void setupDrawer() {
162 | Log.i(CLS_NAME, "setupDrawer");
163 |
164 | drawer = findViewById(R.id.drawer_layout);
165 | ActionBarDrawerToggle toggle = new ActionBarDrawerToggle(
166 | this, drawer, toolbar, R.string.navigation_drawer_open, R.string.navigation_drawer_close);
167 | drawer.addDrawerListener(toggle);
168 | toggle.syncState();
169 | }
170 |
171 | /**
172 | * Self explanatory utility
173 | */
174 | private void setupNavigation() {
175 | Log.i(CLS_NAME, "setupNavigation");
176 |
177 | navigationView = findViewById(R.id.nav_view);
178 | navigationView.setNavigationItemSelectedListener(this);
179 | navigationView.setCheckedItem(R.id.nav_basic);
180 | navigationView.getMenu().getItem(INDEX_FRAGMENT_DEMO_BASIC).setChecked(true);
181 | }
182 |
183 |
184 | /**
185 | * Helper method to replace the current fragment
186 | *
187 | * @param fragment to transact
188 | * @param tag of the fragment
189 | */
190 | public void doFragmentReplaceTransaction(@NonNull final Fragment fragment, final int tag) {
191 | getSupportFragmentManager().beginTransaction()
192 | .replace(R.id.fragmentContent, fragment, String.valueOf(tag)).commit();
193 | }
194 |
195 | /**
196 | * Check if we are able to use the Saiy API
197 | */
198 | private void checkSaiyAvailability() {
199 | Log.i(CLS_NAME, "checkSaiyAvailability");
200 |
201 | final Pair availabilityPair =
202 | SaiyRequest.isSaiyAvailable(getApplicationContext());
203 |
204 | saiyAvailable = availabilityPair.first;
205 |
206 | Log.i(CLS_NAME, "Saiy available " + saiyAvailable);
207 |
208 | if (!saiyAvailable) {
209 |
210 | switch (availabilityPair.second) {
211 |
212 | case ALL_GOOD:
213 | break;
214 | case NOT_INSTALLED:
215 | // Saiy not installed - show dialog once if you want!
216 | if (showInstallSaiyDialog) {
217 | showInstallSaiyDialog = false;
218 | showInstallDialog();
219 | }
220 | break;
221 | case MISSING_PERMISSION:
222 | checkPermissionsAndPrompt();
223 | break;
224 | case NO_VR_PROVIDER:
225 | case NO_TTS_ENGINE:
226 | /*
227 | * Saiy will have already made the user aware of this, and for whatever reason it
228 | * remains unresolved. Therefore the API is unusable.
229 | */
230 | break;
231 | }
232 | } else {
233 | initialiseSaiy();
234 | }
235 | }
236 |
237 | /**
238 | * Initialise the Saiy request as soon as the UI finishes drawing, so any background checks,
239 | * for text to speech and recognition languages can be prepared.
240 | */
241 | private void initialiseSaiy() {
242 | Log.i(CLS_NAME, "initialiseSaiy");
243 |
244 | if (saiyRequest == null) {
245 | params = SaiyConfiguration.getDefaultParams(getApplicationContext());
246 | saiyRequest = new SaiyRequest(getApplicationContext(), MainActivity.this,
247 | params, true);
248 | }
249 | }
250 |
251 | /**
252 | * Exposed getter for Fragments
253 | *
254 | * @return the {@link SaiyRequestParams}
255 | */
256 | public SaiyRequestParams getParams() {
257 | return params;
258 | }
259 |
260 | /**
261 | * Exposed getter for Fragments
262 | *
263 | * @return the {@link SaiyRequest}
264 | */
265 | public SaiyRequest getSaiyRequest() {
266 | return saiyRequest;
267 | }
268 |
269 | /**
270 | * Send the callback information from the {@link SaiyListener} to the relevant
271 | * fragment
272 | *
273 | * @param requestId the unique request id sent with each API request
274 | */
275 | @Override
276 | public void onUtteranceCompleted(final String requestId) {
277 |
278 | final int currentTag = Integer.parseInt(getSupportFragmentManager().findFragmentById(
279 | R.id.fragmentContent).getTag());
280 |
281 | Fragment fragment;
282 |
283 | switch (currentTag) {
284 |
285 | case INDEX_FRAGMENT_DEMO_BASIC:
286 | fragment = getSupportFragmentManager()
287 | .findFragmentByTag(String.valueOf(INDEX_FRAGMENT_DEMO_BASIC));
288 |
289 | if (fragment != null) {
290 | ((FragmentDemoBasic) fragment).onUtteranceCompleted(requestId);
291 | }
292 | break;
293 | case INDEX_FRAGMENT_DEMO_INTERACTION:
294 | fragment = getSupportFragmentManager()
295 | .findFragmentByTag(String.valueOf(INDEX_FRAGMENT_DEMO_INTERACTION));
296 | if (fragment != null) {
297 | ((FragmentDemoInteraction) fragment).onUtteranceCompleted(requestId);
298 | }
299 | break;
300 | }
301 | }
302 |
303 | /**
304 | * Send the callback information from the {@link SaiyListener} to the relevant
305 | * fragment
306 | *
307 | * @param results the {@link Bundle} containing result information
308 | * @param requestId the unique request id sent with each API request
309 | */
310 | @Override
311 | public void onSpeechResults(final Bundle results, final String requestId) {
312 |
313 | final int currentTag = Integer.parseInt(getSupportFragmentManager().findFragmentById(
314 | R.id.fragmentContent).getTag());
315 |
316 | Fragment fragment;
317 |
318 | switch (currentTag) {
319 |
320 | case INDEX_FRAGMENT_DEMO_BASIC:
321 | fragment = getSupportFragmentManager()
322 | .findFragmentByTag(String.valueOf(INDEX_FRAGMENT_DEMO_BASIC));
323 |
324 | if (fragment != null) {
325 | ((FragmentDemoBasic) fragment).onSpeechResults(results, requestId);
326 | }
327 | break;
328 | case INDEX_FRAGMENT_DEMO_INTERACTION:
329 | fragment = getSupportFragmentManager()
330 | .findFragmentByTag(String.valueOf(INDEX_FRAGMENT_DEMO_INTERACTION));
331 | if (fragment != null) {
332 | ((FragmentDemoInteraction) fragment).onSpeechResults(results, requestId);
333 | }
334 | break;
335 | }
336 | }
337 |
338 | /**
339 | * Send the callback information from the {@link SaiyListener} to the relevant
340 | * fragment
341 | *
342 | * @param error one of {@link Defaults.ERROR}
343 | * @param requestId the unique request id sent with each API request
344 | */
345 | @Override
346 | public void onError(final Defaults.ERROR error, final String requestId) {
347 |
348 | final int currentTag = Integer.parseInt(getSupportFragmentManager().findFragmentById(
349 | R.id.fragmentContent).getTag());
350 |
351 | Fragment fragment;
352 |
353 | switch (currentTag) {
354 |
355 | case INDEX_FRAGMENT_DEMO_BASIC:
356 | fragment = getSupportFragmentManager()
357 | .findFragmentByTag(String.valueOf(INDEX_FRAGMENT_DEMO_BASIC));
358 |
359 | if (fragment != null) {
360 | ((FragmentDemoBasic) fragment).onError(error, requestId);
361 | }
362 | break;
363 | case INDEX_FRAGMENT_DEMO_INTERACTION:
364 | fragment = getSupportFragmentManager()
365 | .findFragmentByTag(String.valueOf(INDEX_FRAGMENT_DEMO_INTERACTION));
366 | if (fragment != null) {
367 | ((FragmentDemoInteraction) fragment).onError(error, requestId);
368 | }
369 | break;
370 | }
371 | }
372 |
373 | /**
374 | * Example dialog for prompting to install Saiy
375 | */
376 | public void showInstallDialog() {
377 |
378 | final AlertDialog.Builder builder = new AlertDialog.Builder(this);
379 | builder.setIcon(R.drawable.ic_menu_share);
380 | builder.setTitle(getString(R.string.install_dialog_title));
381 | builder.setMessage(getString(R.string.install_dialog_content));
382 | builder.setNegativeButton(R.string.install_dialog_negative, null);
383 | builder.setPositiveButton(R.string.install_dialog_positive, new DialogInterface.OnClickListener() {
384 | @Override
385 | public void onClick(final DialogInterface dialog, final int which) {
386 |
387 | final Intent intent = new Intent(Intent.ACTION_VIEW,
388 | Uri.parse(SAIY_PLAYSTORE_URL));
389 | intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
390 |
391 | try {
392 | startActivity(intent);
393 | } catch (final ActivityNotFoundException e) {
394 | Log.e(CLS_NAME, "showInstall: ActivityNotFoundException");
395 | e.printStackTrace();
396 | } catch (final Exception e) {
397 | Log.e(CLS_NAME, "showInstall: Exception");
398 | e.printStackTrace();
399 | }
400 | }
401 | });
402 |
403 | builder.show();
404 | }
405 |
406 | /**
407 | * Check if the required permissions have been granted. For API < 23 this will immediately return true.
408 | */
409 | private void checkPermissionsAndPrompt() {
410 |
411 | if (ActivityCompat.checkSelfPermission(this, android.Manifest.permission.RECORD_AUDIO)
412 | != PackageManager.PERMISSION_GRANTED
413 | || ActivityCompat.checkSelfPermission(this, SaiyRequest.CONTROL_SAIY)
414 | != PackageManager.PERMISSION_GRANTED) {
415 |
416 | Log.i(CLS_NAME, "checkPermissionsAndPrompt: PERMISSION_DENIED or not granted");
417 |
418 | if (ActivityCompat.shouldShowRequestPermissionRationale(this, android.Manifest.permission.RECORD_AUDIO)
419 | || ActivityCompat.shouldShowRequestPermissionRationale(this, SaiyRequest.CONTROL_SAIY)) {
420 | Log.i(CLS_NAME, "checkPermissionsAndPrompt: shouldShowRequestPermissionRationale");
421 |
422 | showSnackBar();
423 | } else {
424 | Log.i(CLS_NAME, "checkPermissionsAndPrompt: shouldShowRequestPermissionRationale: false");
425 |
426 | ActivityCompat.requestPermissions(this, PERMISSIONS_SAIY, PERMISSIONS_SAIY_REQUEST);
427 | }
428 |
429 | } else {
430 | Log.i(CLS_NAME, "checkPermissionsAndPrompt: PERMISSION_GRANTED");
431 | }
432 | }
433 |
434 | @Override
435 | public void onRequestPermissionsResult(final int requestCode, @NonNull final String permissions[],
436 | @NonNull final int[] grantResults) {
437 | Log.i(CLS_NAME, "onRequestPermissionsResult");
438 |
439 | switch (requestCode) {
440 |
441 | case PERMISSIONS_SAIY_REQUEST:
442 |
443 | if (granted(grantResults)) {
444 | Log.i(CLS_NAME, "onRequestPermissionsResult: PERMISSION_GRANTED");
445 |
446 | saiyAvailable = true;
447 |
448 | checkSaiyAvailability();
449 |
450 | } else {
451 | Log.w(CLS_NAME, "onRequestPermissionsResult: PERMISSION_DENIED");
452 |
453 | if (ActivityCompat.shouldShowRequestPermissionRationale(this, android.Manifest.permission.RECORD_AUDIO)
454 | || ActivityCompat.shouldShowRequestPermissionRationale(this, SaiyRequest.CONTROL_SAIY)) {
455 | Log.i(CLS_NAME, "checkPermissionsAndPrompt: shouldShowRequestPermissionRationale");
456 |
457 | showSnackBar();
458 |
459 | } else {
460 | Log.e(CLS_NAME, "checkPermissionsAndPrompt: shouldShowRequestPermissionRationale: false: game over");
461 |
462 | saiyAvailable = false;
463 | }
464 |
465 | }
466 | break;
467 | }
468 | }
469 |
470 | /**
471 | * Utility to check the permission outcome
472 | *
473 | * @param grantResults array of permission results
474 | * @return true if granted, false otherwise
475 | */
476 | private boolean granted(final int[] grantResults) {
477 | for (final int result : grantResults) {
478 | if (result != PackageManager.PERMISSION_GRANTED) {
479 | return false;
480 | }
481 | }
482 | return true;
483 | }
484 |
485 | /**
486 | * Just for example's sake of showing the permission rationale.
487 | */
488 | private void showSnackBar() {
489 | Snackbar.make(findViewById(R.id.fragmentContent), getString(R.string.permission_rationale),
490 | Snackbar.LENGTH_INDEFINITE).setAction(android.R.string.ok, new View.OnClickListener() {
491 | @Override
492 | public void onClick(View view) {
493 | ActivityCompat
494 | .requestPermissions(MainActivity.this, PERMISSIONS_SAIY,
495 | PERMISSIONS_SAIY_REQUEST);
496 | }
497 | }).show();
498 | }
499 |
500 | /**
501 | * Standard check to default behaviour of closing the drawer, returning to the 'home'
502 | * Fragment or exiting the application
503 | */
504 | @Override
505 | public void onBackPressed() {
506 |
507 | if (drawer.isDrawerOpen(GravityCompat.START)) {
508 | drawer.closeDrawer(GravityCompat.START);
509 | } else {
510 | try {
511 |
512 | switch (Integer.valueOf(getSupportFragmentManager().findFragmentById(R.id.fragmentContent).getTag())) {
513 |
514 | case INDEX_FRAGMENT_DEMO_BASIC:
515 | Log.d(CLS_NAME, "onBackPressed: INDEX_FRAGMENT_DEMO_BASIC");
516 | super.onBackPressed();
517 | break;
518 | default:
519 | Log.i(CLS_NAME, "onBackPressed: default");
520 |
521 | doFragmentReplaceTransaction(FragmentDemoBasic.newInstance(), INDEX_FRAGMENT_DEMO_BASIC);
522 | navigationView.setCheckedItem(R.id.nav_basic);
523 | navigationView.getMenu().getItem(INDEX_FRAGMENT_DEMO_BASIC).setChecked(true);
524 | break;
525 | }
526 |
527 | } catch (final NullPointerException e) {
528 | Log.w(CLS_NAME, "onBackPressed: NullPointerException");
529 | super.onBackPressed();
530 | } catch (final NumberFormatException e) {
531 | Log.w(CLS_NAME, "onBackPressed: NumberFormatException");
532 | super.onBackPressed();
533 | }
534 | }
535 | }
536 |
537 | /**
538 | * Apply a standard check to make sure we are not wasting resource by
539 | * re-instantiating the same fragment that is already displayed.
540 | *
541 | * @param item the menu item that was clicked
542 | * @return true - regardless.
543 | */
544 | @Override
545 | public boolean onNavigationItemSelected(@NonNull final MenuItem item) {
546 | Log.i(CLS_NAME, "onNavigationItemSelected");
547 |
548 | drawer.closeDrawer(GravityCompat.START);
549 |
550 | new Thread(new Runnable() {
551 | @Override
552 | public void run() {
553 |
554 | final int currentTag = Integer.parseInt(getSupportFragmentManager().findFragmentById(
555 | R.id.fragmentContent).getTag());
556 | final int id = item.getItemId();
557 | boolean proceed;
558 |
559 | switch (currentTag) {
560 |
561 | case INDEX_FRAGMENT_DEMO_BASIC:
562 | proceed = (id != R.id.nav_basic);
563 | break;
564 | case INDEX_FRAGMENT_DEMO_COMMAND:
565 | proceed = (id != R.id.nav_command);
566 | break;
567 | case INDEX_FRAGMENT_DEMO_INTERACTION:
568 | proceed = (id != R.id.nav_interaction);
569 | break;
570 | default:
571 | proceed = false;
572 | break;
573 | }
574 |
575 | Log.i(CLS_NAME, "onNavigationItemSelected: proceeding: " + proceed);
576 |
577 | if (proceed) {
578 |
579 | final int tag;
580 | final Fragment fragment;
581 |
582 | switch (id) {
583 |
584 | case R.id.nav_basic:
585 | fragment = FragmentDemoBasic.newInstance();
586 | tag = INDEX_FRAGMENT_DEMO_BASIC;
587 | break;
588 | case R.id.nav_command:
589 | fragment = FragmentDemoCommand.newInstance();
590 | tag = INDEX_FRAGMENT_DEMO_COMMAND;
591 | break;
592 | case R.id.nav_interaction:
593 | fragment = FragmentDemoInteraction.newInstance();
594 | tag = INDEX_FRAGMENT_DEMO_INTERACTION;
595 | break;
596 | default:
597 | fragment = FragmentDemoBasic.newInstance();
598 | tag = INDEX_FRAGMENT_DEMO_BASIC;
599 | break;
600 | }
601 |
602 | runOnUiThread(new Runnable() {
603 | @Override
604 | public void run() {
605 | doFragmentReplaceTransaction(fragment, tag);
606 | }
607 | });
608 |
609 | } else {
610 | Log.i(CLS_NAME, "same fragment ignoring");
611 | }
612 | }
613 | }).start();
614 |
615 | return true;
616 | }
617 |
618 |
619 | @Override
620 | public void onPause() {
621 | super.onPause();
622 | Log.i(CLS_NAME, "onPause");
623 | }
624 |
625 | @Override
626 | public void onResume() {
627 | super.onResume();
628 | Log.i(CLS_NAME, "onResume: saiyAvailable: " + saiyAvailable);
629 |
630 | /*
631 | * Always recheck in onResume, as the user may have returned
632 | * to the app after correcting a condition that previously
633 | * made the Saiy API unavailable. This check uses minimal resource.
634 | */
635 | if (!saiyAvailable) {
636 | checkSaiyAvailability();
637 | }
638 | }
639 |
640 | @Override
641 | public void onDestroy() {
642 | super.onDestroy();
643 | Log.i(CLS_NAME, "onDestroy");
644 | saiyRequest = null;
645 | params = null;
646 |
647 | // Why not
648 | System.gc();
649 | System.exit(0);
650 | }
651 | }
652 |
--------------------------------------------------------------------------------
/app/src/main/java/ai/saiy/android/apiexample/ui/fragment/FragmentDemoBasic.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2016 Saiy™ Ltd
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * http://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package ai.saiy.android.apiexample.ui.fragment;
18 |
19 | import android.content.Context;
20 | import android.os.Bundle;
21 | import android.os.Handler;
22 | import android.os.Looper;
23 | import android.support.annotation.NonNull;
24 | import android.support.annotation.Nullable;
25 | import android.support.v4.app.Fragment;
26 | import android.text.method.ScrollingMovementMethod;
27 | import android.util.Log;
28 | import android.view.LayoutInflater;
29 | import android.view.View;
30 | import android.view.ViewGroup;
31 | import android.view.inputmethod.InputMethodManager;
32 | import android.widget.AdapterView;
33 | import android.widget.EditText;
34 | import android.widget.ImageButton;
35 | import android.widget.Spinner;
36 | import android.widget.TextView;
37 |
38 | import org.json.JSONException;
39 | import org.json.JSONObject;
40 |
41 | import java.util.ArrayList;
42 | import java.util.Locale;
43 |
44 | import ai.saiy.android.api.Defaults;
45 | import ai.saiy.android.api.attributes.Gender;
46 | import ai.saiy.android.api.remote.Request;
47 | import ai.saiy.android.api.request.SaiyRequest;
48 | import ai.saiy.android.api.request.SaiyRequestParams;
49 | import ai.saiy.android.apiexample.R;
50 | import ai.saiy.android.apiexample.ui.activity.MainActivity;
51 |
52 | /**
53 | * Demonstration of all available Text to Speech, Voice Recognition and Natural Language providers
54 | * that are currently supported via the Saiy API.
55 | *
56 | * For demonstration purposes, you can enter your credentials for each provider in the
57 | * {@link ai.saiy.android.apiexample.configuration.SaiyConfiguration} file, although in production
58 | * you will of course need to store these more securely, or better still fetch them from your server.
59 | *
60 | * Created by benrandall76@gmail.com on 26/09/2016.
61 | */
62 |
63 | public class FragmentDemoBasic extends Fragment implements AdapterView.OnItemSelectedListener,
64 | View.OnClickListener {
65 |
66 | /**
67 | * TAG
68 | */
69 | private final String CLS_NAME = FragmentDemoBasic.class.getSimpleName();
70 |
71 | /**
72 | * Constants for TTS, VR and NLU options.
73 | */
74 | private static final int TTS_DEVICE_DEFAULT = 0;
75 | private static final int TTS_NUANCE = 1;
76 |
77 | private static final int VR_NONE = 0;
78 | private static final int VR_NATIVE = 1;
79 | private static final int VR_GOOGLE_CLOUD = 2;
80 | private static final int VR_GOOGLE_CHROMIUM = 3;
81 | private static final int VR_NUANCE = 4;
82 | private static final int VR_MICROSOFT = 5;
83 | private static final int VR_IBM = 6;
84 | private static final int VR_WIT = 7;
85 |
86 | private static final int NLU_NONE = 0;
87 | private static final int NLU_NUANCE = 1;
88 | private static final int NLU_MICROSOFT = 2;
89 | private static final int NLU_API_AI = 3;
90 | private static final int NLU_WIT = 4;
91 |
92 | /**
93 | * UI components
94 | */
95 | private Spinner spinnerTTS;
96 | private Spinner spinnerVR;
97 | private Spinner spinnerNLU;
98 | private EditText etSpeech;
99 | private TextView tvResults;
100 |
101 | /**
102 | * Will increment. Set your own in production that will correspond to an action
103 | * when a request has finished processing.
104 | */
105 | private int testRequestID = 555;
106 |
107 | /**
108 | * Locale US used for the sake of example, as it's supported by all
109 | * TTS, VR and NLU options.
110 | */
111 | private final Locale locale = Locale.US;
112 |
113 | /**
114 | * Standard empty fragment constructor
115 | */
116 | public FragmentDemoBasic() {
117 | }
118 |
119 | /**
120 | * Suggested static instantiation method
121 | *
122 | * @return a new instance of this fragment
123 | */
124 | public static FragmentDemoBasic newInstance() {
125 | return new FragmentDemoBasic();
126 | }
127 |
128 | @Override
129 | public void onCreate(final Bundle savedInstanceState) {
130 | super.onCreate(savedInstanceState);
131 | Log.i(CLS_NAME, "onCreate");
132 | }
133 |
134 | @Override
135 | public View onCreateView(@NonNull final LayoutInflater inflater, final ViewGroup container, final Bundle savedInstanceState) {
136 | Log.i(CLS_NAME, "onCreateView");
137 |
138 | final View rootView = inflater.inflate(R.layout.fragment_demo_basic, container, false);
139 |
140 | spinnerTTS = rootView.findViewById(R.id.spinnerTTS);
141 | spinnerTTS.setOnItemSelectedListener(this);
142 | spinnerVR = rootView.findViewById(R.id.spinnerVR);
143 | spinnerVR.setOnItemSelectedListener(this);
144 | spinnerNLU = rootView.findViewById(R.id.spinnerNLU);
145 | spinnerNLU.setOnItemSelectedListener(this);
146 |
147 | etSpeech = rootView.findViewById(R.id.etSpeech);
148 |
149 | tvResults = rootView.findViewById(R.id.tvResults);
150 | tvResults.setMovementMethod(ScrollingMovementMethod.getInstance());
151 |
152 | final ImageButton imageButton = rootView.findViewById(R.id.ibRun);
153 | imageButton.setOnClickListener(this);
154 |
155 | return rootView;
156 | }
157 |
158 |
159 | /**
160 | * Make sure VR and NLU providers match
161 | */
162 | @Override
163 | public void onItemSelected(final AdapterView parent, final View view, final int position, final long id) {
164 |
165 | switch (parent.getId()) {
166 |
167 | case R.id.spinnerTTS:
168 | Log.i(CLS_NAME, "onItemSelected: spinnerTTS: " + parent.getItemAtPosition(position).toString());
169 |
170 | switch (position) {
171 |
172 | case TTS_DEVICE_DEFAULT:
173 | break;
174 | case TTS_NUANCE:
175 | break;
176 | }
177 |
178 | break;
179 |
180 | case R.id.spinnerVR:
181 | Log.i(CLS_NAME, "onItemSelected: spinnerVR: " + parent.getItemAtPosition(position).toString());
182 |
183 | switch (position) {
184 |
185 | case VR_NONE:
186 | if (spinnerNLU.getSelectedItemPosition() != NLU_NONE) {
187 | spinnerNLU.setSelection(NLU_NONE, true);
188 | }
189 | break;
190 | case VR_NATIVE:
191 | if (spinnerNLU.getSelectedItemPosition() != NLU_NONE) {
192 | spinnerNLU.setSelection(NLU_NONE, true);
193 | }
194 | break;
195 | case VR_GOOGLE_CLOUD:
196 | if (spinnerNLU.getSelectedItemPosition() != NLU_NONE) {
197 | spinnerNLU.setSelection(NLU_NONE, true);
198 | }
199 | break;
200 | case VR_GOOGLE_CHROMIUM:
201 | if (spinnerNLU.getSelectedItemPosition() != NLU_NONE) {
202 | spinnerNLU.setSelection(NLU_NONE, true);
203 | }
204 | break;
205 | case VR_NUANCE:
206 | if (spinnerNLU.getSelectedItemPosition() != NLU_NUANCE
207 | && spinnerNLU.getSelectedItemPosition() != NLU_NONE) {
208 | spinnerNLU.setSelection(NLU_NONE, true);
209 | }
210 | break;
211 | case VR_MICROSOFT:
212 | if (spinnerNLU.getSelectedItemPosition() != NLU_MICROSOFT
213 | && spinnerNLU.getSelectedItemPosition() != NLU_NONE) {
214 | spinnerNLU.setSelection(NLU_NONE, true);
215 | }
216 | break;
217 | case VR_IBM:
218 | if (spinnerNLU.getSelectedItemPosition() != NLU_NONE) {
219 | spinnerNLU.setSelection(NLU_NONE, true);
220 | }
221 | break;
222 | case VR_WIT:
223 | if (spinnerNLU.getSelectedItemPosition() != NLU_WIT
224 | && spinnerNLU.getSelectedItemPosition() != NLU_NONE) {
225 | spinnerNLU.setSelection(NLU_NONE, true);
226 | }
227 | break;
228 | }
229 |
230 | break;
231 |
232 | case R.id.spinnerNLU:
233 | Log.i(CLS_NAME, "onItemSelected: spinnerNLU: " + parent.getItemAtPosition(position).toString());
234 |
235 | switch (position) {
236 |
237 | case NLU_NONE:
238 | break;
239 | case NLU_NUANCE:
240 | if (spinnerVR.getSelectedItemPosition() != VR_NUANCE) {
241 | spinnerVR.setSelection(VR_NUANCE, true);
242 | }
243 | break;
244 | case NLU_MICROSOFT:
245 | if (spinnerVR.getSelectedItemPosition() != VR_MICROSOFT) {
246 | spinnerVR.setSelection(VR_MICROSOFT, true);
247 | }
248 | break;
249 | case NLU_API_AI:
250 | if (spinnerVR.getSelectedItemPosition() == VR_NONE) {
251 | spinnerVR.setSelection(VR_NATIVE, true);
252 | }
253 | break;
254 | case NLU_WIT:
255 | if (spinnerVR.getSelectedItemPosition() != VR_WIT) {
256 | spinnerVR.setSelection(VR_WIT, true);
257 | }
258 | break;
259 | }
260 |
261 | break;
262 | }
263 | }
264 |
265 | /**
266 | * Callback method to be invoked when the selection disappears from this
267 | * view. The selection can disappear for instance when touch is activated
268 | * or when the adapter becomes empty.
269 | *
270 | * @param parent The AdapterView that now contains no selected item.
271 | */
272 | @Override
273 | public void onNothingSelected(final AdapterView parent) {
274 | Log.i(CLS_NAME, "onNothingSelected");
275 | }
276 |
277 | @Override
278 | public void onClick(final View v) {
279 |
280 | if (etSpeech.getText() != null) {
281 |
282 | String commandText = etSpeech.getText().toString();
283 |
284 | //noinspection ConstantConditions
285 | if (commandText == null || commandText.trim().isEmpty()) {
286 | Log.w(CLS_NAME, "onClick: text naked");
287 |
288 | commandText = getString(R.string.default_intro);
289 | }
290 |
291 | hideIME();
292 | runAPI(commandText);
293 |
294 | } else {
295 | Log.e(CLS_NAME, "onClick: getText null");
296 | }
297 | }
298 |
299 | /**
300 | * Run the API using the configuration selected in the spinners.
301 | */
302 | @SuppressWarnings("ConstantConditions")
303 | private void runAPI(@NonNull final String utterance) {
304 | Log.i(CLS_NAME, "runAPI");
305 |
306 | appendText(null);
307 |
308 | if (MainActivity.saiyAvailable) {
309 |
310 | boolean apiParamsPass = true;
311 |
312 | final SaiyRequest saiyRequest = ((MainActivity) getActivity()).getSaiyRequest();
313 | final SaiyRequestParams params = ((MainActivity) getActivity()).getParams();
314 |
315 | if (saiyRequest != null && params != null) {
316 |
317 | params.setUtterance(utterance);
318 | params.setRequestId(String.valueOf(testRequestID));
319 | params.setAction(Defaults.ACTION.SPEAK_LISTEN);
320 |
321 | switch (spinnerTTS.getSelectedItemPosition()) {
322 |
323 | case TTS_DEVICE_DEFAULT:
324 |
325 | if (saiyRequest.isTTSLanguageLocalAvailable(locale)) {
326 | params.setTTSProvider(Defaults.TTS.LOCAL);
327 | params.setTTSLanguageLocal(locale);
328 | } else {
329 | Log.e(CLS_NAME, "Local Text to Speech does not support the locale " + locale.toString());
330 | apiParamsPass = false;
331 | }
332 |
333 | break;
334 | case TTS_NUANCE:
335 |
336 | if (saiyRequest.isTTSLanguageNuanceAvailable(locale)) {
337 | params.setTTSProvider(Defaults.TTS.NETWORK_NUANCE);
338 | params.setTTSLanguageNuance(locale, Gender.FEMALE);
339 | } else {
340 | Log.e(CLS_NAME, "Nuance Text to Speech does not support the locale " + locale.toString());
341 | apiParamsPass = false;
342 | }
343 |
344 | break;
345 | }
346 |
347 | switch (spinnerVR.getSelectedItemPosition()) {
348 |
349 | case VR_NONE:
350 | params.setAction(Defaults.ACTION.SPEAK_ONLY);
351 | break;
352 | case VR_NATIVE:
353 |
354 | if (saiyRequest.isVRLanguageNativeAvailable(locale)) {
355 | params.setVRProvider(Defaults.VR.NATIVE);
356 | params.setVRLanguageNative(locale);
357 | } else {
358 | Log.e(CLS_NAME, "Native Voice Recognition does not support the locale " + locale.toString());
359 | apiParamsPass = false;
360 | }
361 |
362 | break;
363 | case VR_GOOGLE_CLOUD:
364 |
365 | if (saiyRequest.isVRLanguageGoogleAvailable(locale)) {
366 | params.setVRProvider(Defaults.VR.GOOGLE_CLOUD);
367 | params.setVRLanguageGoogle(locale);
368 | } else {
369 | Log.e(CLS_NAME, "Google Voice Recognition does not support the locale " + locale.toString());
370 | apiParamsPass = false;
371 | }
372 |
373 | break;
374 | case VR_GOOGLE_CHROMIUM:
375 |
376 | if (saiyRequest.isVRLanguageGoogleAvailable(locale)) {
377 | params.setVRProvider(Defaults.VR.GOOGLE_CHROMIUM);
378 | params.setVRLanguageGoogle(locale);
379 | } else {
380 | Log.e(CLS_NAME, "Google Voice Recognition does not support the locale " + locale.toString());
381 | apiParamsPass = false;
382 | }
383 |
384 | break;
385 | case VR_NUANCE:
386 |
387 | if (saiyRequest.isVRLanguageNuanceAvailable(locale)) {
388 | params.setVRProvider(Defaults.VR.NUANCE);
389 | params.setVRLanguageNuance(locale);
390 | } else {
391 | Log.e(CLS_NAME, "Nuance Voice Recognition does not support the locale " + locale.toString());
392 | apiParamsPass = false;
393 | }
394 |
395 | break;
396 | case VR_MICROSOFT:
397 |
398 | Log.e(CLS_NAME, "Microsoft Voice Recognition is currently disabled until they fix the architecture issues");
399 | apiParamsPass = false;
400 |
401 | /*
402 | * Due to a lack of architecture support, this needs to be disabled for now
403 | * If your test device is armeabi or X86 you should be good to go.
404 | *
405 | * https://github.com/Azure-Samples/Cognitive-Speech-STT-Android/issues/54
406 | */
407 | // if (saiyRequest.isVRLanguageMicrosoftAvailable(locale)) {
408 | // params.setVRProvider(Defaults.VR.MICROSOFT);
409 | // params.setVRLanguageMicrosoft(locale);
410 | // } else {
411 | // Log.e(CLS_NAME, "Microsoft Voice Recognition does not support the locale " + locale.toString());
412 | // apiParamsPass = false;
413 | // }
414 |
415 | break;
416 | case VR_IBM:
417 |
418 | if (saiyRequest.isVRLanguageIBMAvailable(locale)) {
419 | params.setVRProvider(Defaults.VR.IBM);
420 | params.setVRLanguageIBM(locale);
421 | } else {
422 | Log.e(CLS_NAME, "IBM Voice Recognition does not support the locale " + locale.toString());
423 | apiParamsPass = false;
424 | }
425 |
426 | break;
427 | case VR_WIT:
428 |
429 | if (saiyRequest.isVRLanguageWitAvailable(locale)) {
430 | params.setVRProvider(Defaults.VR.WIT);
431 | params.setVRLanguageWit(locale);
432 | } else {
433 | Log.e(CLS_NAME, "WIT Voice Recognition does not support the locale " + locale.toString());
434 | apiParamsPass = false;
435 | }
436 |
437 | break;
438 | }
439 |
440 | switch (spinnerNLU.getSelectedItemPosition()) {
441 |
442 | case NLU_NONE:
443 | params.setLanguageModel(Defaults.LanguageModel.LOCAL);
444 | break;
445 | case NLU_NUANCE:
446 |
447 | // At time of writing, the Mix.nlu BETA supports only English-USA.
448 | if (saiyRequest.isNLULanguageNuanceAvailable(locale)) {
449 | params.setNLULanguageNuance(locale);
450 | params.setLanguageModel(Defaults.LanguageModel.NUANCE);
451 | } else {
452 | Log.e(CLS_NAME, "Nuance NLU does not support the locale " + locale.toString());
453 | apiParamsPass = false;
454 | }
455 |
456 | break;
457 | case NLU_MICROSOFT:
458 |
459 | if (saiyRequest.isNLULanguageMicrosoftAvailable(locale)) {
460 | params.setNLULanguageMicrosoft(locale);
461 | params.setLanguageModel(Defaults.LanguageModel.MICROSOFT);
462 | } else {
463 | Log.e(CLS_NAME, "Microsoft NLU does not support the locale " + locale.toString());
464 | apiParamsPass = false;
465 | }
466 |
467 | break;
468 | case NLU_API_AI:
469 |
470 | if (saiyRequest.isNLULanguageAPIAIAvailable(locale)) {
471 | params.setNLULanguageAPIAI(locale);
472 | params.setLanguageModel(Defaults.LanguageModel.API_AI);
473 | } else {
474 | Log.e(CLS_NAME, "Microsoft NLU does not support the locale " + locale.toString());
475 | apiParamsPass = false;
476 | }
477 |
478 | break;
479 | case NLU_WIT:
480 |
481 | if (saiyRequest.isNLULanguageWitAvailable(locale)) {
482 | params.setNLULanguageWit(locale);
483 | params.setLanguageModel(Defaults.LanguageModel.WIT);
484 | } else {
485 | Log.e(CLS_NAME, "Microsoft NLU does not support the locale " + locale.toString());
486 | apiParamsPass = false;
487 | }
488 |
489 | break;
490 | }
491 |
492 | if (apiParamsPass) {
493 |
494 | // Add the SaiyRequestParams
495 | saiyRequest.setParams(params);
496 |
497 | // Send the request
498 | saiyRequest.execute();
499 |
500 | // Increment the request id
501 | testRequestID++;
502 |
503 | } else {
504 | Log.e(CLS_NAME, "The request could not be processed. " +
505 | "If you don't know why, please check the logcat in more detail");
506 | }
507 | } else {
508 | Log.e(CLS_NAME, "Saiy has not correctly initialised. " +
509 | "Try opening and closing the demo app again and checking the logcat");
510 | }
511 | } else {
512 | Log.e(CLS_NAME, "Saiy is reporting unavailable. " +
513 | "If you don't know why, please check the logcat in more detail");
514 | appendText("BAD REQUEST");
515 | }
516 | }
517 |
518 | /**
519 | * Hide the IME once the input is complete
520 | */
521 | @SuppressWarnings("ConstantConditions")
522 | private void hideIME() {
523 | Log.i(CLS_NAME, "hideIME");
524 |
525 | ((InputMethodManager)
526 | etSpeech.getContext().getSystemService(Context.INPUT_METHOD_SERVICE))
527 | .hideSoftInputFromWindow(etSpeech.getApplicationWindowToken(),
528 | InputMethodManager.HIDE_NOT_ALWAYS);
529 | }
530 |
531 |
532 | /**
533 | * The {@link ai.saiy.android.api.remote.SaiyListener} is implemented in the Main Activity
534 | * class and passed here to the method of its namesake. You could implement the listener
535 | * directly here should you wish, depending on your design pattern. This callback will not
536 | * be on the main thread.
537 | *
538 | * @param requestId the unique request id sent with each API request
539 | */
540 | public void onUtteranceCompleted(final String requestId) {
541 | Log.d(CLS_NAME, "onUtteranceCompleted: " + requestId);
542 | appendText("onUtteranceCompleted: id: " + requestId + "\n");
543 | }
544 |
545 | /**
546 | * As above
547 | *
548 | * @param results the {@link Bundle} containing result information
549 | * @param requestId the unique request id sent with each API request
550 | */
551 | public void onSpeechResults(final Bundle results, final String requestId) {
552 | Log.d(CLS_NAME, "onSpeechResults: id: " + requestId);
553 | appendText("onSpeechResults: id: " + requestId + "\n");
554 |
555 | final ArrayList voiceData = results.getStringArrayList(Request.RESULTS_RECOGNITION);
556 | final float[] confidenceScore = results.getFloatArray(Request.CONFIDENCE_SCORES);
557 | final String nluString = results.getString(Request.RESULTS_NLU);
558 |
559 | if (confidenceScore != null && voiceData != null && confidenceScore.length == voiceData.size()) {
560 | for (int i = 0; i < voiceData.size(); i++) {
561 | Log.i(CLS_NAME, "onSpeechResults: " + voiceData.get(i) + " ~ " + confidenceScore[i]);
562 | appendText(voiceData.get(i) + " ~ " + confidenceScore[i]);
563 | }
564 | } else if (voiceData != null) {
565 | for (int i = 0; i < voiceData.size(); i++) {
566 | Log.i(CLS_NAME, "onSpeechResults: " + voiceData.get(i));
567 | appendText(voiceData.get(i));
568 | }
569 | } else {
570 | Log.w(CLS_NAME, "onSpeechResults: values error");
571 | appendText("onSpeechResults: values error");
572 | }
573 |
574 | if (nluString != null) {
575 | try {
576 | final JSONObject nulObject = new JSONObject(nluString);
577 | Log.i(CLS_NAME, "nulObject: " + nulObject.toString(4));
578 | appendText("\n" + nulObject.toString(4));
579 | } catch (final JSONException e) {
580 | Log.w(CLS_NAME, "onSpeechResults: JSONException");
581 | e.printStackTrace();
582 | }
583 | }
584 | }
585 |
586 | /**
587 | * As above
588 | *
589 | * @param error one of {@link Defaults.ERROR}
590 | * @param requestId the unique request id sent with each API request
591 | */
592 | public void onError(final Defaults.ERROR error, final String requestId) {
593 | Log.d(CLS_NAME, "onError: id: " + requestId);
594 |
595 | switch (error) {
596 |
597 | case ERROR_NO_MATCH:
598 | Log.w(CLS_NAME, "onError: ERROR_NO_MATCH");
599 | appendText("onError: ERROR_NO_MATCH");
600 |
601 | /*
602 | The speech recogniser returned empty results. The most common reason for this,
603 | would be the user failing to speak or using naughty words with the profanity
604 | filter enabled....
605 |
606 | Saiy will announce this to the user and direct them as to how to correct the issue.
607 | */
608 |
609 | break;
610 | case ERROR_BUSY:
611 | Log.w(CLS_NAME, "onError: ERROR_BUSY");
612 | appendText("onError: ERROR_BUSY");
613 |
614 | /*
615 | Your request was returned due to Saiy either listening or speaking. In this
616 | situation, an instruction to cancel the listening or speech was made, but it is not
617 | guaranteed to have been successful.
618 |
619 | The user will be aware of this scenario.
620 | */
621 |
622 | break;
623 | case ERROR_INTERRUPTED:
624 | Log.w(CLS_NAME, "onError: ERROR_INTERRUPTED");
625 | appendText("onError: ERROR_INTERRUPTED");
626 |
627 |
628 | /*
629 | Your request was cancelled mid process, due most probably, to an incoming call. The
630 | user will be aware of this scenario.
631 | */
632 |
633 | break;
634 | case ERROR_NETWORK:
635 | Log.w(CLS_NAME, "onError: ERROR_NETWORK");
636 | appendText("onError: ERROR_NETWORK");
637 |
638 | /*
639 | Your request could not be processed due to network conditions. Saiy will have informed
640 | the user of this issue.
641 | */
642 |
643 | break;
644 | case ERROR_SAIY:
645 | Log.w(CLS_NAME, "onError: ERROR_SAIY");
646 | appendText("onError: ERROR_SAIY");
647 |
648 | /*
649 | An error has occurred which Saiy has handled and directed the user to the solution.
650 | This will mean your request has failed, but hopefully the user is taking action via
651 | Saiy to resolve the problem and it may be resolved for the next request.
652 |
653 | Examples of such errors are missing voice/language installations or a hardware error.
654 | */
655 |
656 | break;
657 | case ERROR_DEVELOPER:
658 | Log.w(CLS_NAME, "onError: ERROR_DEVELOPER");
659 | appendText("onError: ERROR_DEVELOPER");
660 |
661 | /*
662 | This is returned if parameters included in the default configuration
663 | of the TTS or VR (etc) provider haven't worked or are invalid. Double check the API keys
664 | you provided are functioning and other parameters are correct. Check the logcat output
665 | for Saiy, to see if a more specific error has been reported.
666 |
667 | Make sure you declare
668 | in your Manifest.
669 |
670 | This error should not happen in production, as such things should become
671 | apparent in testing, but it is here just in case.
672 | */
673 |
674 | MainActivity.saiyAvailable = false;
675 |
676 | break;
677 | case ERROR_DENIED:
678 | Log.w(CLS_NAME, "onError: REQUEST_DENIED");
679 | appendText("onError: REQUEST_DENIED");
680 |
681 | /*
682 | Whilst the parameters passed for the remote request to Saiy were validated
683 | correctly (as far as not null or missing), the further request to the TTS or
684 | VR (etc) provider was returned as declined. Check the logcat output
685 | for Saiy, to see if a more specific error has been reported.
686 |
687 | One valid scenario here, would be your API key being over its usage quota.
688 |
689 | A further reason could be your application has been 'blacklisted' by Saiy. This can
690 | occur if too many misconfigured requests have been sent within a short period of time.
691 | Saiy will decline all further requests, to make sure the performance of the app
692 | remains unaffected.
693 |
694 | Any blacklisted apps can be 'released' by the user from within the Saiy Application
695 | Settings. The blacklist is cleared each time the Saiy Service restarts, or a application
696 | is updated - giving the previously misbehaving app a chance to right its wrongs.
697 | */
698 |
699 | MainActivity.saiyAvailable = false;
700 |
701 | break;
702 | case ERROR_UNKNOWN:
703 | default:
704 | Log.e(CLS_NAME, "onError: ERROR_UNKNOWN");
705 | appendText("onError: ERROR_UNKNOWN");
706 |
707 | /*
708 | Saiy will default to this error if something inexplicable has happened. There is no
709 | guarantee that Saiy will have announced an issue to the user, but it should have.
710 | */
711 |
712 | MainActivity.saiyAvailable = false;
713 | break;
714 | }
715 | }
716 |
717 | /**
718 | * Append results on the main thread.
719 | */
720 | private void appendText(@Nullable final String words) {
721 |
722 | if (getActivity() != null) {
723 | new Handler(Looper.getMainLooper()).post(new Runnable() {
724 | @Override
725 | public void run() {
726 | if (words != null) {
727 | tvResults.append("\n" + words);
728 | } else {
729 | tvResults.setText("");
730 | }
731 | }
732 | });
733 | }
734 | }
735 |
736 | @Override
737 | public void onPause() {
738 | super.onPause();
739 | Log.i(CLS_NAME, "onPause");
740 | }
741 |
742 | @Override
743 | public void onResume() {
744 | super.onResume();
745 | Log.i(CLS_NAME, "onResume");
746 | }
747 |
748 | @Override
749 | public void onDestroy() {
750 | super.onDestroy();
751 | Log.i(CLS_NAME, "onDestroy");
752 | }
753 | }
754 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU AFFERO GENERAL PUBLIC LICENSE
2 | Version 3, 19 November 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU Affero General Public License is a free, copyleft license for
11 | software and other kinds of works, specifically designed to ensure
12 | cooperation with the community in the case of network server software.
13 |
14 | The licenses for most software and other practical works are designed
15 | to take away your freedom to share and change the works. By contrast,
16 | our General Public Licenses are intended to guarantee your freedom to
17 | share and change all versions of a program--to make sure it remains free
18 | software for all its users.
19 |
20 | When we speak of free software, we are referring to freedom, not
21 | price. Our General Public Licenses are designed to make sure that you
22 | have the freedom to distribute copies of free software (and charge for
23 | them if you wish), that you receive source code or can get it if you
24 | want it, that you can change the software or use pieces of it in new
25 | free programs, and that you know you can do these things.
26 |
27 | Developers that use our General Public Licenses protect your rights
28 | with two steps: (1) assert copyright on the software, and (2) offer
29 | you this License which gives you legal permission to copy, distribute
30 | and/or modify the software.
31 |
32 | A secondary benefit of defending all users' freedom is that
33 | improvements made in alternate versions of the program, if they
34 | receive widespread use, become available for other developers to
35 | incorporate. Many developers of free software are heartened and
36 | encouraged by the resulting cooperation. However, in the case of
37 | software used on network servers, this result may fail to come about.
38 | The GNU General Public License permits making a modified version and
39 | letting the public access it on a server without ever releasing its
40 | source code to the public.
41 |
42 | The GNU Affero General Public License is designed specifically to
43 | ensure that, in such cases, the modified source code becomes available
44 | to the community. It requires the operator of a network server to
45 | provide the source code of the modified version running there to the
46 | users of that server. Therefore, public use of a modified version, on
47 | a publicly accessible server, gives the public access to the source
48 | code of the modified version.
49 |
50 | An older license, called the Affero General Public License and
51 | published by Affero, was designed to accomplish similar goals. This is
52 | a different license, not a version of the Affero GPL, but Affero has
53 | released a new version of the Affero GPL which permits relicensing under
54 | this license.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | TERMS AND CONDITIONS
60 |
61 | 0. Definitions.
62 |
63 | "This License" refers to version 3 of the GNU Affero General Public License.
64 |
65 | "Copyright" also means copyright-like laws that apply to other kinds of
66 | works, such as semiconductor masks.
67 |
68 | "The Program" refers to any copyrightable work licensed under this
69 | License. Each licensee is addressed as "you". "Licensees" and
70 | "recipients" may be individuals or organizations.
71 |
72 | To "modify" a work means to copy from or adapt all or part of the work
73 | in a fashion requiring copyright permission, other than the making of an
74 | exact copy. The resulting work is called a "modified version" of the
75 | earlier work or a work "based on" the earlier work.
76 |
77 | A "covered work" means either the unmodified Program or a work based
78 | on the Program.
79 |
80 | To "propagate" a work means to do anything with it that, without
81 | permission, would make you directly or secondarily liable for
82 | infringement under applicable copyright law, except executing it on a
83 | computer or modifying a private copy. Propagation includes copying,
84 | distribution (with or without modification), making available to the
85 | public, and in some countries other activities as well.
86 |
87 | To "convey" a work means any kind of propagation that enables other
88 | parties to make or receive copies. Mere interaction with a user through
89 | a computer network, with no transfer of a copy, is not conveying.
90 |
91 | An interactive user interface displays "Appropriate Legal Notices"
92 | to the extent that it includes a convenient and prominently visible
93 | feature that (1) displays an appropriate copyright notice, and (2)
94 | tells the user that there is no warranty for the work (except to the
95 | extent that warranties are provided), that licensees may convey the
96 | work under this License, and how to view a copy of this License. If
97 | the interface presents a list of user commands or options, such as a
98 | menu, a prominent item in the list meets this criterion.
99 |
100 | 1. Source Code.
101 |
102 | The "source code" for a work means the preferred form of the work
103 | for making modifications to it. "Object code" means any non-source
104 | form of a work.
105 |
106 | A "Standard Interface" means an interface that either is an official
107 | standard defined by a recognized standards body, or, in the case of
108 | interfaces specified for a particular programming language, one that
109 | is widely used among developers working in that language.
110 |
111 | The "System Libraries" of an executable work include anything, other
112 | than the work as a whole, that (a) is included in the normal form of
113 | packaging a Major Component, but which is not part of that Major
114 | Component, and (b) serves only to enable use of the work with that
115 | Major Component, or to implement a Standard Interface for which an
116 | implementation is available to the public in source code form. A
117 | "Major Component", in this context, means a major essential component
118 | (kernel, window system, and so on) of the specific operating system
119 | (if any) on which the executable work runs, or a compiler used to
120 | produce the work, or an object code interpreter used to run it.
121 |
122 | The "Corresponding Source" for a work in object code form means all
123 | the source code needed to generate, install, and (for an executable
124 | work) run the object code and to modify the work, including scripts to
125 | control those activities. However, it does not include the work's
126 | System Libraries, or general-purpose tools or generally available free
127 | programs which are used unmodified in performing those activities but
128 | which are not part of the work. For example, Corresponding Source
129 | includes interface definition files associated with source files for
130 | the work, and the source code for shared libraries and dynamically
131 | linked subprograms that the work is specifically designed to require,
132 | such as by intimate data communication or control flow between those
133 | subprograms and other parts of the work.
134 |
135 | The Corresponding Source need not include anything that users
136 | can regenerate automatically from other parts of the Corresponding
137 | Source.
138 |
139 | The Corresponding Source for a work in source code form is that
140 | same work.
141 |
142 | 2. Basic Permissions.
143 |
144 | All rights granted under this License are granted for the term of
145 | copyright on the Program, and are irrevocable provided the stated
146 | conditions are met. This License explicitly affirms your unlimited
147 | permission to run the unmodified Program. The output from running a
148 | covered work is covered by this License only if the output, given its
149 | content, constitutes a covered work. This License acknowledges your
150 | rights of fair use or other equivalent, as provided by copyright law.
151 |
152 | You may make, run and propagate covered works that you do not
153 | convey, without conditions so long as your license otherwise remains
154 | in force. You may convey covered works to others for the sole purpose
155 | of having them make modifications exclusively for you, or provide you
156 | with facilities for running those works, provided that you comply with
157 | the terms of this License in conveying all material for which you do
158 | not control copyright. Those thus making or running the covered works
159 | for you must do so exclusively on your behalf, under your direction
160 | and control, on terms that prohibit them from making any copies of
161 | your copyrighted material outside their relationship with you.
162 |
163 | Conveying under any other circumstances is permitted solely under
164 | the conditions stated below. Sublicensing is not allowed; section 10
165 | makes it unnecessary.
166 |
167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
168 |
169 | No covered work shall be deemed part of an effective technological
170 | measure under any applicable law fulfilling obligations under article
171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
172 | similar laws prohibiting or restricting circumvention of such
173 | measures.
174 |
175 | When you convey a covered work, you waive any legal power to forbid
176 | circumvention of technological measures to the extent such circumvention
177 | is effected by exercising rights under this License with respect to
178 | the covered work, and you disclaim any intention to limit operation or
179 | modification of the work as a means of enforcing, against the work's
180 | users, your or third parties' legal rights to forbid circumvention of
181 | technological measures.
182 |
183 | 4. Conveying Verbatim Copies.
184 |
185 | You may convey verbatim copies of the Program's source code as you
186 | receive it, in any medium, provided that you conspicuously and
187 | appropriately publish on each copy an appropriate copyright notice;
188 | keep intact all notices stating that this License and any
189 | non-permissive terms added in accord with section 7 apply to the code;
190 | keep intact all notices of the absence of any warranty; and give all
191 | recipients a copy of this License along with the Program.
192 |
193 | You may charge any price or no price for each copy that you convey,
194 | and you may offer support or warranty protection for a fee.
195 |
196 | 5. Conveying Modified Source Versions.
197 |
198 | You may convey a work based on the Program, or the modifications to
199 | produce it from the Program, in the form of source code under the
200 | terms of section 4, provided that you also meet all of these conditions:
201 |
202 | a) The work must carry prominent notices stating that you modified
203 | it, and giving a relevant date.
204 |
205 | b) The work must carry prominent notices stating that it is
206 | released under this License and any conditions added under section
207 | 7. This requirement modifies the requirement in section 4 to
208 | "keep intact all notices".
209 |
210 | c) You must license the entire work, as a whole, under this
211 | License to anyone who comes into possession of a copy. This
212 | License will therefore apply, along with any applicable section 7
213 | additional terms, to the whole of the work, and all its parts,
214 | regardless of how they are packaged. This License gives no
215 | permission to license the work in any other way, but it does not
216 | invalidate such permission if you have separately received it.
217 |
218 | d) If the work has interactive user interfaces, each must display
219 | Appropriate Legal Notices; however, if the Program has interactive
220 | interfaces that do not display Appropriate Legal Notices, your
221 | work need not make them do so.
222 |
223 | A compilation of a covered work with other separate and independent
224 | works, which are not by their nature extensions of the covered work,
225 | and which are not combined with it such as to form a larger program,
226 | in or on a volume of a storage or distribution medium, is called an
227 | "aggregate" if the compilation and its resulting copyright are not
228 | used to limit the access or legal rights of the compilation's users
229 | beyond what the individual works permit. Inclusion of a covered work
230 | in an aggregate does not cause this License to apply to the other
231 | parts of the aggregate.
232 |
233 | 6. Conveying Non-Source Forms.
234 |
235 | You may convey a covered work in object code form under the terms
236 | of sections 4 and 5, provided that you also convey the
237 | machine-readable Corresponding Source under the terms of this License,
238 | in one of these ways:
239 |
240 | a) Convey the object code in, or embodied in, a physical product
241 | (including a physical distribution medium), accompanied by the
242 | Corresponding Source fixed on a durable physical medium
243 | customarily used for software interchange.
244 |
245 | b) Convey the object code in, or embodied in, a physical product
246 | (including a physical distribution medium), accompanied by a
247 | written offer, valid for at least three years and valid for as
248 | long as you offer spare parts or customer support for that product
249 | model, to give anyone who possesses the object code either (1) a
250 | copy of the Corresponding Source for all the software in the
251 | product that is covered by this License, on a durable physical
252 | medium customarily used for software interchange, for a price no
253 | more than your reasonable cost of physically performing this
254 | conveying of source, or (2) access to copy the
255 | Corresponding Source from a network server at no charge.
256 |
257 | c) Convey individual copies of the object code with a copy of the
258 | written offer to provide the Corresponding Source. This
259 | alternative is allowed only occasionally and noncommercially, and
260 | only if you received the object code with such an offer, in accord
261 | with subsection 6b.
262 |
263 | d) Convey the object code by offering access from a designated
264 | place (gratis or for a charge), and offer equivalent access to the
265 | Corresponding Source in the same way through the same place at no
266 | further charge. You need not require recipients to copy the
267 | Corresponding Source along with the object code. If the place to
268 | copy the object code is a network server, the Corresponding Source
269 | may be on a different server (operated by you or a third party)
270 | that supports equivalent copying facilities, provided you maintain
271 | clear directions next to the object code saying where to find the
272 | Corresponding Source. Regardless of what server hosts the
273 | Corresponding Source, you remain obligated to ensure that it is
274 | available for as long as needed to satisfy these requirements.
275 |
276 | e) Convey the object code using peer-to-peer transmission, provided
277 | you inform other peers where the object code and Corresponding
278 | Source of the work are being offered to the general public at no
279 | charge under subsection 6d.
280 |
281 | A separable portion of the object code, whose source code is excluded
282 | from the Corresponding Source as a System Library, need not be
283 | included in conveying the object code work.
284 |
285 | A "User Product" is either (1) a "consumer product", which means any
286 | tangible personal property which is normally used for personal, family,
287 | or household purposes, or (2) anything designed or sold for incorporation
288 | into a dwelling. In determining whether a product is a consumer product,
289 | doubtful cases shall be resolved in favor of coverage. For a particular
290 | product received by a particular user, "normally used" refers to a
291 | typical or common use of that class of product, regardless of the status
292 | of the particular user or of the way in which the particular user
293 | actually uses, or expects or is expected to use, the product. A product
294 | is a consumer product regardless of whether the product has substantial
295 | commercial, industrial or non-consumer uses, unless such uses represent
296 | the only significant mode of use of the product.
297 |
298 | "Installation Information" for a User Product means any methods,
299 | procedures, authorization keys, or other information required to install
300 | and execute modified versions of a covered work in that User Product from
301 | a modified version of its Corresponding Source. The information must
302 | suffice to ensure that the continued functioning of the modified object
303 | code is in no case prevented or interfered with solely because
304 | modification has been made.
305 |
306 | If you convey an object code work under this section in, or with, or
307 | specifically for use in, a User Product, and the conveying occurs as
308 | part of a transaction in which the right of possession and use of the
309 | User Product is transferred to the recipient in perpetuity or for a
310 | fixed term (regardless of how the transaction is characterized), the
311 | Corresponding Source conveyed under this section must be accompanied
312 | by the Installation Information. But this requirement does not apply
313 | if neither you nor any third party retains the ability to install
314 | modified object code on the User Product (for example, the work has
315 | been installed in ROM).
316 |
317 | The requirement to provide Installation Information does not include a
318 | requirement to continue to provide support service, warranty, or updates
319 | for a work that has been modified or installed by the recipient, or for
320 | the User Product in which it has been modified or installed. Access to a
321 | network may be denied when the modification itself materially and
322 | adversely affects the operation of the network or violates the rules and
323 | protocols for communication across the network.
324 |
325 | Corresponding Source conveyed, and Installation Information provided,
326 | in accord with this section must be in a format that is publicly
327 | documented (and with an implementation available to the public in
328 | source code form), and must require no special password or key for
329 | unpacking, reading or copying.
330 |
331 | 7. Additional Terms.
332 |
333 | "Additional permissions" are terms that supplement the terms of this
334 | License by making exceptions from one or more of its conditions.
335 | Additional permissions that are applicable to the entire Program shall
336 | be treated as though they were included in this License, to the extent
337 | that they are valid under applicable law. If additional permissions
338 | apply only to part of the Program, that part may be used separately
339 | under those permissions, but the entire Program remains governed by
340 | this License without regard to the additional permissions.
341 |
342 | When you convey a copy of a covered work, you may at your option
343 | remove any additional permissions from that copy, or from any part of
344 | it. (Additional permissions may be written to require their own
345 | removal in certain cases when you modify the work.) You may place
346 | additional permissions on material, added by you to a covered work,
347 | for which you have or can give appropriate copyright permission.
348 |
349 | Notwithstanding any other provision of this License, for material you
350 | add to a covered work, you may (if authorized by the copyright holders of
351 | that material) supplement the terms of this License with terms:
352 |
353 | a) Disclaiming warranty or limiting liability differently from the
354 | terms of sections 15 and 16 of this License; or
355 |
356 | b) Requiring preservation of specified reasonable legal notices or
357 | author attributions in that material or in the Appropriate Legal
358 | Notices displayed by works containing it; or
359 |
360 | c) Prohibiting misrepresentation of the origin of that material, or
361 | requiring that modified versions of such material be marked in
362 | reasonable ways as different from the original version; or
363 |
364 | d) Limiting the use for publicity purposes of names of licensors or
365 | authors of the material; or
366 |
367 | e) Declining to grant rights under trademark law for use of some
368 | trade names, trademarks, or service marks; or
369 |
370 | f) Requiring indemnification of licensors and authors of that
371 | material by anyone who conveys the material (or modified versions of
372 | it) with contractual assumptions of liability to the recipient, for
373 | any liability that these contractual assumptions directly impose on
374 | those licensors and authors.
375 |
376 | All other non-permissive additional terms are considered "further
377 | restrictions" within the meaning of section 10. If the Program as you
378 | received it, or any part of it, contains a notice stating that it is
379 | governed by this License along with a term that is a further
380 | restriction, you may remove that term. If a license document contains
381 | a further restriction but permits relicensing or conveying under this
382 | License, you may add to a covered work material governed by the terms
383 | of that license document, provided that the further restriction does
384 | not survive such relicensing or conveying.
385 |
386 | If you add terms to a covered work in accord with this section, you
387 | must place, in the relevant source files, a statement of the
388 | additional terms that apply to those files, or a notice indicating
389 | where to find the applicable terms.
390 |
391 | Additional terms, permissive or non-permissive, may be stated in the
392 | form of a separately written license, or stated as exceptions;
393 | the above requirements apply either way.
394 |
395 | 8. Termination.
396 |
397 | You may not propagate or modify a covered work except as expressly
398 | provided under this License. Any attempt otherwise to propagate or
399 | modify it is void, and will automatically terminate your rights under
400 | this License (including any patent licenses granted under the third
401 | paragraph of section 11).
402 |
403 | However, if you cease all violation of this License, then your
404 | license from a particular copyright holder is reinstated (a)
405 | provisionally, unless and until the copyright holder explicitly and
406 | finally terminates your license, and (b) permanently, if the copyright
407 | holder fails to notify you of the violation by some reasonable means
408 | prior to 60 days after the cessation.
409 |
410 | Moreover, your license from a particular copyright holder is
411 | reinstated permanently if the copyright holder notifies you of the
412 | violation by some reasonable means, this is the first time you have
413 | received notice of violation of this License (for any work) from that
414 | copyright holder, and you cure the violation prior to 30 days after
415 | your receipt of the notice.
416 |
417 | Termination of your rights under this section does not terminate the
418 | licenses of parties who have received copies or rights from you under
419 | this License. If your rights have been terminated and not permanently
420 | reinstated, you do not qualify to receive new licenses for the same
421 | material under section 10.
422 |
423 | 9. Acceptance Not Required for Having Copies.
424 |
425 | You are not required to accept this License in order to receive or
426 | run a copy of the Program. Ancillary propagation of a covered work
427 | occurring solely as a consequence of using peer-to-peer transmission
428 | to receive a copy likewise does not require acceptance. However,
429 | nothing other than this License grants you permission to propagate or
430 | modify any covered work. These actions infringe copyright if you do
431 | not accept this License. Therefore, by modifying or propagating a
432 | covered work, you indicate your acceptance of this License to do so.
433 |
434 | 10. Automatic Licensing of Downstream Recipients.
435 |
436 | Each time you convey a covered work, the recipient automatically
437 | receives a license from the original licensors, to run, modify and
438 | propagate that work, subject to this License. You are not responsible
439 | for enforcing compliance by third parties with this License.
440 |
441 | An "entity transaction" is a transaction transferring control of an
442 | organization, or substantially all assets of one, or subdividing an
443 | organization, or merging organizations. If propagation of a covered
444 | work results from an entity transaction, each party to that
445 | transaction who receives a copy of the work also receives whatever
446 | licenses to the work the party's predecessor in interest had or could
447 | give under the previous paragraph, plus a right to possession of the
448 | Corresponding Source of the work from the predecessor in interest, if
449 | the predecessor has it or can get it with reasonable efforts.
450 |
451 | You may not impose any further restrictions on the exercise of the
452 | rights granted or affirmed under this License. For example, you may
453 | not impose a license fee, royalty, or other charge for exercise of
454 | rights granted under this License, and you may not initiate litigation
455 | (including a cross-claim or counterclaim in a lawsuit) alleging that
456 | any patent claim is infringed by making, using, selling, offering for
457 | sale, or importing the Program or any portion of it.
458 |
459 | 11. Patents.
460 |
461 | A "contributor" is a copyright holder who authorizes use under this
462 | License of the Program or a work on which the Program is based. The
463 | work thus licensed is called the contributor's "contributor version".
464 |
465 | A contributor's "essential patent claims" are all patent claims
466 | owned or controlled by the contributor, whether already acquired or
467 | hereafter acquired, that would be infringed by some manner, permitted
468 | by this License, of making, using, or selling its contributor version,
469 | but do not include claims that would be infringed only as a
470 | consequence of further modification of the contributor version. For
471 | purposes of this definition, "control" includes the right to grant
472 | patent sublicenses in a manner consistent with the requirements of
473 | this License.
474 |
475 | Each contributor grants you a non-exclusive, worldwide, royalty-free
476 | patent license under the contributor's essential patent claims, to
477 | make, use, sell, offer for sale, import and otherwise run, modify and
478 | propagate the contents of its contributor version.
479 |
480 | In the following three paragraphs, a "patent license" is any express
481 | agreement or commitment, however denominated, not to enforce a patent
482 | (such as an express permission to practice a patent or covenant not to
483 | sue for patent infringement). To "grant" such a patent license to a
484 | party means to make such an agreement or commitment not to enforce a
485 | patent against the party.
486 |
487 | If you convey a covered work, knowingly relying on a patent license,
488 | and the Corresponding Source of the work is not available for anyone
489 | to copy, free of charge and under the terms of this License, through a
490 | publicly available network server or other readily accessible means,
491 | then you must either (1) cause the Corresponding Source to be so
492 | available, or (2) arrange to deprive yourself of the benefit of the
493 | patent license for this particular work, or (3) arrange, in a manner
494 | consistent with the requirements of this License, to extend the patent
495 | license to downstream recipients. "Knowingly relying" means you have
496 | actual knowledge that, but for the patent license, your conveying the
497 | covered work in a country, or your recipient's use of the covered work
498 | in a country, would infringe one or more identifiable patents in that
499 | country that you have reason to believe are valid.
500 |
501 | If, pursuant to or in connection with a single transaction or
502 | arrangement, you convey, or propagate by procuring conveyance of, a
503 | covered work, and grant a patent license to some of the parties
504 | receiving the covered work authorizing them to use, propagate, modify
505 | or convey a specific copy of the covered work, then the patent license
506 | you grant is automatically extended to all recipients of the covered
507 | work and works based on it.
508 |
509 | A patent license is "discriminatory" if it does not include within
510 | the scope of its coverage, prohibits the exercise of, or is
511 | conditioned on the non-exercise of one or more of the rights that are
512 | specifically granted under this License. You may not convey a covered
513 | work if you are a party to an arrangement with a third party that is
514 | in the business of distributing software, under which you make payment
515 | to the third party based on the extent of your activity of conveying
516 | the work, and under which the third party grants, to any of the
517 | parties who would receive the covered work from you, a discriminatory
518 | patent license (a) in connection with copies of the covered work
519 | conveyed by you (or copies made from those copies), or (b) primarily
520 | for and in connection with specific products or compilations that
521 | contain the covered work, unless you entered into that arrangement,
522 | or that patent license was granted, prior to 28 March 2007.
523 |
524 | Nothing in this License shall be construed as excluding or limiting
525 | any implied license or other defenses to infringement that may
526 | otherwise be available to you under applicable patent law.
527 |
528 | 12. No Surrender of Others' Freedom.
529 |
530 | If conditions are imposed on you (whether by court order, agreement or
531 | otherwise) that contradict the conditions of this License, they do not
532 | excuse you from the conditions of this License. If you cannot convey a
533 | covered work so as to satisfy simultaneously your obligations under this
534 | License and any other pertinent obligations, then as a consequence you may
535 | not convey it at all. For example, if you agree to terms that obligate you
536 | to collect a royalty for further conveying from those to whom you convey
537 | the Program, the only way you could satisfy both those terms and this
538 | License would be to refrain entirely from conveying the Program.
539 |
540 | 13. Remote Network Interaction; Use with the GNU General Public License.
541 |
542 | Notwithstanding any other provision of this License, if you modify the
543 | Program, your modified version must prominently offer all users
544 | interacting with it remotely through a computer network (if your version
545 | supports such interaction) an opportunity to receive the Corresponding
546 | Source of your version by providing access to the Corresponding Source
547 | from a network server at no charge, through some standard or customary
548 | means of facilitating copying of software. This Corresponding Source
549 | shall include the Corresponding Source for any work covered by version 3
550 | of the GNU General Public License that is incorporated pursuant to the
551 | following paragraph.
552 |
553 | Notwithstanding any other provision of this License, you have
554 | permission to link or combine any covered work with a work licensed
555 | under version 3 of the GNU General Public License into a single
556 | combined work, and to convey the resulting work. The terms of this
557 | License will continue to apply to the part which is the covered work,
558 | but the work with which it is combined will remain governed by version
559 | 3 of the GNU General Public License.
560 |
561 | 14. Revised Versions of this License.
562 |
563 | The Free Software Foundation may publish revised and/or new versions of
564 | the GNU Affero General Public License from time to time. Such new versions
565 | will be similar in spirit to the present version, but may differ in detail to
566 | address new problems or concerns.
567 |
568 | Each version is given a distinguishing version number. If the
569 | Program specifies that a certain numbered version of the GNU Affero General
570 | Public License "or any later version" applies to it, you have the
571 | option of following the terms and conditions either of that numbered
572 | version or of any later version published by the Free Software
573 | Foundation. If the Program does not specify a version number of the
574 | GNU Affero General Public License, you may choose any version ever published
575 | by the Free Software Foundation.
576 |
577 | If the Program specifies that a proxy can decide which future
578 | versions of the GNU Affero General Public License can be used, that proxy's
579 | public statement of acceptance of a version permanently authorizes you
580 | to choose that version for the Program.
581 |
582 | Later license versions may give you additional or different
583 | permissions. However, no additional obligations are imposed on any
584 | author or copyright holder as a result of your choosing to follow a
585 | later version.
586 |
587 | 15. Disclaimer of Warranty.
588 |
589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
597 |
598 | 16. Limitation of Liability.
599 |
600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
608 | SUCH DAMAGES.
609 |
610 | 17. Interpretation of Sections 15 and 16.
611 |
612 | If the disclaimer of warranty and limitation of liability provided
613 | above cannot be given local legal effect according to their terms,
614 | reviewing courts shall apply local law that most closely approximates
615 | an absolute waiver of all civil liability in connection with the
616 | Program, unless a warranty or assumption of liability accompanies a
617 | copy of the Program in return for a fee.
618 |
619 | END OF TERMS AND CONDITIONS
620 |
621 | How to Apply These Terms to Your New Programs
622 |
623 | If you develop a new program, and you want it to be of the greatest
624 | possible use to the public, the best way to achieve this is to make it
625 | free software which everyone can redistribute and change under these terms.
626 |
627 | To do so, attach the following notices to the program. It is safest
628 | to attach them to the start of each source file to most effectively
629 | state the exclusion of warranty; and each file should have at least
630 | the "copyright" line and a pointer to where the full notice is found.
631 |
632 |
633 | Copyright (C)
634 |
635 | This program is free software: you can redistribute it and/or modify
636 | it under the terms of the GNU Affero General Public License as published
637 | by the Free Software Foundation, either version 3 of the License, or
638 | (at your option) any later version.
639 |
640 | This program is distributed in the hope that it will be useful,
641 | but WITHOUT ANY WARRANTY; without even the implied warranty of
642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
643 | GNU Affero General Public License for more details.
644 |
645 | You should have received a copy of the GNU Affero General Public License
646 | along with this program. If not, see .
647 |
648 | Also add information on how to contact you by electronic and paper mail.
649 |
650 | If your software can interact with users remotely through a computer
651 | network, you should also make sure that it provides a way for users to
652 | get its source. For example, if your program is a web application, its
653 | interface could display a "Source" link that leads users to an archive
654 | of the code. There are many ways you could offer source, and different
655 | solutions will be better for different programs; see section 13 for the
656 | specific requirements.
657 |
658 | You should also get your employer (if you work as a programmer) or school,
659 | if any, to sign a "copyright disclaimer" for the program, if necessary.
660 | For more information on this, and how to apply and follow the GNU AGPL, see
661 | .
662 |
--------------------------------------------------------------------------------