v20191118

package
v1.0.939 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 9, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// 操作失败。
	FAILEDOPERATION = "FailedOperation"

	// 锁定机器超时或未调用TrylockWorker。
	FAILEDOPERATION_LOCKTIMEOUT = "FailedOperation.LockTimeout"

	// 处理超时。
	FAILEDOPERATION_PROCESSTIMEOUT = "FailedOperation.ProcessTimeout"

	// 请降低访问频率。
	FAILEDOPERATION_SLOWDOWN = "FailedOperation.SlowDown"

	// 操作超时。
	FAILEDOPERATION_TIMEOUT = "FailedOperation.Timeout"

	// 请求太频繁。
	FAILEDOPERATION_TOOFREQUENTLY = "FailedOperation.TooFrequently"

	// 内部错误。
	INTERNALERROR = "InternalError"

	// Json解析失败。
	INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"

	// 参数取值错误。
	INVALIDPARAMETERVALUE = "InvalidParameterValue"

	// 【多人游戏】对应的角色人数超过限制。
	LIMITEXCEEDED_ROLE = "LimitExceeded.Role"

	// 操作被拒绝。
	OPERATIONDENIED = "OperationDenied"

	// 没有空闲机器。
	RESOURCENOTFOUND_NOIDLE = "ResourceNotFound.NoIdle"

	// 会话未找到。
	RESOURCENOTFOUND_SESSIONNOTFOUND = "ResourceNotFound.SessionNotFound"

	// 访问并发实例失败。
	RESOURCEUNAVAILABLE_ACCESSFAILED = "ResourceUnavailable.AccessFailed"

	// 机器还在初始化中。
	RESOURCEUNAVAILABLE_INITIALIZATION = "ResourceUnavailable.Initialization"

	// 机器未运行。
	UNSUPPORTEDOPERATION_NOTRUNNING = "UnsupportedOperation.NotRunning"

	// 退出游戏中。
	UNSUPPORTEDOPERATION_STOPPING = "UnsupportedOperation.Stopping"
)
View Source 
const APIVersion = "2019-11-18"

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	common.Client
}

func NewClient 

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId 

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) CreateSession 

func (c *Client) CreateSession(request *CreateSessionRequest) (response *CreateSessionResponse, err error)

CreateSession 创建会话

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_LOCKTIMEOUT = "FailedOperation.LockTimeout"
FAILEDOPERATION_PROCESSTIMEOUT = "FailedOperation.ProcessTimeout"
FAILEDOPERATION_SLOWDOWN = "FailedOperation.SlowDown"
FAILEDOPERATION_TIMEOUT = "FailedOperation.Timeout"
FAILEDOPERATION_TOOFREQUENTLY = "FailedOperation.TooFrequently"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED_ROLE = "LimitExceeded.Role"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND_NOIDLE = "ResourceNotFound.NoIdle"
RESOURCENOTFOUND_SESSIONNOTFOUND = "ResourceNotFound.SessionNotFound"
RESOURCEUNAVAILABLE_INITIALIZATION = "ResourceUnavailable.Initialization"
UNSUPPORTEDOPERATION_STOPPING = "UnsupportedOperation.Stopping"

func (*Client) CreateSessionWithContext added in v1.0.324 

func (c *Client) CreateSessionWithContext(ctx context.Context, request *CreateSessionRequest) (response *CreateSessionResponse, err error)

CreateSession 创建会话

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_LOCKTIMEOUT = "FailedOperation.LockTimeout"
FAILEDOPERATION_PROCESSTIMEOUT = "FailedOperation.ProcessTimeout"
FAILEDOPERATION_SLOWDOWN = "FailedOperation.SlowDown"
FAILEDOPERATION_TIMEOUT = "FailedOperation.Timeout"
FAILEDOPERATION_TOOFREQUENTLY = "FailedOperation.TooFrequently"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED_ROLE = "LimitExceeded.Role"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND_NOIDLE = "ResourceNotFound.NoIdle"
RESOURCENOTFOUND_SESSIONNOTFOUND = "ResourceNotFound.SessionNotFound"
RESOURCEUNAVAILABLE_INITIALIZATION = "ResourceUnavailable.Initialization"
UNSUPPORTEDOPERATION_STOPPING = "UnsupportedOperation.Stopping"

func (*Client) DescribeInstancesCount 

func (c *Client) DescribeInstancesCount(request *DescribeInstancesCountRequest) (response *DescribeInstancesCountResponse, err error)

DescribeInstancesCount 获取并发总数和运行数

可能返回的错误码: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) DescribeInstancesCountWithContext added in v1.0.324 

func (c *Client) DescribeInstancesCountWithContext(ctx context.Context, request *DescribeInstancesCountRequest) (response *DescribeInstancesCountResponse, err error)

DescribeInstancesCount 获取并发总数和运行数

可能返回的错误码: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) SaveGameArchive 

func (c *Client) SaveGameArchive(request *SaveGameArchiveRequest) (response *SaveGameArchiveResponse, err error)

SaveGameArchive 保存游戏存档

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_SLOWDOWN = "FailedOperation.SlowDown"
FAILEDOPERATION_TOOFREQUENTLY = "FailedOperation.TooFrequently"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND_SESSIONNOTFOUND = "ResourceNotFound.SessionNotFound"

func (*Client) SaveGameArchiveWithContext added in v1.0.324 

func (c *Client) SaveGameArchiveWithContext(ctx context.Context, request *SaveGameArchiveRequest) (response *SaveGameArchiveResponse, err error)

SaveGameArchive 保存游戏存档

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_SLOWDOWN = "FailedOperation.SlowDown"
FAILEDOPERATION_TOOFREQUENTLY = "FailedOperation.TooFrequently"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND_SESSIONNOTFOUND = "ResourceNotFound.SessionNotFound"

func (*Client) StartPublishStream added in v1.0.328 

func (c *Client) StartPublishStream(request *StartPublishStreamRequest) (response *StartPublishStreamResponse, err error)

StartPublishStream 开始云端推流

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND_SESSIONNOTFOUND = "ResourceNotFound.SessionNotFound"
UNSUPPORTEDOPERATION_NOTRUNNING = "UnsupportedOperation.NotRunning"

func (*Client) StartPublishStreamToCSS added in v1.0.896 

func (c *Client) StartPublishStreamToCSS(request *StartPublishStreamToCSSRequest) (response *StartPublishStreamToCSSResponse, err error)

StartPublishStreamToCSS 开始云端推流

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND_SESSIONNOTFOUND = "ResourceNotFound.SessionNotFound"
UNSUPPORTEDOPERATION_NOTRUNNING = "UnsupportedOperation.NotRunning"

func (*Client) StartPublishStreamToCSSWithContext added in v1.0.896 

func (c *Client) StartPublishStreamToCSSWithContext(ctx context.Context, request *StartPublishStreamToCSSRequest) (response *StartPublishStreamToCSSResponse, err error)

StartPublishStreamToCSS 开始云端推流

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND_SESSIONNOTFOUND = "ResourceNotFound.SessionNotFound"
UNSUPPORTEDOPERATION_NOTRUNNING = "UnsupportedOperation.NotRunning"

func (*Client) StartPublishStreamWithContext added in v1.0.328 

func (c *Client) StartPublishStreamWithContext(ctx context.Context, request *StartPublishStreamRequest) (response *StartPublishStreamResponse, err error)

StartPublishStream 开始云端推流

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND_SESSIONNOTFOUND = "ResourceNotFound.SessionNotFound"
UNSUPPORTEDOPERATION_NOTRUNNING = "UnsupportedOperation.NotRunning"

func (*Client) StopGame 

func (c *Client) StopGame(request *StopGameRequest) (response *StopGameResponse, err error)

StopGame 强制退出游戏

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_PROCESSTIMEOUT = "FailedOperation.ProcessTimeout"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
RESOURCEUNAVAILABLE_ACCESSFAILED = "ResourceUnavailable.AccessFailed"

func (*Client) StopGameWithContext added in v1.0.324 

func (c *Client) StopGameWithContext(ctx context.Context, request *StopGameRequest) (response *StopGameResponse, err error)

StopGame 强制退出游戏

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_PROCESSTIMEOUT = "FailedOperation.ProcessTimeout"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
RESOURCEUNAVAILABLE_ACCESSFAILED = "ResourceUnavailable.AccessFailed"

func (*Client) StopPublishStream added in v1.0.328 

func (c *Client) StopPublishStream(request *StopPublishStreamRequest) (response *StopPublishStreamResponse, err error)

StopPublishStream 停止云端推流

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND_SESSIONNOTFOUND = "ResourceNotFound.SessionNotFound"
UNSUPPORTEDOPERATION_NOTRUNNING = "UnsupportedOperation.NotRunning"

func (*Client) StopPublishStreamWithContext added in v1.0.328 

func (c *Client) StopPublishStreamWithContext(ctx context.Context, request *StopPublishStreamRequest) (response *StopPublishStreamResponse, err error)

StopPublishStream 停止云端推流

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND_SESSIONNOTFOUND = "ResourceNotFound.SessionNotFound"
UNSUPPORTEDOPERATION_NOTRUNNING = "UnsupportedOperation.NotRunning"

func (*Client) SwitchGameArchive 

func (c *Client) SwitchGameArchive(request *SwitchGameArchiveRequest) (response *SwitchGameArchiveResponse, err error)

SwitchGameArchive 切换游戏存档

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_SLOWDOWN = "FailedOperation.SlowDown"
FAILEDOPERATION_TOOFREQUENTLY = "FailedOperation.TooFrequently"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND_SESSIONNOTFOUND = "ResourceNotFound.SessionNotFound"

func (*Client) SwitchGameArchiveWithContext added in v1.0.324 

func (c *Client) SwitchGameArchiveWithContext(ctx context.Context, request *SwitchGameArchiveRequest) (response *SwitchGameArchiveResponse, err error)

SwitchGameArchive 切换游戏存档

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_SLOWDOWN = "FailedOperation.SlowDown"
FAILEDOPERATION_TOOFREQUENTLY = "FailedOperation.TooFrequently"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND_SESSIONNOTFOUND = "ResourceNotFound.SessionNotFound"

func (*Client) TrylockWorker 

func (c *Client) TrylockWorker(request *TrylockWorkerRequest) (response *TrylockWorkerResponse, err error)

TrylockWorker 尝试锁定机器

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_PROCESSTIMEOUT = "FailedOperation.ProcessTimeout"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND_NOIDLE = "ResourceNotFound.NoIdle"
RESOURCEUNAVAILABLE_INITIALIZATION = "ResourceUnavailable.Initialization"
UNSUPPORTEDOPERATION_STOPPING = "UnsupportedOperation.Stopping"

func (*Client) TrylockWorkerWithContext added in v1.0.324 

func (c *Client) TrylockWorkerWithContext(ctx context.Context, request *TrylockWorkerRequest) (response *TrylockWorkerResponse, err error)

TrylockWorker 尝试锁定机器

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_PROCESSTIMEOUT = "FailedOperation.ProcessTimeout"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND_NOIDLE = "ResourceNotFound.NoIdle"
RESOURCEUNAVAILABLE_INITIALIZATION = "ResourceUnavailable.Initialization"
UNSUPPORTEDOPERATION_STOPPING = "UnsupportedOperation.Stopping"

type CreateSessionRequest 

