Signaling (previously RTM) SDK v1.5.0 API Reference for Android
Public Attributes | List of all members
io.agora.rtm.RtmStatusCode.DownloadMediaError Interface Reference

Public Attributes

int  DOWNLOAD_MEDIA_ERR_OK = 0
 
int  DOWNLOAD_MEDIA_ERR_FAILURE = 1
 
int  DOWNLOAD_MEDIA_ERR_INVALID_ARGUMENT = 2
 
int  DOWNLOAD_MEDIA_ERR_TIMEOUT = 3
 
int  DOWNLOAD_MEDIA_ERR_NOT_EXIST = 4
 
int  DOWNLOAD_MEDIA_ERR_CONCURRENCY_LIMIT_EXCEEDED = 5
 
int  DOWNLOAD_MEDIA_ERR_INTERRUPTED = 6
 
int  DOWNLOAD_MEDIA_ERR_NOT_INITIALIZED = 101
 
int  DOWNLOAD_MEDIA_ERR_NOT_LOGGED_IN = 102
 

Detailed Description

Error codes related to downloading a file or image.

Member Data Documentation

◆ DOWNLOAD_MEDIA_ERR_OK

int io.agora.rtm.RtmStatusCode.DownloadMediaError.DOWNLOAD_MEDIA_ERR_OK = 0

0: The method call succeeds, or the operation succeeds.

◆ DOWNLOAD_MEDIA_ERR_FAILURE

int io.agora.rtm.RtmStatusCode.DownloadMediaError.DOWNLOAD_MEDIA_ERR_FAILURE = 1

1: Unknown common failure. Check whether you have write access.

◆ DOWNLOAD_MEDIA_ERR_INVALID_ARGUMENT

int io.agora.rtm.RtmStatusCode.DownloadMediaError.DOWNLOAD_MEDIA_ERR_INVALID_ARGUMENT = 2

2: An argument you put is invalid. For example, mediaId is in the wrong format or filePath is set as null.

◆ DOWNLOAD_MEDIA_ERR_TIMEOUT

int io.agora.rtm.RtmStatusCode.DownloadMediaError.DOWNLOAD_MEDIA_ERR_TIMEOUT = 3

3: A timeout occurs. The current timeout is set as 120 seconds. The SDK assumes that a timeout occurs if it has not detected any file transmission between the SDK and the file server for 120 seconds.

◆ DOWNLOAD_MEDIA_ERR_NOT_EXIST

int io.agora.rtm.RtmStatusCode.DownloadMediaError.DOWNLOAD_MEDIA_ERR_NOT_EXIST = 4

4: The file or image to download does not exist, either because the media ID you input is incorrect or because the validity of the media ID has expired.

◆ DOWNLOAD_MEDIA_ERR_CONCURRENCY_LIMIT_EXCEEDED

int io.agora.rtm.RtmStatusCode.DownloadMediaError.DOWNLOAD_MEDIA_ERR_CONCURRENCY_LIMIT_EXCEEDED = 5

5: You have exceeded the upper limit for file download. You can initiate a maximum of nine file download or upload tasks at the same time (download and upload tasks count together).

◆ DOWNLOAD_MEDIA_ERR_INTERRUPTED

int io.agora.rtm.RtmStatusCode.DownloadMediaError.DOWNLOAD_MEDIA_ERR_INTERRUPTED = 6

6: The file or image download task is aborted for either of the following reasons:

  • The user is in the CONNECTION_STATE_ABORTED state.
  • The user has cancelled the download task.

◆ DOWNLOAD_MEDIA_ERR_NOT_INITIALIZED

int io.agora.rtm.RtmStatusCode.DownloadMediaError.DOWNLOAD_MEDIA_ERR_NOT_INITIALIZED = 101

101: RtmClient is not initialized.

◆ DOWNLOAD_MEDIA_ERR_NOT_LOGGED_IN

int io.agora.rtm.RtmStatusCode.DownloadMediaError.DOWNLOAD_MEDIA_ERR_NOT_LOGGED_IN = 102

102: The user does not call the login method, or the method call of login does not succeed before this operation.