com.tencent.tcr.sdk.api

Interface TcrSession

public interface TcrSession

This interface represents a session between the client and the TCR server.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TcrSession.Event Session event definitions.
static interface	TcrSession.Observer This interface represents the observer of TcrSession.

Method Summary

Modifier and Type	Method and Description
void	changeSeat(java.lang.String userId, MultiUser.Role targetRole, int targetPlayerIndex, AsyncCallback<java.lang.Void> callback) Switch the role and seat of a user (`userID`) to `targetRole` and `targetPlayerIndex` respectively.
CustomDataChannel	createCustomDataChannel(int port, CustomDataChannel.Observer observer) Creates a custom data channel.
Gamepad	getGamepad() Return the interface to interact with the cloud Gamepad in this session.
Keyboard	getKeyboard() Return the interface to interact with the cloud keyboard in this session.
LoginHelper	getLoginHelper() Deprecated. This interface is not recommended for use.
MotionSensor	getMotionSensor() Return the interface to interact with the cloud Sensor in this session.
Mouse	getMouse() Return the interface to interact with the cloud Mouse in this session.
java.lang.String	getRequestId() Get the current connection's requestId.
TouchScreen	getTouchScreen() Return the interface to interact with the cloud TouchScreen in this session.
void	pasteText(java.lang.String text) Send the text to the input box in the cloud application. The input box of the cloud application must have obtained the focus and allow the user to paste text from the clipboard. For Android cloud applications, sent text replaces the input box content. For Windows cloud applications, sent text is added to the existing content in the input box.
void	pauseStreaming() Pause the media stream.
void	release() Release the session.
void	requestChangeSeat(java.lang.String userId, MultiUser.Role targetRole, int targetPlayerIndex, AsyncCallback<java.lang.Void> callback) Apply to the room owner to switch the role and seat of a player (`userID`) to `targetRole` and `targetPlayerIndex` respectively.
void	restartCloudApp() Restart the cloud application process.
void	resumeStreaming() Resume the media stream.
void	sendCustomAudioData(java.nio.ByteBuffer audioData, long captureTimeNs) Send custom audio data.
void	setAudioSink(AudioSink audioSink) Sets a audio sink for this session.
void	setDisableCloudInput(boolean disableCloudInput) Disable the Cloud input. When the cloud input is disable, the cloud application's soft keyboard won't appear. This function is only supported for mobile cloud applications.
void	setEnableAudioPlaying(boolean enable) Set whether the SDK plays audio.
void	setEnableLocalAudio(boolean enableLocalAudio) Enable or disable the local audio track that is captured from the mic.
void	setEnableLocalVideo(boolean enableLocalVideo) Enable or disable the local video track that is captured from the camera.
void	setLocalVideoProfile(int width, int height, int fps, int minBitrate, int maxBitrate, boolean isFrontCamera) Set the local video profile.
void	setMicMute(java.lang.String userID, int micStatus, AsyncCallback<java.lang.Void> callback) Change the mic status of the `userID` user.
void	setRemoteAudioPlayProfile(float volume) Set the playing profile of the remote audio.
void	setRemoteDesktopResolution(int width, int height) Set the resolution of Cloud Desktop.
void	setRemoteVideoProfile(int fps, int minBitrate, int maxBitrate, AsyncCallback<java.lang.String> callback) Deprecated.
void	setVideoSink(VideoSink videoSink) Sets a video sink for this session.
boolean	start(java.lang.String serverSession) Starts the session.
void	syncRoomInfo() Refresh the information of all seats.

Method Detail

start

boolean start(java.lang.String serverSession)

Starts the session. This method should only be called once.

Parameters:

serverSession - The ServerSession returned from CreateSession API.

Returns:

true if success, false otherwise.

release

void release()

Release the session.
The session will disconnect from the sever, and the local resources of this session will be released. Once released, this session instance cannot be used anymore.

getRequestId

java.lang.String getRequestId()

Get the current connection's requestId. It takes effect after calling start(String).

setVideoSink

void setVideoSink(VideoSink videoSink)

Sets a video sink for this session. After that, the SDK will callback the decoded video frame data to the videoSink.

You may use this interface to post-process or render video images.

Parameters:

videoSink - The view sink to be set.This can be null to remove any existing one.

setAudioSink

void setAudioSink(AudioSink audioSink)

Sets a audio sink for this session. After that, the SDK will callback the audio data to the audioSink

Parameters:

audioSink - The audio sink to be set.

setEnableAudioPlaying

void setEnableAudioPlaying(boolean enable)

Set whether the SDK plays audio.

Parameters:

enable - true to enable audio playback, false otherwise.

pauseStreaming

void pauseStreaming()

Pause the media stream.

resumeStreaming

void resumeStreaming()

Resume the media stream.

setRemoteVideoProfile

@Deprecated
void setRemoteVideoProfile(int fps,
                                       int minBitrate,
                                       int maxBitrate,
                                       AsyncCallback<java.lang.String> callback)

Deprecated.

setRemoteAudioPlayProfile

void setRemoteAudioPlayProfile(float volume)

Set the playing profile of the remote audio.

Parameters:

volume - The volume scalar in the range of [0,10] that will be set on this remote audio stream.

setLocalVideoProfile

void setLocalVideoProfile(int width,
                          int height,
                          int fps,
                          int minBitrate,
                          int maxBitrate,
                          boolean isFrontCamera)

Set the local video profile. Each parameter value of this method needs to be within its valid range, otherwise the method call will be invalid.

Parameters:

width - The frame width, range[128, 1920]. Suggested value: 640.

height - The frame height, range[128, 1920]. Suggested value: 480.

fps - The frame rate must be greater than 0. Suggested value: 30.

minBitrate - The minimum bitrate in kbps must be greater than or equal to 0. Suggested value: 512.

maxBitrate - The maximum bitrate in kbps must be greater than 0. Suggested value: 1024.

isFrontCamera - whether to use the front camera. Suggested value: true.

setEnableLocalVideo

void setEnableLocalVideo(boolean enableLocalVideo)

Enable or disable the local video track that is captured from the camera.

Parameters:

enableLocalVideo - true to enable the local video, false otherwise.

setEnableLocalAudio

void setEnableLocalAudio(boolean enableLocalAudio)

Enable or disable the local audio track that is captured from the mic.

Parameters:

enableLocalAudio - true to enable the local audio, false otherwise.

sendCustomAudioData

void sendCustomAudioData(java.nio.ByteBuffer audioData,
                         long captureTimeNs)

Send custom audio data.
You MUST call this method within the same thread. Use this method to send audio data to the processing pipeline when custom audio capture is enabled. This method is only effective when TcrSessionConfig.enableCustomAudioCapture is true.

Parameters:

audioData - A ByteBuffer containing the audio data. This buffer MUST contain PCM data (16-bit) according to the configured audio format.

captureTimeNs - The capture time of the audio data, in nanoseconds. This timestamp should be a monotonically increasing value, used for synchronizing the audio data.

See Also:

TcrSessionConfig.Builder.enableCustomAudioCapture(boolean, int, boolean)

restartCloudApp

void restartCloudApp()

Restart the cloud application process.

pasteText

void pasteText(java.lang.String text)

Send the text to the input box in the cloud application.
The input box of the cloud application must have obtained the focus and allow the user to paste text from the clipboard.
For Android cloud applications, sent text replaces the input box content.
For Windows cloud applications, sent text is added to the existing content in the input box.

Parameters:

text - The text to be sent

setDisableCloudInput

void setDisableCloudInput(boolean disableCloudInput)

Disable the Cloud input.
When the cloud input is disable, the cloud application's soft keyboard won't appear.

This function is only supported for mobile cloud applications.

Parameters:

disableCloudInput - true disables the cloud input.
false enables the cloud input, allowing the soft keyboard to appear for user interaction with the cloud application via touch screen.

setRemoteDesktopResolution

void setRemoteDesktopResolution(int width,
                                int height)

Set the resolution of Cloud Desktop. If the cloud PC application is in full-screen mode, the resolution of the downstream video stream will also change accordingly.
This method is currently only valid for scenarios where the cloud is a PC application, and the scenario where the cloud is a mobile application is to be supported.

Parameters:

width - Width of cloud desktop.

height - Height of cloud desktop.

getLoginHelper

LoginHelper getLoginHelper()

Deprecated. This interface is not recommended for use.

Returns a login helper object for implementing automatic login functionality.

Returns:

This function must be called after the successful execution of start(String) function, otherwise the return value will be null.

getKeyboard

Keyboard getKeyboard()

Return the interface to interact with the cloud keyboard in this session.

Returns:

The interface to interact with the cloud keyboard in this session.

getMouse

Mouse getMouse()

Return the interface to interact with the cloud Mouse in this session.

Returns:

The interface to interact with the cloud Mouse in this session.

getGamepad

Gamepad getGamepad()

Return the interface to interact with the cloud Gamepad in this session.

Returns:

The interface to interact with the cloud Gamepad in this session.

