com.netease.nimlib.sdk.rts

Class RTSManager

java.lang.Object

com.netease.nimlib.sdk.rts.RTSManager

public abstract class RTSManager
extends java.lang.Object

Peer-to-peer whiteboarding

Constructor Summary

Constructors

Constructor and Description
RTSManager()

Method Summary

Modifier and Type	Method and Description
abstract boolean	accept(java.lang.String sessionId, RTSOptions options, RTSCallback<java.lang.Boolean> callback) (Recipient) accept a session
abstract boolean	close(java.lang.String sessionId, RTSCallback<java.lang.Void> callback) (Recipient) decline or end a session
static RTSManager	getInstance() Get an instance of an abstract class
abstract RTSNetworkProxy	getNetworkProxy() Get the network proxy
abstract boolean	isMuted(java.lang.String sessionId) Check if it is muted
abstract boolean	isSpeakerOn(java.lang.String sessionId) Check if the speaker is turned on
abstract boolean	observeCalleeAckNotification(java.lang.String sessionId, Observer<RTSCalleeAckEvent> observer, boolean register) Register or unregister the observer for the response to the session request by the callee.
abstract boolean	observeChannelState(java.lang.String sessionId, RTSChannelStateObserver observer, boolean register) Register or unregister the observer for channel state changes
abstract boolean	observeControlNotification(java.lang.String sessionId, Observer<RTSControlEvent> observer, boolean register) Register or unregister the observer for session control message
abstract boolean	observeHangUpNotification(java.lang.String sessionId, Observer<RTSCommonEvent> observer, boolean register) Register or unregister the observer for ending the session by the callee
abstract void	observeIncomingSession(Observer<RTSData> observer, boolean register) Register or unregister the observer for incoming sessions We recommend that you add the observer when the app starts
abstract boolean	observeOnlineAckNotification(java.lang.String sessionId, Observer<RTSOnlineAckEvent> observer, boolean register) Register or unregister the observer for responses to the caller from other online clients of a callee.
abstract boolean	observeReceiveData(java.lang.String sessionId, Observer<RTSTunData> observer, boolean register) Register or unregister the observer for the data sent by the peer from a channel
abstract boolean	observeTimeoutNotification(java.lang.String sessionId, Observer<RTSTimeOutEvent> observer, boolean register) Register or unregister the observer for session timeout.
abstract boolean	sendControlCommand(java.lang.String sessionId, java.lang.String data, RTSCallback<java.lang.Void> callback) Send a control command
abstract boolean	sendData(RTSTunData data) Send data to a user in a channel of the specified session, or broadcast to all users.
abstract void	setMute(java.lang.String sessionId, boolean mute) Mute control
abstract void	setNetworkProxy(RTSNetworkProxy proxy) Set a network proxy before starting a conversation
abstract void	setSpeaker(java.lang.String sessionId, boolean enable) Speaker control
abstract java.lang.String	start(java.lang.String account, java.util.List<RTSTunnelType> tunTypes, RTSOptions options, RTSNotifyOption notifyOption, RTSCallback<RTSData> callback) (Initiator) starts a session.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RTSManager

public RTSManager()

Method Detail

getInstance

public static RTSManager getInstance()

Get an instance of an abstract class

Returns:

RTSManager instance

setNetworkProxy

public abstract void setNetworkProxy(RTSNetworkProxy proxy)

Set a network proxy before starting a conversation

Parameters:

proxy - network proxy

getNetworkProxy

public abstract RTSNetworkProxy getNetworkProxy()

Get the network proxy

start

public abstract java.lang.String start(java.lang.String account,
                                       java.util.List<RTSTunnelType> tunTypes,
                                       RTSOptions options,
                                       RTSNotifyOption notifyOption,
                                       RTSCallback<RTSData> callback)

(Initiator) starts a session. The interface call will notify the peer of the created session.

Parameters:

account - peer account

tunTypes - tunnel types: AUDIO andDATA

options - optional. Specify whether to record the tunnel data.

notifyOption - optional. Push options

callback - callback that return RTSData

Returns:

Session ID If null is returned, the session fails. Note that only one session can be established in the audio channel. Error codes returned by the onFailed callback: 200: success 414: invalid parameter 509: channel failed 11001: no reachable callee. Callers can end the call 501: database error 514: service unavailable

accept

public abstract boolean accept(java.lang.String sessionId,
                               RTSOptions options,
                               RTSCallback<java.lang.Boolean> callback)

(Recipient) accept a session

Parameters:

sessionId - session ID

options - optional. Specify whether to record the tunnel data.

callback - callback to send notification for the result of initializing a channel.

Returns:

