{"type":"doc","content":[{"type":"heading","attrs":{"level":4},"content":[{"text":"Server-side setup:","type":"text"}]},{"type":"paragraph","content":[{"text":"Please refer “Setting up the Server” section from ","type":"text"},{"text":"README.md","type":"text","marks":[{"type":"link","attrs":{"href":"http://README.md"}}]},{"text":" file present at ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://github.com/sondehealth-samples/score"}},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"Before going to through client-side integration we are considering that you have done with server-side setup.","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Integration steps for Android :","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Step-1 : Get Access token (Authentication Token)","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"paragraph","content":[{"text":"The first step to integrate the sonde services into your mobile app is to get the access token which will authenticate your further requests made from app to Sonde services. To know how to get the access token from Sonde services at backend you can refer this link ","type":"text"},{"text":"Respiratory Symptoms Risk (variant: V2)","type":"text","marks":[{"type":"link","attrs":{"__confluenceMetadata":{"spaceKey":"SA","isRenamedTitle":true,"linkType":"page","contentTitle":"Respiratory Symptoms Risk (variant: V2)","versionAtSave":"16"},"href":"/wiki/spaces/SA/pages/2706833413"}}]},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"Below code snipped you can refer to get access token from your backend. ","type":"text"}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":" private void getAccessToken(String apiUrl) {\n BackendApi backendApi = RetrofitClientInstance.getRetrofitInstance().create(BackendApi.class);\n Call call = backendApi.getAuthToken(apiUrl);\n call.enqueue(new Callback() {\n @Override\n public void onResponse(Call call, Response response) {\n Log.i(TAG, \"AccessToken Response : \" + response.toString());\n AccessTokenResponse accessTokenResponse = response.body();\n if (accessTokenResponse != null) {\n Log.i(TAG, \"AccessToken is : \" + accessTokenResponse.getAccessToken());\n // use this accessToken for further apis call\n String accessToken = accessTokenResponse.getAccessToken();\n } else {\n Log.e(TAG, \"error: code \" + response.code());\n }\n }\n\n @Override\n public void onFailure(Call call, Throwable t) {\n Log.e(TAG, \"error: \" + t);\n }\n });\n }","type":"text"}]},{"type":"paragraph","content":[{"text":"Here apiUrl should be your backend api url to get access token","type":"text"}]},{"type":"paragraph","content":[{"text":" e.g. apiUrl=","type":"text"},{"text":"https://YOUR_BACKEND/authToken","type":"text","marks":[{"type":"link","attrs":{"href":"https://YOUR_BACKEND/authToken"}}]},{"text":" (Please note that this url should not be Sonde APIs end point)","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"},{"text":"onResponse","type":"text","marks":[{"type":"code"}]},{"text":": Callback method where you will get access token. You should store this received token in secure place, as this token will be used for further request to Sonde. Please note that this access token is only valid for certain time (1 hour), so its your responsibility to re-fetch the token after expiry.","type":"text"}]},{"type":"paragraph","content":[{"text":"onFailure","type":"text","marks":[{"type":"code"}]},{"text":" : Callback method for failure case","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Step-2 : Register User","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"paragraph","content":[{"text":"In this step you have to register user to Sonde platform but this registration should be done through your backend. So you have to call your backend api to register user. You can refer below code snippet to register user.","type":"text"}]},{"type":"paragraph"},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":" private void registerUser(String apiUrl) {\n SignUpRequest signUpRequest = new SignUpRequest(\"1985\", \"MALE\", \"ENGLISH\");\n BackendApi backendApi = RetrofitClientInstance.getRetrofitInstance().create(BackendApi.class);\n Call call = backendApi.signUpUser(apiUrl, signUpRequest);\n call.enqueue(new Callback() {\n @Override\n public void onResponse(Call call, Response response) {\n SignUpResponse signUpResponse = response.body();\n if (signUpResponse != null) {\n // use this userIdentifier to calculate score for wav file\n String userIdentifier = signUpResponse.getUserIdentifier();\n } else {\n Log.e(TAG, \"error: code \" + response.code());\n }\n }\n\n @Override\n public void onFailure(Call call, Throwable t) {\n Log.e(TAG, \"error: \" + t);\n }\n });\n }","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Step-3 : Get list of measures","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"paragraph","content":[{"text":"In this step you have to get list of all the accessible measures. Any measure from the list can be used to get score for an audio (wav) file. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Request -","type":"text"}]},{"type":"paragraph","content":[{"text":"URL : ","type":"text"},{"text":"SONDE_API_BASE_URL/measures","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"Method : GET","type":"text"}]},{"type":"paragraph","content":[{"text":"Headers : ","type":"text"},{"text":"Authorization","type":"text","marks":[{"type":"strong"}]},{"text":" - ","type":"text"}]},{"type":"paragraph","content":[{"text":"Response : List of measures","type":"text"}]},{"type":"paragraph","content":[{"text":"Below snipped can be refer to get measures lists","type":"text"}]},{"type":"paragraph"},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"private void getMeasures() {\n BackendApi backendApi = RetrofitClientInstance.getRetrofitInstance().create(BackendApi.class);\n Call call = backendApi.getMeasures(accessToken);\n call.enqueue(new Callback() {\n @Override\n public void onResponse(Call call, Response response) {\n MeasureResponse measureResponse = response.body();\n if (measureResponse != null) {\n measureList = measureResponse.getMeasures();\n } else {\n Log.e(TAG, \"error: code \" + response.code());\n }\n }\n\n @Override\n public void onFailure(Call call, Throwable t) {\n Log.e(TAG, \"error: \" + t);\n }\n });\n }","type":"text"}]},{"type":"paragraph"},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Step-4 : Record audio file (wav file)","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"paragraph","content":[{"text":"In step-4 you have to record the audio file (wav file). Please note the currently Sonde only accepts the wav file format, other audio format like MP3, 3GP are not supported. ","type":"text"}]},{"type":"paragraph","content":[{"text":"You can record a audio file in following steps :","type":"text"}]},{"type":"paragraph","content":[{"text":"i). Request for microphone permission :","type":"text"}]},{"type":"paragraph","content":[{"text":"To record an audio, you must request for microphone permission on android 6 and above. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Add the permission in manifest ","type":"text"}]},{"type":"paragraph","content":[{"text":"","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Below code snippet you can refer to request for microphone permission. ","type":"text"}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":" private void requestAudioPermissions() {\n if (ContextCompat.checkSelfPermission(this, Manifest.permission.RECORD_AUDIO) != PackageManager.PERMISSION_GRANTED) {\n\n //When permission is not granted by user, show them message why this permission is needed.\n if (ActivityCompat.shouldShowRequestPermissionRationale(this, Manifest.permission.RECORD_AUDIO)) {\n Toast.makeText(this, \"Please grant permissions to record audio\", Toast.LENGTH_LONG).show();\n ActivityCompat.requestPermissions(this, new String[]{Manifest.permission.RECORD_AUDIO}, PERMISSIONS_RECORD_AUDIO);\n\n } else {\n // Show user dialog to grant permission to record audio\n ActivityCompat.requestPermissions(this, new String[]{Manifest.permission.RECORD_AUDIO}, PERMISSIONS_RECORD_AUDIO);\n }\n }\n //If permission is granted, then go ahead for recording audio\n else if (ContextCompat.checkSelfPermission(this,\n Manifest.permission.RECORD_AUDIO)\n == PackageManager.PERMISSION_GRANTED) {\n // start Recording audio;\n }\n }","type":"text"}]},{"type":"paragraph","content":[{"text":"ii). Start recording of audio : ","type":"text"}]},{"type":"paragraph","content":[{"text":"Below snipped you can refer to start recording of audio and writing it to a file. ","type":"text"}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":"// starts recording a file at internal memory\n private void startRecording() {\n mAudioRecord = new AudioRecord(AUDIO_SOURCE, SAMPLE_RATE_HZ, AUDIO_CHANNEL_CONFIG, AUDIO_FORMAT, AUDIO_BUFFER_SIZE_BYTES);\n mAudioRecord.startRecording();\n mFilePath = getFilesDir().getAbsolutePath() + \"/\" + System.currentTimeMillis() + \".wav\";\n recording = true;\n new Thread(new Runnable() {\n @Override\n public void run() {\n writeAudioDataToFile(mFilePath);\n }\n }).start();\n }\n \n private void writeAudioDataToFile(String filename) {\n String audioFilename = filename + \".pcm\";\n OutputStream outputStream = null;\n try {\n outputStream = new FileOutputStream(audioFilename);\n int bufferSizeBytes = AUDIO_BUFFER_SIZE_BYTES;\n short[] audioBuffer = new short[bufferSizeBytes / 2]; // assumes 16-bit encoding\n byte[] outputBuffer = new byte[bufferSizeBytes];\n int totalBytesRead = 0;\n while (recording) {\n int numShortsRead = mAudioRecord.read(audioBuffer, 0, audioBuffer.length);\n\n for (int i = 0; i < numShortsRead; i++) {\n outputBuffer[i * 2] = (byte) (audioBuffer[i] & 0x00FF);\n outputBuffer[i * 2 + 1] = (byte) (audioBuffer[i] >> 8);\n audioBuffer[i] = 0;\n }\n\n int numBytesRead = numShortsRead * 2;\n totalBytesRead += numBytesRead;\n outputStream.write(outputBuffer, 0, numBytesRead);\n }\n\n OutputStream waveOutputStream = new FileOutputStream(mFilePath);\n InputStream dataInputStream = new FileInputStream(audioFilename);\n short numChannels = 1;\n short sampleSizeBytes = 2;\n //convert pcm to wav file\n WaveUtils.pcmToWave(waveOutputStream, dataInputStream, totalBytesRead, numChannels, SAMPLE_RATE_HZ, sampleSizeBytes);\n } catch (Exception e) {\n Log.e(TAG, \"Error : \" + e);\n }finally {\n try {\n if (outputStream != null) {\n outputStream.close();\n }\n } catch (IOException e) {\n Log.e(TAG, \"Error : \" + e);\n }\n try {\n if (mAudioRecord != null) {\n mAudioRecord.stop();\n mAudioRecord.release();\n mAudioRecord = null;\n }\n } catch (IllegalStateException e) {\n Log.e(TAG, \"Error : \" + e);\n }\n // delete PCM file\n File file = new File(audioFilename);\n file.delete();\n }\n }","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Step-5 : Get S3 signed url to upload wav file","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"paragraph","content":[{"text":"After recording audio/wav file, the next step is to get the S3 signed url to upload the wav file. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Request -","type":"text"}]},{"type":"paragraph","content":[{"text":"URL : ","type":"text"},{"text":"SONDE_API_BASE_URL/storage/files","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"Method : POST","type":"text"}]},{"type":"paragraph","content":[{"text":"Headers : ","type":"text"},{"text":"Authorization - ","type":"text","marks":[{"type":"strong"}]},{"text":"","type":"text"}]},{"type":"paragraph","content":[{"text":"Response : S3 signed url and file location","type":"text"}]},{"type":"paragraph","content":[{"text":"You can refer below snippet to get S3 signed url and file location. ","type":"text"}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":" private void getS3SignedUrl( {\n BackendApi backendApi = RetrofitClientInstance.getRetrofitInstance().create(BackendApi.class);\n String countryCode = \"IN\"; //Use your country code\n Call call = backendApi.getS3FilePath(accessToken, new S3FilePathRequest(\"wav\", countryCode, userIdentifier));\n call.enqueue(new Callback() {\n @Override\n public void onResponse(Call call, Response response) {\n S3PathResponse s3PathResponse = response.body();\n if (s3PathResponse != null) {\n String s3FilePath = s3PathResponse.getSignedURL();\n //use the received signed url to upload wav file\n } else {\n Log.e(TAG, \"error: code \" + response.code());\n }\n }\n\n @Override\n public void onFailure(Call call, Throwable t) {\n Log.e(TAG, \"error: \" + t);\n }\n });\n }","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Step-6 : Upload wav file to S3","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"paragraph","content":[{"text":"Once you got the S3 signed url, next step is to upload wav file to S3 bucket. ","type":"text"}]},{"type":"paragraph","content":[{"text":"To know how to upload file to S3 bucket, you can refer below code snippet","type":"text"}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":" private void uploadFileToS3(final S3PathResponse s3PathResponse, final File filePath) {\n BackendApi backendApi = RetrofitClientInstance.getRetrofitInstance().create(BackendApi.class);\n MediaType MEDIA_TYPE_OCTET_STREAM = MediaType.parse(\"application/octet-stream\");\n String uploadUrl = s3PathResponse.getSignedURL();\n Call call = backendApi.uploadFileToS3(uploadUrl, RequestBody.create(MEDIA_TYPE_OCTET_STREAM, filePath));\n call.enqueue(new Callback() {\n @Override\n public void onResponse(Call call, Response response) {\n if (response.isSuccessful()) {\n Log.i(TAG, \" : File Uploaded successfully \" + filePath.getName());\n // request for measure score\n } else {\n Log.e(TAG, \" : Failed to upload file \" + filePath.getName() + \" Error code : \" + response.code());\n }\n }\n\n @Override\n public void onFailure(Call call, Throwable t) {\n Log.e(TAG, \" : Failed to upload file \" + filePath.getName() + \" Error: \" + t);\n }\n });\n }","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Step-7 : Request for score","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"paragraph","content":[{"text":"After successfully uploading the wav file, the last step requires you to request for measure score. ","type":"text"}]},{"type":"paragraph","content":[{"text":"To request for score you should use the below rest api : ","type":"text"}]},{"type":"paragraph","content":[{"text":"Request -","type":"text"}]},{"type":"paragraph","content":[{"text":"URL : ","type":"text"},{"text":"SONDE_API_BASE_URL/inference/scores","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]},{"type":"paragraph","content":[{"text":"Method : POST","type":"text"}]},{"type":"paragraph","content":[{"text":"Headers : ","type":"text"},{"text":"Authorization - ","type":"text","marks":[{"type":"strong"}]},{"text":"","type":"text"}]},{"type":"paragraph","content":[{"text":"Response : Measure score","type":"text"}]},{"type":"paragraph","content":[{"text":"You can refer below code snippet to request for measure score.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"java"},"content":[{"text":" private void requestForMeasureScore(String fileLocation, final String measureName, String userIdentifier) {\n Log.i(TAG, \" : fileLocation : \" + fileLocation);\n BackendApi backendApi = RetrofitClientInstance.getRetrofitInstance().create(BackendApi.class);\n Call call = backendApi.getInferenceScore(accessToken, new InferenceScoreRequest(fileLocation, measureName, userIdentifier));\n call.enqueue(new Callback() {\n @Override\n public void onResponse(Call call, Response response) {\n InferenceScoreResponse scoreResponse = response.body();\n if (scoreResponse != null) {\n //show calculated score for measure\n } else {\n Log.e(TAG, \" : Failed to get score , Error: \" + response.code());\n Toast.makeText(MainActivity.this, \"Could not calculate the score, please try again\", Toast.LENGTH_LONG).show();\n }\n }\n\n @Override\n public void onFailure(Call call, Throwable t) {\n Log.e(TAG, \" : Failed to get score , Error: \" + t);\n Toast.makeText(MainActivity.this, \"Could not calculate the score, please try again\", Toast.LENGTH_LONG).show();\n }\n });\n }","type":"text"}]},{"type":"paragraph"},{"type":"paragraph","content":[{"text":"For more information, please contact Sonde at ","type":"text"},{"text":"support@sondehealth.com","type":"text","marks":[{"type":"link","attrs":{"href":"mailto:support@sondehealth.com"}}]},{"text":". ","type":"text"}]},{"type":"paragraph"}],"version":1}

Browser not supported