com.tencent.tcr.sdk.api

Enum TcrSession.Event

java.lang.Object

java.lang.Enum<TcrSession.Event>

com.tencent.tcr.sdk.api.TcrSession.Event

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TcrSession.Event>

Enclosing interface:

TcrSession

public static enum TcrSession.Event
extends java.lang.Enum<TcrSession.Event>

Session event definitions.

See Also:

Observer#onEvent(Event, Object)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARCHIVE_LOAD_STATUS This event indicates the status of the archive loading in the server. The associated event data is of type String in json format:
ARCHIVE_SAVE_STATUS This event indicates the status of the archive saving in the server. The associated event data is of type String in json format:
CLIENT_IDLE This event indicates that the user is in an idle state, that is, the user does not operate the mouse, keyboard or screen for a while. This event has no associated data.
CLIENT_LOW_FPS This event indicates that the frame rate remains low for a while.
CLIENT_STATS This event indicates that the performance data is updated.
CURSOR_IMAGE_INFO This event indicates that the remote cursor image information is updated.
CURSOR_STATE_CHANGE This event indicates that the showing status of cloud cursor is changed.
GAME_START_COMPLETE This event indicates that the status of the game process on the server has been changed. The associated event data is of type String in json format:
INPUT_STATUS_CHANGED This event indicates that the input status of the server has changed.
MULTI_USER_ROLE_APPLY This event indicates that some user request to change seat.
MULTI_USER_SEAT_INFO This event indicates that the multi user seat info is updated.
REMOTE_DESKTOP_INFO This event indicates that the remote desktop information is updated.
SCREEN_CONFIG_CHANGE This event indicates that the configuration of the cloud screen configuration has been changed. The associated event data is of type ScreenConfig.
STATE_CLOSED This event indicates that the session is closed, and thus it can not be used any more. The associated event data is of type String and represents the reason for the close.
STATE_CONNECTED This event indicates that the session is connected. This event has no associated data.
STATE_INITED This event indicates that the session has been initialized. The associated event data is of type String and represents the ClientSession which is further used as a parameter to call the Cloud API CreateSession.
STATE_RECONNECTING This event indicates that the session is reconnecting.

Method Summary

Modifier and Type	Method and Description
static TcrSession.Event	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TcrSession.Event[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STATE_INITED

public static final TcrSession.Event STATE_INITED

This event indicates that the session has been initialized.
The associated event data is of type String and represents the ClientSession which is further used as a parameter to call the Cloud API CreateSession.

STATE_CONNECTED

public static final TcrSession.Event STATE_CONNECTED

This event indicates that the session is connected.
This event has no associated data.

STATE_RECONNECTING

public static final TcrSession.Event STATE_RECONNECTING

This event indicates that the session is reconnecting. You can do some interaction to prompt your user.
This event has no associated data.

STATE_CLOSED

public static final TcrSession.Event STATE_CLOSED

This event indicates that the session is closed, and thus it can not be used any more.
The associated event data is of type String and represents the reason for the close.

CLIENT_STATS

public static final TcrSession.Event CLIENT_STATS

This event indicates that the performance data is updated.
The associated event data is of type StatsInfo.

CLIENT_IDLE

public static final TcrSession.Event CLIENT_IDLE

This event indicates that the user is in an idle state, that is, the user does not operate the mouse, keyboard or screen for a while.
This event has no associated data.

CLIENT_LOW_FPS

public static final TcrSession.Event CLIENT_LOW_FPS

This event indicates that the frame rate remains low for a while. The frame rate reaches the specified threshold and continues for a period of timeTcrSessionConfig.Builder.lowFpsThreshold(int, int).
This event has no associated data.

GAME_START_COMPLETE

public static final TcrSession.Event GAME_START_COMPLETE

This event indicates that the status of the game process on the server has been changed.
The associated event data is of type String in json format:

 
 {
     user_id: String      // The user ID
     game_id: String      // The game ID
     app_id: number
     request_id: string
     status: number       // The game start error code. Valid values:
                          // `0`: Started the game successfully;
                          // `1`: Failed to start the game;
                          // `2`: The game status changed from not running to running;
                          // `3`: The game status changed from running to not running.
 }
 

ARCHIVE_LOAD_STATUS

public static final TcrSession.Event ARCHIVE_LOAD_STATUS

This event indicates the status of the archive loading in the server.
The associated event data is of type String in json format:

 {
     user_id: String      // The user ID
     game_id: String      // The game ID
     name: String         // The eventual filename of the archive
     url: String          // The archive download address
     status: number       // The error code of the archive loading status.
                          // Valid values:
                          // `0`: loaded the archive successfully;
                          // `1`: Failed to download the archive;
                          // `2`: Failed to verify the archive;
                          // `3`: Failed to extract the archive;
                          // `4`: Other error;
                          // `5`: The archive was being downloaded.
     save_type: String    // "`Auto` or `Normal`",
     category_id: String  // The archive category ID
     archive_size: number // The archive size
     loaded_size: number  // The size of the downloaded archive
 }
 

ARCHIVE_SAVE_STATUS

public static final TcrSession.Event ARCHIVE_SAVE_STATUS

This event indicates the status of the archive saving in the server.
The associated event data is of type String in json format:

 {
     user_id: String      // The user ID
     game_id: String      // The game ID
     name: String         // The eventual filename of the archive
     md5: String          // The MD5 value of the archive
    status: number        // The error code of the archive saving status.
                          // Valid values:
                          // `0`: saved the archive successfully;
                          // `1`: Failed to save the archive;
                          // `2`: Failed to compress the archive;
                          // `3`: Other error;
                          // `4`: The archive was being uploaded;
                          // `5`: The archive could not be found;
                          // `6`: The archive operations were too frequent.
   save_type: String      // "`Auto` or `Normal`",
   category_id: String    // The archive category ID
   archive_size: number   // The archive size
   saved_size: number     // The size of the saved archive
 }
 

INPUT_STATUS_CHANGED

public static final TcrSession.Event INPUT_STATUS_CHANGED

This event indicates that the input status of the server has changed.
The associated event data is of type String in json format:

 {
   status: String  // If the status distributed by the cloud is `disabled`, input is disabled.
 }
 

REMOTE_DESKTOP_INFO

public static final TcrSession.Event REMOTE_DESKTOP_INFO

This event indicates that the remote desktop information is updated.
The associated event data is of type RemoteDesktopInfo.

SCREEN_CONFIG_CHANGE

public static final TcrSession.Event SCREEN_CONFIG_CHANGE

This event indicates that the configuration of the cloud screen configuration has been changed.
The associated event data is of type ScreenConfig.

CURSOR_IMAGE_INFO

public static final TcrSession.Event CURSOR_IMAGE_INFO

This event indicates that the remote cursor image information is updated.
The associated event data is of type CursorImageInfo.

CURSOR_STATE_CHANGE

public static final TcrSession.Event CURSOR_STATE_CHANGE

This event indicates that the showing status of cloud cursor is changed.
The associated event data is of type CursorState.

MULTI_USER_SEAT_INFO

public static final TcrSession.Event MULTI_USER_SEAT_INFO

This event indicates that the multi user seat info is updated.
The associated event data is of type MultiUserSeatInfo.

MULTI_USER_ROLE_APPLY

public static final TcrSession.Event MULTI_USER_ROLE_APPLY

This event indicates that some user request to change seat. Note that only the host will receive this event.
The associated event data is of type RoleApplyInfo.

Method Detail

values

public static TcrSession.Event[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TcrSession.Event c : TcrSession.Event.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TcrSession.Event valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null