v20220110

package
v1.0.940 Latest Latest
Warning

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

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

Documentation

Index

Constants

View Source 
const (

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

	// 未申请并发或申请后超时。
	FAILEDOPERATION_LOCKTIMEOUT = "FailedOperation.LockTimeout"

	// 路径无法找到
	FAILEDOPERATION_PATHNOTFOUND = "FailedOperation.PathNotFound"

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

	// 该UserId请求正在处理中，请稍后再试。
	FAILEDOPERATION_SLOWDOWN = "FailedOperation.SlowDown"

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

	// 参数错误。
	INVALIDPARAMETER = "InvalidParameter"

	// 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_STOPPING = "UnsupportedOperation.Stopping"
)
View Source 
const APIVersion = "2022-01-10"

Variables

This section is empty.

Functions

This section is empty.

Types

type ApplyConcurrentRequest 

type ApplyConcurrentRequest struct {
	*tchttp.BaseRequest

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

	// 用户IP，用户客户端的公网IP，用于就近调度
	UserIp *string `json:"UserIp,omitnil,omitempty" name:"UserIp"`

	// 项目ID
	ProjectId *string `json:"ProjectId,omitnil,omitempty" name:"ProjectId"`

	// 应用版本ID。如果请求应用的当前版本，可以不用填写该字段。如果请求应用的其它版本时，才需要通过该字段来指定应用的版本。
	ApplicationVersionId *string `json:"ApplicationVersionId,omitnil,omitempty" name:"ApplicationVersionId"`

	// 应用ID。如果是独享项目，将忽略该参数，使用项目绑定的应用。如果是共享项目，使用该参数来指定应用。
	ApplicationId *string `json:"ApplicationId,omitnil,omitempty" name:"ApplicationId"`
}

func NewApplyConcurrentRequest 

func NewApplyConcurrentRequest() (request *ApplyConcurrentRequest)

func (*ApplyConcurrentRequest) FromJsonString 

func (r *ApplyConcurrentRequest) 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 (*ApplyConcurrentRequest) ToJsonString 

func (r *ApplyConcurrentRequest) ToJsonString() string

type ApplyConcurrentRequestParams added in v1.0.426 

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

	// 用户IP，用户客户端的公网IP，用于就近调度
	UserIp *string `json:"UserIp,omitnil,omitempty" name:"UserIp"`

	// 项目ID
	ProjectId *string `json:"ProjectId,omitnil,omitempty" name:"ProjectId"`

	// 应用版本ID。如果请求应用的当前版本，可以不用填写该字段。如果请求应用的其它版本时，才需要通过该字段来指定应用的版本。
	ApplicationVersionId *string `json:"ApplicationVersionId,omitnil,omitempty" name:"ApplicationVersionId"`

	// 应用ID。如果是独享项目，将忽略该参数，使用项目绑定的应用。如果是共享项目，使用该参数来指定应用。
	ApplicationId *string `json:"ApplicationId,omitnil,omitempty" name:"ApplicationId"`
}

Predefined struct for user

type ApplyConcurrentResponse 

type ApplyConcurrentResponse struct {
	*tchttp.BaseResponse
	Response *ApplyConcurrentResponseParams `json:"Response"`
}

func NewApplyConcurrentResponse 

func NewApplyConcurrentResponse() (response *ApplyConcurrentResponse)

func (*ApplyConcurrentResponse) FromJsonString 

func (r *ApplyConcurrentResponse) 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 (*ApplyConcurrentResponse) ToJsonString 

func (r *ApplyConcurrentResponse) ToJsonString() string

type ApplyConcurrentResponseParams added in v1.0.426 

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

Predefined struct for user

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) ApplyConcurrent 

func (c *Client) ApplyConcurrent(request *ApplyConcurrentRequest) (response *ApplyConcurrentResponse, err error)

ApplyConcurrent 本接口用于申请并发。接口超时时间：20秒。

可能返回的错误码: 

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) ApplyConcurrentWithContext 

func (c *Client) ApplyConcurrentWithContext(ctx context.Context, request *ApplyConcurrentRequest) (response *ApplyConcurrentResponse, err error)

ApplyConcurrent 本接口用于申请并发。接口超时时间：20秒。

