Signaling (previously RTM) v1.4.8 API Reference for Unity
Classes | Namespaces | Enumerations
RtmBase.cs File Reference

Classes

struct  agora_rtm.PeerOnlineStatus
 
struct  agora_rtm.MediaOperationProgress
 
struct  agora_rtm.ChannelAttributeOptions
 
struct  agora_rtm.RtmAttribute
 
struct  agora_rtm.ChannelMemberCount
 
struct  agora_rtm.SendMessageOptions
 

Namespaces

namespace  agora_rtm
 

Enumerations

enum class  agora_rtm.COMMON_ERR_CODE { agora_rtm.ERROR_NULL_PTR = -7 }
 
enum class  agora_rtm.LOGIN_ERR_CODE {
  agora_rtm.LOGIN_ERR_OK = 0 , agora_rtm.LOGIN_ERR_UNKNOWN = 1 , agora_rtm.LOGIN_ERR_REJECTED = 2 , agora_rtm.LOGIN_ERR_INVALID_ARGUMENT = 3 ,
  agora_rtm.LOGIN_ERR_INVALID_APP_ID = 4 , agora_rtm.LOGIN_ERR_INVALID_TOKEN = 5 , agora_rtm.LOGIN_ERR_TOKEN_EXPIRED = 6 , agora_rtm.LOGIN_ERR_NOT_AUTHORIZED = 7 ,
  agora_rtm.LOGIN_ERR_ALREADY_LOGGED_IN = 8 , agora_rtm.LOGIN_ERR_TIMEOUT = 9 , agora_rtm.LOGIN_ERR_TOO_OFTEN = 10
}
 
enum class  agora_rtm.LOGOUT_ERR_CODE { agora_rtm.LOGOUT_ERR_OK = 0 , agora_rtm.LOGOUT_ERR_REJECTED = 1 , agora_rtm.LOGOUT_ERR_USER_NOT_LOGGED_IN = 102 }
 
enum class  agora_rtm.RENEW_TOKEN_ERR_CODE {
  agora_rtm.RENEW_TOKEN_ERR_OK = 0 , agora_rtm.RENEW_TOKEN_ERR_FAILURE = 1 , agora_rtm.RENEW_TOKEN_ERR_INVALID_ARGUMENT = 2 , agora_rtm.RENEW_TOKEN_ERR_REJECTED = 3 ,
  agora_rtm.RENEW_TOKEN_ERR_TOO_OFTEN = 4 , agora_rtm.RENEW_TOKEN_ERR_TOKEN_EXPIRED = 5 , agora_rtm.RENEW_TOKEN_ERR_INVALID_TOKEN = 6 , agora_rtm.RENEW_TOKEN_ERR_USER_NOT_LOGGED_IN = 102
}
 
enum class  agora_rtm.CONNECTION_STATE {
  agora_rtm.CONNECTION_STATE_DISCONNECTED = 1 , agora_rtm.CONNECTION_STATE_CONNECTING = 2 , agora_rtm.CONNECTION_STATE_CONNECTED = 3 , agora_rtm.CONNECTION_STATE_RECONNECTING = 4 ,
  agora_rtm.CONNECTION_STATE_ABORTED = 5
}
 
enum class  agora_rtm.CONNECTION_CHANGE_REASON {
  agora_rtm.CONNECTION_CHANGE_REASON_LOGIN = 1 , agora_rtm.CONNECTION_CHANGE_REASON_LOGIN_SUCCESS = 2 , agora_rtm.CONNECTION_CHANGE_REASON_LOGIN_FAILURE = 3 , agora_rtm.CONNECTION_CHANGE_REASON_LOGIN_TIMEOUT = 4 ,
  agora_rtm.CONNECTION_CHANGE_REASON_INTERRUPTED = 5 , agora_rtm.CONNECTION_CHANGE_REASON_LOGOUT = 6 , agora_rtm.CONNECTION_CHANGE_REASON_BANNED_BY_SERVER = 7 , agora_rtm.CONNECTION_CHANGE_REASON_REMOTE_LOGIN = 8
}
 
enum class  agora_rtm.PEER_MESSAGE_ERR_CODE {
  agora_rtm.PEER_MESSAGE_ERR_OK = 0 , agora_rtm.PEER_MESSAGE_ERR_FAILURE = 1 , agora_rtm.PEER_MESSAGE_ERR_SENT_TIMEOUT = 2 , agora_rtm.PEER_MESSAGE_ERR_PEER_UNREACHABLE = 3 ,
  agora_rtm.PEER_MESSAGE_ERR_CACHED_BY_SERVER = 4 , agora_rtm.PEER_MESSAGE_ERR_TOO_OFTEN = 5 , agora_rtm.PEER_MESSAGE_ERR_INVALID_USERID = 6 , agora_rtm.PEER_MESSAGE_ERR_INVALID_MESSAGE = 7 ,
  agora_rtm.PEER_MESSAGE_ERR_IMCOMPATIBLE_MESSAGE = 8 , agora_rtm.PEER_MESSAGE_ERR_USER_NOT_LOGGED_IN = 102
}
 