type CreateSessionRequest struct {
	*tchttp.BaseRequest

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

	// 【已废弃】只在TrylockWorker时生效
	GameId *string `json:"GameId,omitnil,omitempty" name:"GameId"`

	// 【已废弃】只在TrylockWorker时生效
	GameRegion *string `json:"GameRegion,omitnil,omitempty" name:"GameRegion"`

	// 游戏参数
	GameParas *string `json:"GameParas,omitnil,omitempty" name:"GameParas"`

	// 客户端session信息，从JSSDK请求中获得。特殊的，当 RunMode 参数为 RunWithoutClient 时，该字段可以为空
	ClientSession *string `json:"ClientSession,omitnil,omitempty" name:"ClientSession"`

	// 分辨率,，可设置为1080p或720p或1920x1080格式
	Resolution *string `json:"Resolution,omitnil,omitempty" name:"Resolution"`

	// 背景图url，格式为png或jpeg，宽高1920*1080
	ImageUrl *string `json:"ImageUrl,omitnil,omitempty" name:"ImageUrl"`

	// 【已废弃】
	SetNo *uint64 `json:"SetNo,omitnil,omitempty" name:"SetNo"`

	// 【已废弃】
	Bitrate *uint64 `json:"Bitrate,omitnil,omitempty" name:"Bitrate"`

	// 单位Mbps，动态调整最大码率建议值，会按实际情况调整
	MaxBitrate *uint64 `json:"MaxBitrate,omitnil,omitempty" name:"MaxBitrate"`

	// 单位Mbps，动态调整最小码率建议值，会按实际情况调整
	MinBitrate *uint64 `json:"MinBitrate,omitnil,omitempty" name:"MinBitrate"`

	// 帧率，可设置为30、45、60、90、120、144
	Fps *uint64 `json:"Fps,omitnil,omitempty" name:"Fps"`

	// 【必选】用户IP，用户客户端的公网IP，用于就近调度，不填将严重影响用户体验
	UserIp *string `json:"UserIp,omitnil,omitempty" name:"UserIp"`

	// 【已废弃】优化项，便于客户灰度开启新的优化项，默认为0
	Optimization *uint64 `json:"Optimization,omitnil,omitempty" name:"Optimization"`

	// 【互动云游】游戏主机用户ID
	HostUserId *string `json:"HostUserId,omitnil,omitempty" name:"HostUserId"`

	// 【互动云游】角色；Player表示玩家；Viewer表示观察者
	Role *string `json:"Role,omitnil,omitempty" name:"Role"`

	// 游戏相关参数
	GameContext *string `json:"GameContext,omitnil,omitempty" name:"GameContext"`

	// 云端运行模式。
	// RunWithoutClient：允许无客户端连接的情况下仍保持云端 App 运行
	// 默认值（空）：要求必须有客户端连接才会保持云端 App 运行。
	RunMode *string `json:"RunMode,omitnil,omitempty" name:"RunMode"`
}

func NewCreateSessionRequest 

func NewCreateSessionRequest() (request *CreateSessionRequest)

func (*CreateSessionRequest) FromJsonString 

func (r *CreateSessionRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateSessionRequest) ToJsonString 

func (r *CreateSessionRequest) ToJsonString() string

type CreateSessionRequestParams added in v1.0.426 

type CreateSessionRequestParams struct {
	// 唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 【已废弃】只在TrylockWorker时生效
	GameId *string `json:"GameId,omitnil,omitempty" name:"GameId"`

	// 【已废弃】只在TrylockWorker时生效
	GameRegion *string `json:"GameRegion,omitnil,omitempty" name:"GameRegion"`

	// 游戏参数
	GameParas *string `json:"GameParas,omitnil,omitempty" name:"GameParas"`

	// 客户端session信息，从JSSDK请求中获得。特殊的，当 RunMode 参数为 RunWithoutClient 时，该字段可以为空
	ClientSession *string `json:"ClientSession,omitnil,omitempty" name:"ClientSession"`

	// 分辨率,，可设置为1080p或720p或1920x1080格式
	Resolution *string `json:"Resolution,omitnil,omitempty" name:"Resolution"`

	// 背景图url，格式为png或jpeg，宽高1920*1080
	ImageUrl *string `json:"ImageUrl,omitnil,omitempty" name:"ImageUrl"`

	// 【已废弃】
	SetNo *uint64 `json:"SetNo,omitnil,omitempty" name:"SetNo"`

	// 【已废弃】
	Bitrate *uint64 `json:"Bitrate,omitnil,omitempty" name:"Bitrate"`

	// 单位Mbps，动态调整最大码率建议值，会按实际情况调整
	MaxBitrate *uint64 `json:"MaxBitrate,omitnil,omitempty" name:"MaxBitrate"`

	// 单位Mbps，动态调整最小码率建议值，会按实际情况调整
	MinBitrate *uint64 `json:"MinBitrate,omitnil,omitempty" name:"MinBitrate"`

	// 帧率，可设置为30、45、60、90、120、144
	Fps *uint64 `json:"Fps,omitnil,omitempty" name:"Fps"`

	// 【必选】用户IP，用户客户端的公网IP，用于就近调度，不填将严重影响用户体验
	UserIp *string `json:"UserIp,omitnil,omitempty" name:"UserIp"`

	// 【已废弃】优化项，便于客户灰度开启新的优化项，默认为0
	Optimization *uint64 `json:"Optimization,omitnil,omitempty" name:"Optimization"`

	// 【互动云游】游戏主机用户ID
	HostUserId *string `json:"HostUserId,omitnil,omitempty" name:"HostUserId"`

	// 【互动云游】角色；Player表示玩家；Viewer表示观察者
	Role *string `json:"Role,omitnil,omitempty" name:"Role"`

	// 游戏相关参数
	GameContext *string `json:"GameContext,omitnil,omitempty" name:"GameContext"`

	// 云端运行模式。
	// RunWithoutClient：允许无客户端连接的情况下仍保持云端 App 运行
	// 默认值（空）：要求必须有客户端连接才会保持云端 App 运行。
	RunMode *string `json:"RunMode,omitnil,omitempty" name:"RunMode"`
}