可能返回的错误码: 

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) CreateSession 

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

CreateSession 本接口用于创建会话。接口超时时间：5秒。

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_LOCKTIMEOUT = "FailedOperation.LockTimeout"
FAILEDOPERATION_PATHNOTFOUND = "FailedOperation.PathNotFound"
FAILEDOPERATION_PROCESSTIMEOUT = "FailedOperation.ProcessTimeout"
FAILEDOPERATION_SLOWDOWN = "FailedOperation.SlowDown"
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 

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

CreateSession 本接口用于创建会话。接口超时时间：5秒。

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_LOCKTIMEOUT = "FailedOperation.LockTimeout"
FAILEDOPERATION_PATHNOTFOUND = "FailedOperation.PathNotFound"
FAILEDOPERATION_PROCESSTIMEOUT = "FailedOperation.ProcessTimeout"
FAILEDOPERATION_SLOWDOWN = "FailedOperation.SlowDown"
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) DestroySession 

func (c *Client) DestroySession(request *DestroySessionRequest) (response *DestroySessionResponse, err error)

DestroySession 销毁会话。如果该会话开启了云端推流，那么销毁会话时会结束云端推流。

可能返回的错误码: 

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

func (*Client) DestroySessionWithContext 

func (c *Client) DestroySessionWithContext(ctx context.Context, request *DestroySessionRequest) (response *DestroySessionResponse, err error)

DestroySession 销毁会话。如果该会话开启了云端推流，那么销毁会话时会结束云端推流。

可能返回的错误码: 

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

func (*Client) StartPublishStream added in v1.0.629 

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

StartPublishStream 开始云端推流。云端推流 codec 根据客户端（SDK）能力来自动选择，默认优先顺序为 H265、H264、VP8、VP9。

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND_SESSIONNOTFOUND = "ResourceNotFound.SessionNotFound"

func (*Client) StartPublishStreamWithContext added in v1.0.629 

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

StartPublishStream 开始云端推流。云端推流 codec 根据客户端（SDK）能力来自动选择，默认优先顺序为 H265、H264、VP8、VP9。

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND_SESSIONNOTFOUND = "ResourceNotFound.SessionNotFound"

func (*Client) StartPublishStreamWithURL added in v1.0.753 

func (c *Client) StartPublishStreamWithURL(request *StartPublishStreamWithURLRequest) (response *StartPublishStreamWithURLResponse, err error)