enum class  agora_rtm.JOIN_CHANNEL_ERR {
  agora_rtm.JOIN_CHANNEL_ERR_OK = 0 , agora_rtm.JOIN_CHANNEL_ERR_FAILURE = 1 , agora_rtm.JOIN_CHANNEL_ERR_REJECTED = 2 , agora_rtm.JOIN_CHANNEL_ERR_INVALID_ARGUMENT = 3 ,
  agora_rtm.JOIN_CHANNEL_TIMEOUT = 4 , agora_rtm.JOIN_CHANNEL_ERR_EXCEED_LIMIT = 5 , agora_rtm.JOIN_CHANNEL_ERR_ALREADY_JOINED = 6 , agora_rtm.JOIN_CHANNEL_ERR_TOO_OFTEN = 7 ,
  agora_rtm.JOIN_CHANNEL_ERR_JOIN_SAME_CHANNEL_TOO_OFTEN = 8 , agora_rtm.JOIN_CHANNEL_ERR_USER_NOT_LOGGED_IN = 102
}
 
enum class  agora_rtm.LEAVE_CHANNEL_ERR {
  agora_rtm.LEAVE_CHANNEL_ERR_OK = 0 , agora_rtm.LEAVE_CHANNEL_ERR_FAILURE = 1 , agora_rtm.LEAVE_CHANNEL_ERR_REJECTED = 2 , agora_rtm.LEAVE_CHANNEL_ERR_NOT_IN_CHANNEL = 3 ,
  agora_rtm.LEAVE_CHANNEL_ERR_USER_NOT_LOGGED_IN = 102
}
 
enum class  agora_rtm.LEAVE_CHANNEL_REASON { agora_rtm.LEAVE_CHANNEL_REASON_QUIT = 1 , agora_rtm.LEAVE_CHANNEL_REASON_KICKED = 2 }
 
enum class  agora_rtm.CHANNEL_MESSAGE_ERR_CODE {
  agora_rtm.CHANNEL_MESSAGE_ERR_OK = 0 , agora_rtm.CHANNEL_MESSAGE_ERR_FAILURE = 1 , agora_rtm.CHANNEL_MESSAGE_ERR_SENT_TIMEOUT = 2 , agora_rtm.CHANNEL_MESSAGE_ERR_TOO_OFTEN = 3 ,
  agora_rtm.CHANNEL_MESSAGE_ERR_INVALID_MESSAGE = 4 , agora_rtm.CHANNEL_MESSAGE_ERR_USER_NOT_LOGGED_IN = 102
}
 
enum class  agora_rtm.GET_MEMBERS_ERR {
  agora_rtm.GET_MEMBERS_ERR_OK = 0 , agora_rtm.GET_MEMBERS_ERR_FAILURE = 1 , agora_rtm.GET_MEMBERS_ERR_REJECTED = 2 , agora_rtm.GET_MEMBERS_ERR_TIMEOUT = 3 ,
  agora_rtm.GET_MEMBERS_ERR_TOO_OFTEN = 4 , agora_rtm.GET_MEMBERS_ERR_NOT_IN_CHANNEL = 5 , agora_rtm.GET_MEMBERS_ERR_USER_NOT_LOGGED_IN = 102
}
 
enum class  agora_rtm.QUERY_PEERS_ONLINE_STATUS_ERR {
  agora_rtm.QUERY_PEERS_ONLINE_STATUS_ERR_OK = 0 , agora_rtm.QUERY_PEERS_ONLINE_STATUS_ERR_FAILURE = 1 , agora_rtm.QUERY_PEERS_ONLINE_STATUS_ERR_INVALID_ARGUMENT = 2 , agora_rtm.QUERY_PEERS_ONLINE_STATUS_ERR_REJECTED = 3 ,
  agora_rtm.QUERY_PEERS_ONLINE_STATUS_ERR_TIMEOUT = 4 , agora_rtm.QUERY_PEERS_ONLINE_STATUS_ERR_TOO_OFTEN = 5 , agora_rtm.QUERY_PEERS_ONLINE_STATUS_ERR_USER_NOT_LOGGED_IN = 102
}
 
enum class  agora_rtm.PEER_ONLINE_STATE { agora_rtm.PEER_ONLINE_STATE_ONLINE = 0 , agora_rtm.PEER_ONLINE_STATE_UNREACHABLE = 1 , agora_rtm.PEER_ONLINE_STATE_OFFLINE = 2 }
 