result. If false is returned, the session fails. Note that only one session can be established in the audio channel. Error codes returned by the onFailed callback: -1: failed to accept the session. The local audio channel is used

close

public abstract boolean close(java.lang.String sessionId,
                              RTSCallback<java.lang.Void> callback)

(Recipient) decline or end a session

Parameters:

sessionId - session ID

callback - callback

Returns:

result

sendControlCommand

public abstract boolean sendControlCommand(java.lang.String sessionId,
                                           java.lang.String data,
                                           RTSCallback<java.lang.Void> callback)

Send a control command

Parameters:

sessionId - session ID

data - control command

callback - callback

Returns:

result

observeIncomingSession

public abstract void observeIncomingSession(Observer<RTSData> observer,
                                            boolean register)

Register or unregister the observer for incoming sessions We recommend that you add the observer when the app starts

Parameters:

observer - Observer. The parameter is the session info

register - true: register the observer; false unregister the observer?

observeCalleeAckNotification

public abstract boolean observeCalleeAckNotification(java.lang.String sessionId,
                                                     Observer<RTSCalleeAckEvent> observer,
                                                     boolean register)

Register or unregister the observer for the response to the session request by the callee. For example, accepting the session. Rejecting the session, or the channel is busy.

Parameters:

sessionId - session ID

observer - Observer. The parameter is the response from the callee

register - true: register the observer; false unregister the observer?

Returns:

result

observeOnlineAckNotification

public abstract boolean observeOnlineAckNotification(java.lang.String sessionId,
                                                     Observer<RTSOnlineAckEvent> observer,
                                                     boolean register)

Register or unregister the observer for responses to the caller from other online clients of a callee.

Parameters:

sessionId - session ID

observer - The observer. The parameter is the response notification about online clients for the callee

register - true: register the observer; false unregister the observer?

Returns:

result

observeHangUpNotification

public abstract boolean observeHangUpNotification(java.lang.String sessionId,
                                                  Observer<RTSCommonEvent> observer,
                                                  boolean register)

Register or unregister the observer for ending the session by the callee

Parameters:

sessionId - session ID

observer - Observer. The parameter is the notification for ending a session

register - true: register the observer; false unregister the observer?

Returns:

result

observeChannelState

public abstract boolean observeChannelState(java.lang.String sessionId,
                                            RTSChannelStateObserver observer,
                                            boolean register)

Register or unregister the observer for channel state changes

Parameters:

sessionId - session ID

observer - The observer. The parameter is the callback for the channel state changes, For example, get connected with the server, a user joins the channel

register - true: register the observer; false unregister the observer?

Returns:

result

observeControlNotification

public abstract boolean observeControlNotification(java.lang.String sessionId,
                                                   Observer<RTSControlEvent> observer,
                                                   boolean register)

Register or unregister the observer for session control message

Parameters:

sessionId - session ID

observer - The observer. The parameter is the the received session control message

register - true: register the observer; false unregister the observer?

Returns:

result

observeTimeoutNotification

public abstract boolean observeTimeoutNotification(java.lang.String sessionId,
                                                   Observer<RTSTimeOutEvent> observer,
                                                   boolean register)

Register or unregister the observer for session timeout. The default timeout is 40 seconds.

Parameters:

sessionId - session ID

observer - Observer. The parameter is the timeout event info

register - true: register the observer; false unregister the observer?

Returns:

result

sendData

public abstract boolean sendData(RTSTunData data)

Send data to a user in a channel of the specified session, or broadcast to all users. In RTSTunData, the peer account is set to null.

Parameters:

data - data to be sent. The toAccount parameter is the destination for the data. If the value is set to null, the data will be broadcast to all users.

Returns:

result

observeReceiveData

public abstract boolean observeReceiveData(java.lang.String sessionId,
                                           Observer<RTSTunData> observer,
                                           boolean register)

Register or unregister the observer for the data sent by the peer from a channel

Parameters:

sessionId - session ID

observer - The observer. The parameter is the received data

register - true: register the observer; false unregister the observer?

setMute

public abstract void setMute(java.lang.String sessionId,
                             boolean mute)

Mute control

Parameters:

sessionId - session ID

mute - mute or unmute

isMuted

public abstract boolean isMuted(java.lang.String sessionId)

Check if it is muted

Parameters:

sessionId - session ID

Returns:

setSpeaker

public abstract void setSpeaker(java.lang.String sessionId,
                                boolean enable)

Speaker control

Parameters:

sessionId - session ID

enable - Enable or disable the speaker?

isSpeakerOn

public abstract boolean isSpeakerOn(java.lang.String sessionId)

Check if the speaker is turned on

Parameters:

sessionId - session ID

Returns: