com.tencentcloudapi.gs.v20191118.models

Class CreateSessionRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.gs.v20191118.models.CreateSessionRequest

public class CreateSessionRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
CreateSessionRequest()
CreateSessionRequest(CreateSessionRequest source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
Long	getBitrate() Get 【已废弃】
String	getClientSession() Get 客户端session信息，从JSSDK请求中获得。特殊的，当 RunMode 参数为 RunWithoutClient 时，该字段可以为空
Long	getFps() Get 帧率，可设置为30、45、60、90、120、144
String	getGameContext() Get 游戏相关参数
String	getGameId() Get 【已废弃】只在TrylockWorker时生效
String	getGameParas() Get 游戏参数
String	getGameRegion() Get 【已废弃】只在TrylockWorker时生效
String	getHostUserId() Get 【互动云游】游戏主机用户ID
String	getImageUrl() Get 背景图url，格式为png或jpeg，宽高1920*1080
Long	getMaxBitrate() Get 单位Mbps，动态调整最大码率建议值，会按实际情况调整
Long	getMinBitrate() Get 单位Mbps，动态调整最小码率建议值，会按实际情况调整
Long	getOptimization() Get 【已废弃】优化项，便于客户灰度开启新的优化项，默认为0
String	getResolution() Get 分辨率,，可设置为1080p或720p或1920x1080格式
String	getRole() Get 【互动云游】角色；Player表示玩家；Viewer表示观察者
String	getRunMode() Get 云端运行模式。 RunWithoutClient：允许无客户端连接的情况下仍保持云端 App 运行 默认值（空）：要求必须有客户端连接才会保持云端 App 运行。
Long	getSetNo() Get 【已废弃】
String	getUserId() Get 唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）
String	getUserIp() Get 【必选】用户IP，用户客户端的公网IP，用于就近调度，不填将严重影响用户体验
void	setBitrate(Long Bitrate) Set 【已废弃】
void	setClientSession(String ClientSession) Set 客户端session信息，从JSSDK请求中获得。特殊的，当 RunMode 参数为 RunWithoutClient 时，该字段可以为空
void	setFps(Long Fps) Set 帧率，可设置为30、45、60、90、120、144
void	setGameContext(String GameContext) Set 游戏相关参数
void	setGameId(String GameId) Set 【已废弃】只在TrylockWorker时生效
void	setGameParas(String GameParas) Set 游戏参数
void	setGameRegion(String GameRegion) Set 【已废弃】只在TrylockWorker时生效
void	setHostUserId(String HostUserId) Set 【互动云游】游戏主机用户ID
void	setImageUrl(String ImageUrl) Set 背景图url，格式为png或jpeg，宽高1920*1080
void	setMaxBitrate(Long MaxBitrate) Set 单位Mbps，动态调整最大码率建议值，会按实际情况调整
void	setMinBitrate(Long MinBitrate) Set 单位Mbps，动态调整最小码率建议值，会按实际情况调整
void	setOptimization(Long Optimization) Set 【已废弃】优化项，便于客户灰度开启新的优化项，默认为0
void	setResolution(String Resolution) Set 分辨率,，可设置为1080p或720p或1920x1080格式
void	setRole(String Role) Set 【互动云游】角色；Player表示玩家；Viewer表示观察者
void	setRunMode(String RunMode) Set 云端运行模式。 RunWithoutClient：允许无客户端连接的情况下仍保持云端 App 运行 默认值（空）：要求必须有客户端连接才会保持云端 App 运行。
void	setSetNo(Long SetNo) Set 【已废弃】
void	setUserId(String UserId) Set 唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）
void	setUserIp(String UserIp) Set 【必选】用户IP，用户客户端的公网IP，用于就近调度，不填将严重影响用户体验
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateSessionRequest

public CreateSessionRequest()

CreateSessionRequest

public CreateSessionRequest(CreateSessionRequest source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getUserId

public String getUserId()

Get 唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）

Returns:

UserId 唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）

setUserId

public void setUserId(String UserId)

Set 唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）

Parameters:

UserId - 唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）

getGameId

public String getGameId()

Get 【已废弃】只在TrylockWorker时生效

Returns:

GameId 【已废弃】只在TrylockWorker时生效

setGameId

public void setGameId(String GameId)

Set 【已废弃】只在TrylockWorker时生效

Parameters:

GameId - 【已废弃】只在TrylockWorker时生效

getGameRegion

public String getGameRegion()

Get 【已废弃】只在TrylockWorker时生效

Returns:

GameRegion 【已废弃】只在TrylockWorker时生效

setGameRegion

public void setGameRegion(String GameRegion)

Set 【已废弃】只在TrylockWorker时生效

Parameters:

GameRegion - 【已废弃】只在TrylockWorker时生效

getGameParas

public String getGameParas()

Get 游戏参数

Returns:

GameParas 游戏参数

setGameParas

public void setGameParas(String GameParas)

Set 游戏参数

Parameters:

GameParas - 游戏参数

getClientSession

public String getClientSession()

Get 客户端session信息，从JSSDK请求中获得。特殊的，当 RunMode 参数为 RunWithoutClient 时，该字段可以为空

Returns:

ClientSession 客户端session信息，从JSSDK请求中获得。特殊的，当 RunMode 参数为 RunWithoutClient 时，该字段可以为空

setClientSession

public void setClientSession(String ClientSession)

Set 客户端session信息，从JSSDK请求中获得。特殊的，当 RunMode 参数为 RunWithoutClient 时，该字段可以为空

Parameters:

ClientSession - 客户端session信息，从JSSDK请求中获得。特殊的，当 RunMode 参数为 RunWithoutClient 时，该字段可以为空

getResolution

public String getResolution()

Get 分辨率,，可设置为1080p或720p或1920x1080格式

Returns:

Resolution 分辨率,，可设置为1080p或720p或1920x1080格式

setResolution

public void setResolution(String Resolution)

Set 分辨率,，可设置为1080p或720p或1920x1080格式

Parameters:

Resolution - 分辨率,，可设置为1080p或720p或1920x1080格式

getImageUrl

public String getImageUrl()

Get 背景图url，格式为png或jpeg，宽高1920*1080

Returns:

ImageUrl 背景图url，格式为png或jpeg，宽高1920*1080

setImageUrl

public void setImageUrl(String ImageUrl)

Set 背景图url，格式为png或jpeg，宽高1920*1080

Parameters:

ImageUrl - 背景图url，格式为png或jpeg，宽高1920*1080

getSetNo

public Long getSetNo()

Get 【已废弃】

Returns:

SetNo 【已废弃】

setSetNo

public void setSetNo(Long SetNo)

Set 【已废弃】

Parameters:

SetNo - 【已废弃】

getBitrate

public Long getBitrate()

Get 【已废弃】

Returns:

Bitrate 【已废弃】

setBitrate

public void setBitrate(Long Bitrate)

Set 【已废弃】

Parameters:

Bitrate - 【已废弃】

getMaxBitrate

public Long getMaxBitrate()

Get 单位Mbps，动态调整最大码率建议值，会按实际情况调整

Returns:

MaxBitrate 单位Mbps，动态调整最大码率建议值，会按实际情况调整

setMaxBitrate

public void setMaxBitrate(Long MaxBitrate)

Set 单位Mbps，动态调整最大码率建议值，会按实际情况调整

Parameters:

MaxBitrate - 单位Mbps，动态调整最大码率建议值，会按实际情况调整

getMinBitrate

public Long getMinBitrate()

Get 单位Mbps，动态调整最小码率建议值，会按实际情况调整

Returns:

MinBitrate 单位Mbps，动态调整最小码率建议值，会按实际情况调整

setMinBitrate

public void setMinBitrate(Long MinBitrate)

Set 单位Mbps，动态调整最小码率建议值，会按实际情况调整

Parameters:

MinBitrate - 单位Mbps，动态调整最小码率建议值，会按实际情况调整

getFps

public Long getFps()

Get 帧率，可设置为30、45、60、90、120、144

Returns:

Fps 帧率，可设置为30、45、60、90、120、144

setFps

public void setFps(Long Fps)

Set 帧率，可设置为30、45、60、90、120、144

Parameters:

Fps - 帧率，可设置为30、45、60、90、120、144

getUserIp

public String getUserIp()

Get 【必选】用户IP，用户客户端的公网IP，用于就近调度，不填将严重影响用户体验

Returns:

UserIp 【必选】用户IP，用户客户端的公网IP，用于就近调度，不填将严重影响用户体验

setUserIp

public void setUserIp(String UserIp)

Set 【必选】用户IP，用户客户端的公网IP，用于就近调度，不填将严重影响用户体验

Parameters:

UserIp - 【必选】用户IP，用户客户端的公网IP，用于就近调度，不填将严重影响用户体验

getOptimization

public Long getOptimization()

Get 【已废弃】优化项，便于客户灰度开启新的优化项，默认为0

Returns:

Optimization 【已废弃】优化项，便于客户灰度开启新的优化项，默认为0

setOptimization

public void setOptimization(Long Optimization)

Set 【已废弃】优化项，便于客户灰度开启新的优化项，默认为0

Parameters:

Optimization - 【已废弃】优化项，便于客户灰度开启新的优化项，默认为0

getHostUserId

public String getHostUserId()

Get 【互动云游】游戏主机用户ID

Returns:

HostUserId 【互动云游】游戏主机用户ID

setHostUserId

public void setHostUserId(String HostUserId)

Set 【互动云游】游戏主机用户ID

Parameters:

HostUserId - 【互动云游】游戏主机用户ID

getRole

public String getRole()

Get 【互动云游】角色；Player表示玩家；Viewer表示观察者

Returns:

Role 【互动云游】角色；Player表示玩家；Viewer表示观察者

setRole

public void setRole(String Role)

Set 【互动云游】角色；Player表示玩家；Viewer表示观察者

Parameters:

Role - 【互动云游】角色；Player表示玩家；Viewer表示观察者

getGameContext

public String getGameContext()

Get 游戏相关参数

Returns:

GameContext 游戏相关参数

setGameContext

public void setGameContext(String GameContext)

Set 游戏相关参数

Parameters:

GameContext - 游戏相关参数

getRunMode

public String getRunMode()

Get 云端运行模式。 RunWithoutClient：允许无客户端连接的情况下仍保持云端 App 运行 默认值（空）：要求必须有客户端连接才会保持云端 App 运行。

Returns:

RunMode 云端运行模式。 RunWithoutClient：允许无客户端连接的情况下仍保持云端 App 运行 默认值（空）：要求必须有客户端连接才会保持云端 App 运行。

setRunMode

public void setRunMode(String RunMode)

Set 云端运行模式。 RunWithoutClient：允许无客户端连接的情况下仍保持云端 App 运行 默认值（空）：要求必须有客户端连接才会保持云端 App 运行。

Parameters:

RunMode - 云端运行模式。 RunWithoutClient：允许无客户端连接的情况下仍保持云端 App 运行 默认值（空）：要求必须有客户端连接才会保持云端 App 运行。

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.