enum class  agora_rtm.PEER_SUBSCRIPTION_OPTION { agora_rtm.PEER_SUBSCRIPTION_OPTION_ONLINE_STATUS = 0 }
 
enum class  agora_rtm.PEER_SUBSCRIPTION_STATUS_ERR {
  agora_rtm.PEER_SUBSCRIPTION_STATUS_ERR_OK = 0 , agora_rtm.PEER_SUBSCRIPTION_STATUS_ERR_FAILURE = 1 , agora_rtm.PEER_SUBSCRIPTION_STATUS_ERR_INVALID_ARGUMENT = 2 , agora_rtm.PEER_SUBSCRIPTION_STATUS_ERR_REJECTED = 3 ,
  agora_rtm.PEER_SUBSCRIPTION_STATUS_ERR_TIMEOUT = 4 , agora_rtm.PEER_SUBSCRIPTION_STATUS_ERR_TOO_OFTEN = 5 , agora_rtm.PEER_SUBSCRIPTION_STATUS_ERR_OVERFLOW = 6 , agora_rtm.PEER_SUBSCRIPTION_STATUS_ERR_USER_NOT_LOGGED_IN = 102
}
 
enum class  agora_rtm.QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR {
  agora_rtm.QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_OK = 0 , agora_rtm.QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_FAILURE = 1 , agora_rtm.QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_TIMEOUT = 2 , agora_rtm.QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_TOO_OFTEN = 3 ,
  agora_rtm.QUERY_PEERS_BY_SUBSCRIPTION_OPTION_ERR_USER_NOT_LOGGED_IN = 102
}
 
enum class  agora_rtm.ATTRIBUTE_OPERATION_ERR {
  agora_rtm.ATTRIBUTE_OPERATION_ERR_OK = 0 , agora_rtm.ATTRIBUTE_OPERATION_ERR_NOT_READY = 1 , agora_rtm.ATTRIBUTE_OPERATION_ERR_FAILURE = 2 , agora_rtm.ATTRIBUTE_OPERATION_ERR_INVALID_ARGUMENT = 3 ,
  agora_rtm.ATTRIBUTE_OPERATION_ERR_SIZE_OVERFLOW = 4 , agora_rtm.ATTRIBUTE_OPERATION_ERR_TOO_OFTEN = 5 , agora_rtm.ATTRIBUTE_OPERATION_ERR_USER_NOT_FOUND = 6 , agora_rtm.ATTRIBUTE_OPERATION_ERR_TIMEOUT = 7 ,
  agora_rtm.ATTRIBUTE_OPERATION_ERR_USER_NOT_LOGGED_IN = 102
}
 
enum class  agora_rtm.GET_CHANNEL_MEMBER_COUNT_ERR_CODE {
  agora_rtm.GET_CHANNEL_MEMBER_COUNT_ERR_OK = 0 , agora_rtm.GET_CHANNEL_MEMBER_COUNT_ERR_FAILURE = 1 , agora_rtm.GET_CHANNEL_MEMBER_COUNT_ERR_INVALID_ARGUMENT = 2 , agora_rtm.GET_CHANNEL_MEMBER_COUNT_ERR_TOO_OFTEN = 3 ,
  agora_rtm.GET_CHANNEL_MEMBER_COUNT_ERR_TIMEOUT = 4 , agora_rtm.GET_CHANNEL_MEMBER_COUNT_ERR_EXCEED_LIMIT = 5 , agora_rtm.GET_CHANNEL_MEMBER_COUNT_ERR_USER_NOT_LOGGED_IN = 102
}
 
enum class  agora_rtm.DOWNLOAD_MEDIA_ERR_CODE {
  agora_rtm.DOWNLOAD_MEDIA_ERR_OK = 0 , agora_rtm.DOWNLOAD_MEDIA_ERR_FAILURE = 1 , agora_rtm.DOWNLOAD_MEDIA_ERR_INVALID_ARGUMENT = 2 , agora_rtm.DOWNLOAD_MEDIA_ERR_TIMEOUT = 3 ,
  agora_rtm.DOWNLOAD_MEDIA_ERR_NOT_EXIST = 4 , agora_rtm.DOWNLOAD_MEDIA_ERR_CONCURRENCY_LIMIT_EXCEEDED = 5 , agora_rtm.DOWNLOAD_MEDIA_ERR_INTERRUPTED = 6 , agora_rtm.DOWNLOAD_MEDIA_ERR_NOT_LOGGED_IN = 102
}
 
