How to obtain and upload audio Dump files?
2023-10-13
Products / Plugins:Video Call / Audio Call / Live streaming
Platform / Framework:iOS / Android / macOS / Windows / Linux / Flutter
During real-time calls, when audio anomalies occur, you can refer to this article to save and upload audio Dump data before and after processing to help locate audio-related issues, improve troubleshooting efficiency, and shorten integration time.
Operation Steps
The following uses Android platform API calls as an example; other platforms follow the same principle.
- After calling the createEngine interface, developers can obtain audio Dump files before and after streaming.
- Call startDumpData to start dumping audio data. In the ZegoDumpDataConfig parameter, configure the data type to be dumped as
Audio(currently only Audio is supported). The result of the interface call is returned through the onStartDumpData callback. - Call stopDumpData to stop dumping audio data. The result of the interface call is returned through the onStopDumpData callback. After the interface call is successful, the callback will return the directory path of the Dump file.
- Call uploadDumpData to upload the Dump data for this session. The result of the interface call is returned through the onUploadDumpData callback.
- Finally, you can use the removeDumpData interface to delete the audio dump data for this session.
Precautions
- Since audio Dump files are user privacy-sensitive data, when implementing this capability, developers must carefully read the content about "Using Audio Dump Function" in the ZEGOCLOUD Privacy Policy. Additionally, when collecting audio Dump files, please note the Express SDK collection purpose when obtaining user authorization and consent.
- Before uploading audio Dump data, the SDK will automatically check the Dump file size. If it exceeds 100 MB, the upload will fail. If the upload fails, developers can export the Dump file from the device and contact ZEGOCLOUD Technical Support for help.
- Audio Dump files can only retain the last 2-4 minutes of data during the dumping process.