getTouchScreen

TouchScreen getTouchScreen()

Return the interface to interact with the cloud TouchScreen in this session.

Returns:

The interface to interact with the cloud TouchScreen in this session.

getMotionSensor

MotionSensor getMotionSensor()

Return the interface to interact with the cloud Sensor in this session.

Returns:

The interface to interact with the cloud Sensor in this session.

createCustomDataChannel

CustomDataChannel createCustomDataChannel(int port,
                                          CustomDataChannel.Observer observer)

Creates a custom data channel.

Parameters:

port - The cloud port number uniquely identifying the data channel.

observer - The CustomDataChannel.Observer.

Returns:

the created data channel.

See Also:

CustomDataChannel

changeSeat

void changeSeat(java.lang.String userId,
                MultiUser.Role targetRole,
                int targetPlayerIndex,
                AsyncCallback<java.lang.Void> callback)

Switch the role and seat of a user (`userID`) to `targetRole` and `targetPlayerIndex` respectively.
If the change succeeds, `AsyncCallback.onSuccess(Object)` will be called back.
If there is another player on the target seat, the call will fail, and `TcrCode.MULTI_PLAYER_ASSIGN_SEAT_FAILED` will be passed in to `code` of the `AsyncCallback.onFailure(int, String)` callback.
Only the room owner can call this API. If it is called by a user who is not the room owner, the call will fail, and `TcrCode.MULTI_PLAYER_NO_AUTHORIZED` will be passed in to `code` of the `AsyncCallback.onFailure(int, String)` callback.
If the API call times out, the call will fail, and `TcrCode.ERR_TIMEOUT` will be passed in to `code` of the `AsyncCallback.onFailure(int, String)` callback.

Parameters:

userId - The target user ID

targetRole - The target role `MultiUser.Role`

targetPlayerIndex - The target seat. This parameter can take effect only for the `Player` role and will be `0` for the `Viewer` role.

callback - The callback for the setting result. `AsyncCallback.onSuccess(Object)` will be called back if the setting succeeds. `AsyncCallback.onFailure(int, String)` will be called back if the setting fails.
The callback is not guaranteed to be called on the UI thread.

requestChangeSeat

void requestChangeSeat(java.lang.String userId,
                       MultiUser.Role targetRole,
                       int targetPlayerIndex,
                       AsyncCallback<java.lang.Void> callback)

Apply to the room owner to switch the role and seat of a player (`userID`) to `targetRole` and `targetPlayerIndex` respectively.
If the change succeeds, `AsyncCallback.onSuccess(Object)` will be called back.
This API can only be called by a user who is not the room owner. If it is called by the room owner, the call will fail, and `TcrCode.MULTI_PLAYER_IGNORED_HOST_SUBMIT` will be passed in to `code` of the `AsyncCallback.onFailure(int, String)` callback.
If the API call times out, the call will fail, and `TcrCode.ERR_TIMEOUT` will be passed in to `code` of the `AsyncCallback.onFailure(int, String)` callback.

Parameters:

userId - The target player ID

targetRole - The target role `MultiUser.Role`

targetPlayerIndex - The target seat. This parameter can take effect only for the `Player` role and will be `0` for the `Viewer` role.

callback - The callback for the setting result.
This callback is not guaranteed to be called on the UI thread.

setMicMute

void setMicMute(java.lang.String userID,
                int micStatus,
                AsyncCallback<java.lang.Void> callback)

Change the mic status of the `userID` user.
The room owner can change the mic status of all users, but other users can change only their own mic status. If the room owner disables the mic of a user, the user cannot enable it.
If the change succeeds, `AsyncCallback.onSuccess(Object)` will be called back.
If a non-room owner user passes in `userID` of another user, `AsyncCallback.onFailure(int, String)` will be called back, and TcrCode.MULTI_PLAYER_NO_AUTHORIZED will be passed in to `code`.
If `userID` is incorrect, `AsyncCallback.onFailure(int, String)` will be called back, and `TcrCode.MULTI_PLAYER_NO_SUCH_USER` will be passed in to `code`.

Parameters:

micStatus - The mic status. Valid values: `MultiUser.MIC_STATUS_DISABLE`, `MultiUser.MIC_STATUS_OFF`, `MultiUser.MIC_STATUS_ON`.

callback - The callback for the setting result.
This callback is not guaranteed to be called on the UI thread.

syncRoomInfo

void syncRoomInfo()

Refresh the information of all seats. The result will be notified through the TcrSession.Event.MULTI_USER_SEAT_INFO callback.