enum class  agora_rtm.UPLOAD_MEDIA_ERR_CODE {
  agora_rtm.UPLOAD_MEDIA_ERR_OK = 0 , agora_rtm.UPLOAD_MEDIA_ERR_FAILURE = 1 , agora_rtm.UPLOAD_MEDIA_ERR_INVALID_ARGUMENT = 2 , agora_rtm.UPLOAD_MEDIA_ERR_TIMEOUT = 3 ,
  agora_rtm.UPLOAD_MEDIA_ERR_SIZE_OVERFLOW = 4 , agora_rtm.UPLOAD_MEDIA_ERR_CONCURRENCY_LIMIT_EXCEEDED = 5 , agora_rtm.UPLOAD_MEDIA_ERR_INTERRUPTED = 6 , agora_rtm.UPLOAD_MEDIA_ERR_NOT_LOGGED_IN = 102
}
 
enum class  agora_rtm.CANCEL_MEDIA_ERR_CODE { agora_rtm.CANCEL_MEDIA_ERR_OK = 0 , agora_rtm.CANCEL_MEDIA_ERR_FAILURE = 1 , agora_rtm.CANCEL_MEDIA_ERR_NOT_EXIST = 2 , agora_rtm.CANCEL_MEDIA_ERR_NOT_LOGGED_IN = 102 }
 
enum class  agora_rtm.MESSAGE_TYPE {
  agora_rtm.MESSAGE_TYPE_UNDEFINED = 0 , agora_rtm.MESSAGE_TYPE_TEXT = 1 , agora_rtm.MESSAGE_TYPE_RAW = 2 , agora_rtm.MESSAGE_TYPE_FILE = 3 ,
  agora_rtm.MESSAGE_TYPE_IMAGE = 4
}
 
enum class  agora_rtm.LOCAL_INVITATION_STATE {
  agora_rtm.LOCAL_INVITATION_STATE_IDLE = 0 , agora_rtm.LOCAL_INVITATION_STATE_SENT_TO_REMOTE = 1 , agora_rtm.LOCAL_INVITATION_STATE_RECEIVED_BY_REMOTE = 2 , agora_rtm.LOCAL_INVITATION_STATE_ACCEPTED_BY_REMOTE = 3 ,
  agora_rtm.LOCAL_INVITATION_STATE_REFUSED_BY_REMOTE = 4 , agora_rtm.LOCAL_INVITATION_STATE_CANCELED = 5 , agora_rtm.LOCAL_INVITATION_STATE_FAILURE = 6
}
 
enum class  agora_rtm.REMOTE_INVITATION_STATE {
  agora_rtm.REMOTE_INVITATION_STATE_IDLE = 0 , agora_rtm.REMOTE_INVITATION_STATE_INVITATION_RECEIVED = 1 , agora_rtm.REMOTE_INVITATION_STATE_ACCEPT_SENT_TO_LOCAL = 2 , agora_rtm.REMOTE_INVITATION_STATE_REFUSED = 3 ,
  agora_rtm.REMOTE_INVITATION_STATE_ACCEPTED = 4 , agora_rtm.REMOTE_INVITATION_STATE_CANCELED = 5 , agora_rtm.REMOTE_INVITATION_STATE_FAILURE = 6
}
 
enum class  agora_rtm.LOCAL_INVITATION_ERR_CODE {
  agora_rtm.LOCAL_INVITATION_ERR_OK = 0 , agora_rtm.LOCAL_INVITATION_ERR_PEER_OFFLINE = 1 , agora_rtm.LOCAL_INVITATION_ERR_PEER_NO_RESPONSE = 2 , agora_rtm.LOCAL_INVITATION_ERR_INVITATION_EXPIRE = 3 ,
  agora_rtm.LOCAL_INVITATION_ERR_NOT_LOGGEDIN = 4
}
 
enum class  agora_rtm.REMOTE_INVITATION_ERR_CODE { agora_rtm.REMOTE_INVITATION_ERR_OK = 0 , agora_rtm.REMOTE_INVITATION_ERR_PEER_OFFLINE = 1 , agora_rtm.REMOTE_INVITATION_ERR_ACCEPT_FAILURE = 2 , agora_rtm.REMOTE_INVITATION_ERR_INVITATION_EXPIRE = 3 }
 
enum class  agora_rtm.INVITATION_API_CALL_ERR_CODE {
  agora_rtm.INVITATION_API_CALL_ERR_OK = 0 , agora_rtm.INVITATION_API_CALL_ERR_INVALID_ARGUMENT = 1 , agora_rtm.INVITATION_API_CALL_ERR_NOT_STARTED = 2 , agora_rtm.INVITATION_API_CALL_ERR_ALREADY_END = 3 ,
  agora_rtm.INVITATION_API_CALL_ERR_ALREADY_ACCEPT = 4 , agora_rtm.INVITATION_API_CALL_ERR_ALREADY_SENT = 5
}
 
enum class  agora_rtm.MESSAGE_FLAG { agora_rtm.RECEIVE = 0 , agora_rtm.SEND = 1 }
 
Generated by doxygen 1.9.1