StartPublishStreamWithURL 开始云端推流到指定URL。云端推流 codec 根据客户端（SDK）能力来自动选择，默认优先顺序为 H265、H264、VP8、VP9。该推流方式需要单独计费，详细计费方式请查看[指定地址推流费用说明](https://cloud.tencent.com/document/product/1547/72168#98ac188a-d122-4caf-88be-05268ecefdf6)

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND_SESSIONNOTFOUND = "ResourceNotFound.SessionNotFound"

func (*Client) StartPublishStreamWithURLWithContext added in v1.0.753 

func (c *Client) StartPublishStreamWithURLWithContext(ctx context.Context, request *StartPublishStreamWithURLRequest) (response *StartPublishStreamWithURLResponse, err error)

StartPublishStreamWithURL 开始云端推流到指定URL。云端推流 codec 根据客户端（SDK）能力来自动选择，默认优先顺序为 H265、H264、VP8、VP9。该推流方式需要单独计费，详细计费方式请查看[指定地址推流费用说明](https://cloud.tencent.com/document/product/1547/72168#98ac188a-d122-4caf-88be-05268ecefdf6)

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND_SESSIONNOTFOUND = "ResourceNotFound.SessionNotFound"

func (*Client) StopPublishStream added in v1.0.629 

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

StopPublishStream 停止云端推流

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND_SESSIONNOTFOUND = "ResourceNotFound.SessionNotFound"

func (*Client) StopPublishStreamWithContext added in v1.0.629 

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

StopPublishStream 停止云端推流

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND_SESSIONNOTFOUND = "ResourceNotFound.SessionNotFound"

type CreateSessionRequest 

type CreateSessionRequest struct {
	*tchttp.BaseRequest

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

	// 用户IP，用户客户端的公网IP，用于就近调度
	UserIp *string `json:"UserIp,omitnil,omitempty" name:"UserIp"`

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

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

	// 应用启动参数。
	// 如果请求的是多应用共享项目，此参数生效；
	// 如果请求的是关闭预启动的单应用独享项目，此参数生效；
	// 如果请求的是开启预启动的单应用独享项目，此参数失效。
	//
	// 注意：在此参数生效的情况下，将会被追加到控制台应用或项目配置的启动参数的后面。
	// 例如，对于某关闭预启动的单应用独享项目，若在控制台中项目配置的启动参数为bar=0，而ApplicationParameters参数为foo=1，则实际应用启动参数为bar=0 foo=1。
	ApplicationParameters *string `json:"ApplicationParameters,omitnil,omitempty" name:"ApplicationParameters"`

	// 【多人互动】房主用户ID，在多人互动模式下为必填字段。
	// 如果该用户是房主，HostUserId需要和UserId保持一致；
	// 如果该用户非房主，HostUserId需要填写房主的HostUserId。
	HostUserId *string `json:"HostUserId,omitnil,omitempty" name:"HostUserId"`

	// 【多人互动】角色。
	// Player：玩家（可通过键鼠等操作应用）
	// Viewer：观察者（只能观看，无法操作）
	Role *string `json:"Role,omitnil,omitempty" name:"Role"`
}

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"`

	// 用户IP，用户客户端的公网IP，用于就近调度
	UserIp *string `json:"UserIp,omitnil,omitempty" name:"UserIp"`

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

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

	// 应用启动参数。
	// 如果请求的是多应用共享项目，此参数生效；
	// 如果请求的是关闭预启动的单应用独享项目，此参数生效；
	// 如果请求的是开启预启动的单应用独享项目，此参数失效。
	//
	// 注意：在此参数生效的情况下，将会被追加到控制台应用或项目配置的启动参数的后面。
	// 例如，对于某关闭预启动的单应用独享项目，若在控制台中项目配置的启动参数为bar=0，而ApplicationParameters参数为foo=1，则实际应用启动参数为bar=0 foo=1。
	ApplicationParameters *string `json:"ApplicationParameters,omitnil,omitempty" name:"ApplicationParameters"`

	// 【多人互动】房主用户ID，在多人互动模式下为必填字段。
	// 如果该用户是房主，HostUserId需要和UserId保持一致；
	// 如果该用户非房主，HostUserId需要填写房主的HostUserId。
	HostUserId *string `json:"HostUserId,omitnil,omitempty" name:"HostUserId"`

	// 【多人互动】角色。
	// Player：玩家（可通过键鼠等操作应用）
	// Viewer：观察者（只能观看，无法操作）
	Role *string `json:"Role,omitnil,omitempty" name:"Role"`
}

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信息，返回给SDK
	ServerSession *string `json:"ServerSession,omitnil,omitempty" name:"ServerSession"`

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

Predefined struct for user

type DestroySessionRequest 

type DestroySessionRequest struct {
	*tchttp.BaseRequest

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

func NewDestroySessionRequest 

func NewDestroySessionRequest() (request *DestroySessionRequest)

func (*DestroySessionRequest) FromJsonString 

func (r *DestroySessionRequest) 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 (*DestroySessionRequest) ToJsonString 

func (r *DestroySessionRequest) ToJsonString() string

type DestroySessionRequestParams added in v1.0.426 

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

Predefined struct for user

type DestroySessionResponse 

type DestroySessionResponse struct {
	*tchttp.BaseResponse
	Response *DestroySessionResponseParams `json:"Response"`
}

func NewDestroySessionResponse 

func NewDestroySessionResponse() (response *DestroySessionResponse)

func (*DestroySessionResponse) FromJsonString 

func (r *DestroySessionResponse) 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 (*DestroySessionResponse) ToJsonString 

func (r *DestroySessionResponse) ToJsonString() string

type DestroySessionResponseParams added in v1.0.426 

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

Predefined struct for user

type StartPublishStreamRequest added in v1.0.629 

type StartPublishStreamRequest struct {
	*tchttp.BaseRequest

	// 唯一用户身份标识，由业务方自定义，平台不予理解。（UserId将作为StreamId进行推流，比如绑定推流域名为abc.livepush.myqcloud.com，那么推流地址为rtmp://abc.livepush.myqcloud.com/live/UserId?txSecret=xxx&txTime=xxx）
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

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

func NewStartPublishStreamRequest added in v1.0.629 

func NewStartPublishStreamRequest() (request *StartPublishStreamRequest)

func (*StartPublishStreamRequest) FromJsonString added in v1.0.629 

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.629 

func (r *StartPublishStreamRequest) ToJsonString() string

type StartPublishStreamRequestParams added in v1.0.629 

type StartPublishStreamRequestParams struct {
	// 唯一用户身份标识，由业务方自定义，平台不予理解。（UserId将作为StreamId进行推流，比如绑定推流域名为abc.livepush.myqcloud.com，那么推流地址为rtmp://abc.livepush.myqcloud.com/live/UserId?txSecret=xxx&txTime=xxx）
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

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

Predefined struct for user

type StartPublishStreamResponse added in v1.0.629 

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

func NewStartPublishStreamResponse added in v1.0.629 

func NewStartPublishStreamResponse() (response *StartPublishStreamResponse)

func (*StartPublishStreamResponse) FromJsonString added in v1.0.629 

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.629 

func (r *StartPublishStreamResponse) ToJsonString() string

type StartPublishStreamResponseParams added in v1.0.629 

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

Predefined struct for user

type StartPublishStreamWithURLRequest added in v1.0.753 

type StartPublishStreamWithURLRequest struct {
	*tchttp.BaseRequest

	// 唯一用户身份标识，由业务方自定义，平台不予理解。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

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

func NewStartPublishStreamWithURLRequest added in v1.0.753 

func NewStartPublishStreamWithURLRequest() (request *StartPublishStreamWithURLRequest)

func (*StartPublishStreamWithURLRequest) FromJsonString added in v1.0.753 

func (r *StartPublishStreamWithURLRequest) 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 (*StartPublishStreamWithURLRequest) ToJsonString added in v1.0.753 

func (r *StartPublishStreamWithURLRequest) ToJsonString() string

type StartPublishStreamWithURLRequestParams added in v1.0.753 

type StartPublishStreamWithURLRequestParams struct {
	// 唯一用户身份标识，由业务方自定义，平台不予理解。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

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

Predefined struct for user

type StartPublishStreamWithURLResponse added in v1.0.753 

type StartPublishStreamWithURLResponse struct {
	*tchttp.BaseResponse
	Response *StartPublishStreamWithURLResponseParams `json:"Response"`
}

func NewStartPublishStreamWithURLResponse added in v1.0.753 

func NewStartPublishStreamWithURLResponse() (response *StartPublishStreamWithURLResponse)

func (*StartPublishStreamWithURLResponse) FromJsonString added in v1.0.753 

func (r *StartPublishStreamWithURLResponse) 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 (*StartPublishStreamWithURLResponse) ToJsonString added in v1.0.753 

func (r *StartPublishStreamWithURLResponse) ToJsonString() string

type StartPublishStreamWithURLResponseParams added in v1.0.753 

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

Predefined struct for user

type StopPublishStreamRequest added in v1.0.629 

type StopPublishStreamRequest struct {
	*tchttp.BaseRequest

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

func NewStopPublishStreamRequest added in v1.0.629 

func NewStopPublishStreamRequest() (request *StopPublishStreamRequest)

func (*StopPublishStreamRequest) FromJsonString added in v1.0.629 

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.629 

func (r *StopPublishStreamRequest) ToJsonString() string

type StopPublishStreamRequestParams added in v1.0.629 

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

Predefined struct for user

type StopPublishStreamResponse added in v1.0.629 

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

func NewStopPublishStreamResponse added in v1.0.629 

func NewStopPublishStreamResponse() (response *StopPublishStreamResponse)

func (*StopPublishStreamResponse) FromJsonString added in v1.0.629 

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.629 

func (r *StopPublishStreamResponse) ToJsonString() string

type StopPublishStreamResponseParams added in v1.0.629 

type StopPublishStreamResponseParams 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.