Predefined struct for user

type CreateSessionResponse 

type CreateSessionResponse struct {
	*tchttp.BaseResponse
	Response *CreateSessionResponseParams `json:"Response"`
}

func NewCreateSessionResponse 

func NewCreateSessionResponse() (response *CreateSessionResponse)

func (*CreateSessionResponse) FromJsonString 

func (r *CreateSessionResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateSessionResponse) ToJsonString 

func (r *CreateSessionResponse) ToJsonString() string

type CreateSessionResponseParams added in v1.0.426 

type CreateSessionResponseParams struct {
	// 服务端session信息，返回给JSSDK
	ServerSession *string `json:"ServerSession,omitnil,omitempty" name:"ServerSession"`

	// 【已废弃】
	RoleNumber *string `json:"RoleNumber,omitnil,omitempty" name:"RoleNumber"`

	// 【互动云游】角色；Player表示玩家；Viewer表示观察者
	Role *string `json:"Role,omitnil,omitempty" name:"Role"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeInstancesCountRequest 

type DescribeInstancesCountRequest struct {
	*tchttp.BaseRequest

	// 游戏ID
	GameId *string `json:"GameId,omitnil,omitempty" name:"GameId"`

	// 实例分组ID
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// 游戏区域
	GameRegion *string `json:"GameRegion,omitnil,omitempty" name:"GameRegion"`

	// 游戏类型。
	// MOBILE：手游
	// PC：默认值，端游
	GameType *string `json:"GameType,omitnil,omitempty" name:"GameType"`
}

func NewDescribeInstancesCountRequest 

func NewDescribeInstancesCountRequest() (request *DescribeInstancesCountRequest)

func (*DescribeInstancesCountRequest) FromJsonString 

func (r *DescribeInstancesCountRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstancesCountRequest) ToJsonString 

func (r *DescribeInstancesCountRequest) ToJsonString() string

type DescribeInstancesCountRequestParams added in v1.0.426 

type DescribeInstancesCountRequestParams struct {
	// 游戏ID
	GameId *string `json:"GameId,omitnil,omitempty" name:"GameId"`

	// 实例分组ID
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// 游戏区域
	GameRegion *string `json:"GameRegion,omitnil,omitempty" name:"GameRegion"`

	// 游戏类型。
	// MOBILE：手游
	// PC：默认值，端游
	GameType *string `json:"GameType,omitnil,omitempty" name:"GameType"`
}

Predefined struct for user

type DescribeInstancesCountResponse 

type DescribeInstancesCountResponse struct {
	*tchttp.BaseResponse
	Response *DescribeInstancesCountResponseParams `json:"Response"`
}

func NewDescribeInstancesCountResponse 

func NewDescribeInstancesCountResponse() (response *DescribeInstancesCountResponse)

func (*DescribeInstancesCountResponse) FromJsonString 

func (r *DescribeInstancesCountResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeInstancesCountResponse) ToJsonString 

func (r *DescribeInstancesCountResponse) ToJsonString() string

type DescribeInstancesCountResponseParams added in v1.0.426 

type DescribeInstancesCountResponseParams struct {
	// 客户的实例总数
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// 客户的实例运行数
	Running *uint64 `json:"Running,omitnil,omitempty" name:"Running"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type SaveGameArchiveRequest 

type SaveGameArchiveRequest struct {
	*tchttp.BaseRequest

	// 游戏用户ID
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 游戏ID
	GameId *string `json:"GameId,omitnil,omitempty" name:"GameId"`
}

func NewSaveGameArchiveRequest 

func NewSaveGameArchiveRequest() (request *SaveGameArchiveRequest)

func (*SaveGameArchiveRequest) FromJsonString 

func (r *SaveGameArchiveRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SaveGameArchiveRequest) ToJsonString 

func (r *SaveGameArchiveRequest) ToJsonString() string

type SaveGameArchiveRequestParams added in v1.0.426 

type SaveGameArchiveRequestParams struct {
	// 游戏用户ID
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 游戏ID
	GameId *string `json:"GameId,omitnil,omitempty" name:"GameId"`
}

Predefined struct for user

type SaveGameArchiveResponse 

type SaveGameArchiveResponse struct {
	*tchttp.BaseResponse
	Response *SaveGameArchiveResponseParams `json:"Response"`
}

func NewSaveGameArchiveResponse 

func NewSaveGameArchiveResponse() (response *SaveGameArchiveResponse)

func (*SaveGameArchiveResponse) FromJsonString 

func (r *SaveGameArchiveResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SaveGameArchiveResponse) ToJsonString 

func (r *SaveGameArchiveResponse) ToJsonString() string

type SaveGameArchiveResponseParams added in v1.0.426 

type SaveGameArchiveResponseParams struct {
	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type StartPublishStreamRequest added in v1.0.328 

type StartPublishStreamRequest struct {
	*tchttp.BaseRequest

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

	// 推流地址，仅支持rtmp协议
	PublishUrl *string `json:"PublishUrl,omitnil,omitempty" name:"PublishUrl"`
}

func NewStartPublishStreamRequest added in v1.0.328 

func NewStartPublishStreamRequest() (request *StartPublishStreamRequest)

func (*StartPublishStreamRequest) FromJsonString added in v1.0.328 

func (r *StartPublishStreamRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*StartPublishStreamRequest) ToJsonString added in v1.0.328 

func (r *StartPublishStreamRequest) ToJsonString() string

type StartPublishStreamRequestParams added in v1.0.426 

type StartPublishStreamRequestParams struct {
	// 唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 推流地址，仅支持rtmp协议
	PublishUrl *string `json:"PublishUrl,omitnil,omitempty" name:"PublishUrl"`
}

Predefined struct for user

type StartPublishStreamResponse added in v1.0.328 

type StartPublishStreamResponse struct {
	*tchttp.BaseResponse
	Response *StartPublishStreamResponseParams `json:"Response"`
}

func NewStartPublishStreamResponse added in v1.0.328 

func NewStartPublishStreamResponse() (response *StartPublishStreamResponse)

func (*StartPublishStreamResponse) FromJsonString added in v1.0.328 

func (r *StartPublishStreamResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*StartPublishStreamResponse) ToJsonString added in v1.0.328 

func (r *StartPublishStreamResponse) ToJsonString() string

type StartPublishStreamResponseParams added in v1.0.426 

type StartPublishStreamResponseParams struct {
	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type StartPublishStreamToCSSRequest added in v1.0.896 

type StartPublishStreamToCSSRequest struct {
	*tchttp.BaseRequest

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

	// 推流参数，推流时携带自定义参数。
	PublishStreamArgs *string `json:"PublishStreamArgs,omitnil,omitempty" name:"PublishStreamArgs"`
}

func NewStartPublishStreamToCSSRequest added in v1.0.896 

func NewStartPublishStreamToCSSRequest() (request *StartPublishStreamToCSSRequest)

func (*StartPublishStreamToCSSRequest) FromJsonString added in v1.0.896 

func (r *StartPublishStreamToCSSRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*StartPublishStreamToCSSRequest) ToJsonString added in v1.0.896 

func (r *StartPublishStreamToCSSRequest) ToJsonString() string

type StartPublishStreamToCSSRequestParams added in v1.0.896 

type StartPublishStreamToCSSRequestParams struct {
	// 唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 推流参数，推流时携带自定义参数。
	PublishStreamArgs *string `json:"PublishStreamArgs,omitnil,omitempty" name:"PublishStreamArgs"`
}

Predefined struct for user

type StartPublishStreamToCSSResponse added in v1.0.896 

type StartPublishStreamToCSSResponse struct {
	*tchttp.BaseResponse
	Response *StartPublishStreamToCSSResponseParams `json:"Response"`
}

func NewStartPublishStreamToCSSResponse added in v1.0.896 

func NewStartPublishStreamToCSSResponse() (response *StartPublishStreamToCSSResponse)

func (*StartPublishStreamToCSSResponse) FromJsonString added in v1.0.896 

func (r *StartPublishStreamToCSSResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*StartPublishStreamToCSSResponse) ToJsonString added in v1.0.896 

func (r *StartPublishStreamToCSSResponse) ToJsonString() string

type StartPublishStreamToCSSResponseParams added in v1.0.896 

type StartPublishStreamToCSSResponseParams struct {
	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type StopGameRequest 

type StopGameRequest struct {
	*tchttp.BaseRequest

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

	// 【多人游戏】游戏主机用户ID
	HostUserId *string `json:"HostUserId,omitnil,omitempty" name:"HostUserId"`
}

func NewStopGameRequest 

func NewStopGameRequest() (request *StopGameRequest)

func (*StopGameRequest) FromJsonString 

func (r *StopGameRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*StopGameRequest) ToJsonString 

func (r *StopGameRequest) ToJsonString() string

type StopGameRequestParams added in v1.0.426 

type StopGameRequestParams struct {
	// 唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 【多人游戏】游戏主机用户ID
	HostUserId *string `json:"HostUserId,omitnil,omitempty" name:"HostUserId"`
}

Predefined struct for user

type StopGameResponse 

type StopGameResponse struct {
	*tchttp.BaseResponse
	Response *StopGameResponseParams `json:"Response"`
}

func NewStopGameResponse 

func NewStopGameResponse() (response *StopGameResponse)

func (*StopGameResponse) FromJsonString 

func (r *StopGameResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*StopGameResponse) ToJsonString 

func (r *StopGameResponse) ToJsonString() string

type StopGameResponseParams added in v1.0.426 

type StopGameResponseParams struct {
	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type StopPublishStreamRequest added in v1.0.328 

type StopPublishStreamRequest struct {
	*tchttp.BaseRequest

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

func NewStopPublishStreamRequest added in v1.0.328 

func NewStopPublishStreamRequest() (request *StopPublishStreamRequest)

func (*StopPublishStreamRequest) FromJsonString added in v1.0.328 

func (r *StopPublishStreamRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*StopPublishStreamRequest) ToJsonString added in v1.0.328 

func (r *StopPublishStreamRequest) ToJsonString() string

type StopPublishStreamRequestParams added in v1.0.426 

type StopPublishStreamRequestParams struct {
	// 唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`
}

Predefined struct for user

type StopPublishStreamResponse added in v1.0.328 

type StopPublishStreamResponse struct {
	*tchttp.BaseResponse
	Response *StopPublishStreamResponseParams `json:"Response"`
}

func NewStopPublishStreamResponse added in v1.0.328 

func NewStopPublishStreamResponse() (response *StopPublishStreamResponse)

func (*StopPublishStreamResponse) FromJsonString added in v1.0.328 

func (r *StopPublishStreamResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*StopPublishStreamResponse) ToJsonString added in v1.0.328 

func (r *StopPublishStreamResponse) ToJsonString() string

type StopPublishStreamResponseParams added in v1.0.426 

type StopPublishStreamResponseParams struct {
	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type SwitchGameArchiveRequest 

type SwitchGameArchiveRequest struct {
	*tchttp.BaseRequest

	// 游戏用户ID
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 游戏ID
	GameId *string `json:"GameId,omitnil,omitempty" name:"GameId"`

	// 游戏存档Url
	GameArchiveUrl *string `json:"GameArchiveUrl,omitnil,omitempty" name:"GameArchiveUrl"`

	// 游戏相关参数
	GameContext *string `json:"GameContext,omitnil,omitempty" name:"GameContext"`
}

func NewSwitchGameArchiveRequest 

func NewSwitchGameArchiveRequest() (request *SwitchGameArchiveRequest)

func (*SwitchGameArchiveRequest) FromJsonString 

func (r *SwitchGameArchiveRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SwitchGameArchiveRequest) ToJsonString 

func (r *SwitchGameArchiveRequest) ToJsonString() string

type SwitchGameArchiveRequestParams added in v1.0.426 

type SwitchGameArchiveRequestParams struct {
	// 游戏用户ID
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 游戏ID
	GameId *string `json:"GameId,omitnil,omitempty" name:"GameId"`

	// 游戏存档Url
	GameArchiveUrl *string `json:"GameArchiveUrl,omitnil,omitempty" name:"GameArchiveUrl"`

	// 游戏相关参数
	GameContext *string `json:"GameContext,omitnil,omitempty" name:"GameContext"`
}

Predefined struct for user

type SwitchGameArchiveResponse 

type SwitchGameArchiveResponse struct {
	*tchttp.BaseResponse
	Response *SwitchGameArchiveResponseParams `json:"Response"`
}

func NewSwitchGameArchiveResponse 

func NewSwitchGameArchiveResponse() (response *SwitchGameArchiveResponse)

func (*SwitchGameArchiveResponse) FromJsonString 

func (r *SwitchGameArchiveResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*SwitchGameArchiveResponse) ToJsonString 

func (r *SwitchGameArchiveResponse) ToJsonString() string

type SwitchGameArchiveResponseParams added in v1.0.426 

type SwitchGameArchiveResponseParams struct {
	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type TrylockWorkerRequest 

type TrylockWorkerRequest struct {
	*tchttp.BaseRequest

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

	// 游戏ID
	GameId *string `json:"GameId,omitnil,omitempty" name:"GameId"`

	// 游戏区域，ap-guangzhou、ap-shanghai、ap-beijing等，如果不为空，优先按照该区域进行调度分配机器
	GameRegion *string `json:"GameRegion,omitnil,omitempty" name:"GameRegion"`

	// 【废弃】资源池编号
	SetNo *uint64 `json:"SetNo,omitnil,omitempty" name:"SetNo"`

	// 【必选】用户IP，用户客户端的公网IP，用于就近调度，不填将严重影响用户体验
	UserIp *string `json:"UserIp,omitnil,omitempty" name:"UserIp"`

	// 分组ID
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`
}

func NewTrylockWorkerRequest 

func NewTrylockWorkerRequest() (request *TrylockWorkerRequest)

func (*TrylockWorkerRequest) FromJsonString 

func (r *TrylockWorkerRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*TrylockWorkerRequest) ToJsonString 

func (r *TrylockWorkerRequest) ToJsonString() string

type TrylockWorkerRequestParams added in v1.0.426 

type TrylockWorkerRequestParams struct {
	// 唯一用户身份标识，由业务方自定义，平台不予理解。（可根据业务需要决定使用用户的唯一身份标识或是使用时间戳随机生成；在用户重连时应保持UserId不变）
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 游戏ID
	GameId *string `json:"GameId,omitnil,omitempty" name:"GameId"`

	// 游戏区域，ap-guangzhou、ap-shanghai、ap-beijing等，如果不为空，优先按照该区域进行调度分配机器
	GameRegion *string `json:"GameRegion,omitnil,omitempty" name:"GameRegion"`

	// 【废弃】资源池编号
	SetNo *uint64 `json:"SetNo,omitnil,omitempty" name:"SetNo"`

	// 【必选】用户IP，用户客户端的公网IP，用于就近调度，不填将严重影响用户体验
	UserIp *string `json:"UserIp,omitnil,omitempty" name:"UserIp"`

	// 分组ID
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`
}

Predefined struct for user

type TrylockWorkerResponse 

type TrylockWorkerResponse struct {
	*tchttp.BaseResponse
	Response *TrylockWorkerResponseParams `json:"Response"`
}

func NewTrylockWorkerResponse 

func NewTrylockWorkerResponse() (response *TrylockWorkerResponse)

func (*TrylockWorkerResponse) FromJsonString 

func (r *TrylockWorkerResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*TrylockWorkerResponse) ToJsonString 

func (r *TrylockWorkerResponse) ToJsonString() string

type TrylockWorkerResponseParams added in v1.0.426 

type TrylockWorkerResponseParams struct {
	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.