v20220110

package
v3.0.992+incompatible Latest Latest
Warning

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

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

Documentation

Index

Constants

View Source 
const (

	// Operation failed.
	FAILEDOPERATION = "FailedOperation"

	// Concurrency quota not requested or request timed out.
	FAILEDOPERATION_LOCKTIMEOUT = "FailedOperation.LockTimeout"

	// Failed to find the path.
	FAILEDOPERATION_PATHNOTFOUND = "FailedOperation.PathNotFound"

	// Processing timed out.
	FAILEDOPERATION_PROCESSTIMEOUT = "FailedOperation.ProcessTimeout"

	// The request for the current `UserId` is being processed. Try again later.
	FAILEDOPERATION_SLOWDOWN = "FailedOperation.SlowDown"

	// Internal error.
	INTERNALERROR = "InternalError"

	// Parameter error.
	INVALIDPARAMETER = "InvalidParameter"

	// JSON parsing error.
	INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"

	// Invalid parameter value.
	INVALIDPARAMETERVALUE = "InvalidParameterValue"

	// The number of roles in a **multi-person interaction** scenario exceeds the limit.
	LIMITEXCEEDED_ROLE = "LimitExceeded.Role"

	// Operation denied.
	OPERATIONDENIED = "OperationDenied"

	// No available concurrency quota.
	RESOURCENOTFOUND_NOIDLE = "ResourceNotFound.NoIdle"

	// Unable to find the session.
	RESOURCENOTFOUND_SESSIONNOTFOUND = "ResourceNotFound.SessionNotFound"

	// Failed to access the concurrency instance.
	RESOURCEUNAVAILABLE_ACCESSFAILED = "ResourceUnavailable.AccessFailed"

	// The instance is being initialized.
	RESOURCEUNAVAILABLE_INITIALIZATION = "ResourceUnavailable.Initialization"

	// The session is being terminated.
	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

	// The user’s unique ID. Tencent Cloud does not parse the ID. You need to manage your own user IDs. Based on your needs, you can either define unique IDs for users or use timestamps to generate random IDs. Make sure the same ID is used when a user reconnects to your application.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// Public IP of user’s application client, which is used for nearby scheduling.
	UserIp *string `json:"UserIp,omitnil,omitempty" name:"UserIp"`

	// The project ID.
	ProjectId *string `json:"ProjectId,omitnil,omitempty" name:"ProjectId"`

	// Application version ID. If the application of the current version is requested, you do not need to fill in this field. If the application of other versions is requested, you need to specify the version through this field.
	ApplicationVersionId *string `json:"ApplicationVersionId,omitnil,omitempty" name:"ApplicationVersionId"`

	// Application ID, which is used only by the multi-application project to specify applications. For a single-application project, this parameter is ignored, and the application bound to the project will be used.
	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 

type ApplyConcurrentRequestParams struct {
	// The user’s unique ID. Tencent Cloud does not parse the ID. You need to manage your own user IDs. Based on your needs, you can either define unique IDs for users or use timestamps to generate random IDs. Make sure the same ID is used when a user reconnects to your application.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// Public IP of user’s application client, which is used for nearby scheduling.
	UserIp *string `json:"UserIp,omitnil,omitempty" name:"UserIp"`

	// The project ID.
	ProjectId *string `json:"ProjectId,omitnil,omitempty" name:"ProjectId"`

	// Application version ID. If the application of the current version is requested, you do not need to fill in this field. If the application of other versions is requested, you need to specify the version through this field.
	ApplicationVersionId *string `json:"ApplicationVersionId,omitnil,omitempty" name:"ApplicationVersionId"`

	// Application ID, which is used only by the multi-application project to specify applications. For a single-application project, this parameter is ignored, and the application bound to the project will be used.
	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 

type ApplyConcurrentResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	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 This API is used to request a concurrency. The timeout period of the API is 20 seconds.

error code that may be returned: 

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 This API is used to request a concurrency. The timeout period of the API is 20 seconds.

error code that may be returned: 

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 This API is used to create a session. The timeout period of the API is 5 seconds.

error code that may be returned: 

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 This API is used to create a session. The timeout period of the API is 5 seconds.

error code that may be returned: 

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

func (c *Client) DescribeConcurrentCount(request *DescribeConcurrentCountRequest) (response *DescribeConcurrentCountResponse, err error)

DescribeConcurrentCount Obtain the concurrency count.

error code that may be returned: 

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

func (c *Client) DescribeConcurrentCountWithContext(ctx context.Context, request *DescribeConcurrentCountRequest) (response *DescribeConcurrentCountResponse, err error)

DescribeConcurrentCount Obtain the concurrency count.

error code that may be returned: 

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 Terminate the session. If stream push has been initiated in this session, then the stream push will end upon session termination.

error code that may be returned: 

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 Terminate the session. If stream push has been initiated in this session, then the stream push will end upon session termination.

error code that may be returned: 

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

func (*Client) StartPublishStream 

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

StartPublishStream Initiate stream push. The codec for the stream push is automatically adjusted based on the client's (SDK) capabilities, with a default order of H265, H264, VP8, and VP9.

error code that may be returned: 

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

func (*Client) StartPublishStreamWithContext 

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

StartPublishStream Initiate stream push. The codec for the stream push is automatically adjusted based on the client's (SDK) capabilities, with a default order of H265, H264, VP8, and VP9.

error code that may be returned: 

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

func (*Client) StartPublishStreamWithURL 

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

StartPublishStreamWithURL Initiate stream push to the specified URL. The codec for the stream push is automatically adjusted based on the client's (SDK) capabilities, with a default order of H265, H264, VP8, and VP9. This stream push method will be charged separately. For details about the charging method, see [Charging for Stream Push to Specified URL](https://intl.cloud.tencent.com/document/product/1547/72168?from_cn_redirect=1#98ac188a-d122-4caf-88be-05268ecefdf6).

error code that may be returned: 

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

func (*Client) StartPublishStreamWithURLWithContext 

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

StartPublishStreamWithURL Initiate stream push to the specified URL. The codec for the stream push is automatically adjusted based on the client's (SDK) capabilities, with a default order of H265, H264, VP8, and VP9. This stream push method will be charged separately. For details about the charging method, see [Charging for Stream Push to Specified URL](https://intl.cloud.tencent.com/document/product/1547/72168?from_cn_redirect=1#98ac188a-d122-4caf-88be-05268ecefdf6).

error code that may be returned: 

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

func (*Client) StopPublishStream 

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

StopPublishStream This API is used to stop stream push.

error code that may be returned: 

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

func (*Client) StopPublishStreamWithContext 

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

StopPublishStream This API is used to stop stream push.

error code that may be returned: 

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

type CreateSessionRequest 

type CreateSessionRequest struct {
	*tchttp.BaseRequest

	// The user’s unique ID. Tencent Cloud does not parse the ID. You need to manage your own user IDs. Based on your needs, you can either define unique IDs for users or use timestamps to generate random IDs. Make sure the same ID is used when a user reconnects to your application.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// Public IP of user’s application client, which is used for nearby scheduling.
	UserIp *string `json:"UserIp,omitnil,omitempty" name:"UserIp"`

	// The client-side session data, which is obtained from the SDK. If `RunMode` is `RunWithoutClient`, this parameter can be null.
	ClientSession *string `json:"ClientSession,omitnil,omitempty" name:"ClientSession"`

	// The on-cloud running mode.
	// `RunWithoutClient`: Keep the application running on the cloud even when there are no client connections.
	// Empty string (default): Keep the application running on the cloud only when there are client connections.
	RunMode *string `json:"RunMode,omitnil,omitempty" name:"RunMode"`

	// Application startup parameter.
	// If the user requests a multi-application project or a prelaunch-disabled single-application project, this parameter takes effect.
	//
	// If the user requests a prelaunch-enabled single-application project, this parameter is invalid.
	//
	// Note: When this parameter takes effect, the `ApplicationParameters` parameter will be appended to the end of the application startup parameter. The application startup parameter is set in the application or project configuration in the console.
	// For example, for a prelaunch-disabled single-application project, if its application startup parameter `bar` is `0` and the `ApplicationParameters` parameter `foo` is `1`, the actual application startup parameters will be `bar=0 foo=1`.
	ApplicationParameters *string `json:"ApplicationParameters,omitnil,omitempty" name:"ApplicationParameters"`

	// The user ID of the host in **multi-person interaction** scenarios, which is required.
	// If the current user is the host, `HostUserId` must be the same as their `UserId`; otherwise, `HostUserId` should be the host's `UserId`.
	HostUserId *string `json:"HostUserId,omitnil,omitempty" name:"HostUserId"`

	// The role in **multi-person interaction** scenarios. Valid values:
	// `Player`: A user who can operate an application by using a keyboard and mouse
	// `Viewer`: A user who can only watch the video in the room but cannot operate the application
	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 

type CreateSessionRequestParams struct {
	// The user’s unique ID. Tencent Cloud does not parse the ID. You need to manage your own user IDs. Based on your needs, you can either define unique IDs for users or use timestamps to generate random IDs. Make sure the same ID is used when a user reconnects to your application.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// Public IP of user’s application client, which is used for nearby scheduling.
	UserIp *string `json:"UserIp,omitnil,omitempty" name:"UserIp"`

	// The client-side session data, which is obtained from the SDK. If `RunMode` is `RunWithoutClient`, this parameter can be null.
	ClientSession *string `json:"ClientSession,omitnil,omitempty" name:"ClientSession"`

	// The on-cloud running mode.
	// `RunWithoutClient`: Keep the application running on the cloud even when there are no client connections.
	// Empty string (default): Keep the application running on the cloud only when there are client connections.
	RunMode *string `json:"RunMode,omitnil,omitempty" name:"RunMode"`

	// Application startup parameter.
	// If the user requests a multi-application project or a prelaunch-disabled single-application project, this parameter takes effect.
	//
	// If the user requests a prelaunch-enabled single-application project, this parameter is invalid.
	//
	// Note: When this parameter takes effect, the `ApplicationParameters` parameter will be appended to the end of the application startup parameter. The application startup parameter is set in the application or project configuration in the console.
	// For example, for a prelaunch-disabled single-application project, if its application startup parameter `bar` is `0` and the `ApplicationParameters` parameter `foo` is `1`, the actual application startup parameters will be `bar=0 foo=1`.
	ApplicationParameters *string `json:"ApplicationParameters,omitnil,omitempty" name:"ApplicationParameters"`

	// The user ID of the host in **multi-person interaction** scenarios, which is required.
	// If the current user is the host, `HostUserId` must be the same as their `UserId`; otherwise, `HostUserId` should be the host's `UserId`.
	HostUserId *string `json:"HostUserId,omitnil,omitempty" name:"HostUserId"`

	// The role in **multi-person interaction** scenarios. Valid values:
	// `Player`: A user who can operate an application by using a keyboard and mouse
	// `Viewer`: A user who can only watch the video in the room but cannot operate the application
	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 

type CreateSessionResponseParams struct {
	// The server-side session data, which is returned to the SDK.
	ServerSession *string `json:"ServerSession,omitnil,omitempty" name:"ServerSession"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeConcurrentCountRequest 

type DescribeConcurrentCountRequest struct {
	*tchttp.BaseRequest

	// Project ID
	ProjectId *string `json:"ProjectId,omitnil,omitempty" name:"ProjectId"`
}

func NewDescribeConcurrentCountRequest 

func NewDescribeConcurrentCountRequest() (request *DescribeConcurrentCountRequest)

func (*DescribeConcurrentCountRequest) FromJsonString 

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

func (r *DescribeConcurrentCountRequest) ToJsonString() string

type DescribeConcurrentCountRequestParams 

type DescribeConcurrentCountRequestParams struct {
	// Project ID
	ProjectId *string `json:"ProjectId,omitnil,omitempty" name:"ProjectId"`
}

Predefined struct for user

type DescribeConcurrentCountResponse 

type DescribeConcurrentCountResponse struct {
	*tchttp.BaseResponse
	Response *DescribeConcurrentCountResponseParams `json:"Response"`
}

func NewDescribeConcurrentCountResponse 

func NewDescribeConcurrentCountResponse() (response *DescribeConcurrentCountResponse)

func (*DescribeConcurrentCountResponse) FromJsonString 

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

func (r *DescribeConcurrentCountResponse) ToJsonString() string

type DescribeConcurrentCountResponseParams 

type DescribeConcurrentCountResponseParams struct {
	// Total Concurrency Count
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`

	// The number of concurrent executions, including those in pre-launch, connected, waiting for reconnection, to be cleaned up or recovered, and all non-idle concurrent executions. Therefore, refreshing projects or disconnecting user connections with concurrency packages will affect this value.
	Running *uint64 `json:"Running,omitnil,omitempty" name:"Running"`

	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DestroySessionRequest 

type DestroySessionRequest struct {
	*tchttp.BaseRequest

	// The user’s unique ID. Tencent Cloud does not parse the ID. You need to manage your own user IDs. Based on your needs, you can either define unique IDs for users or use timestamps to generate random IDs. Make sure the same ID is used when a user reconnects to your application.
	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 

type DestroySessionRequestParams struct {
	// The user’s unique ID. Tencent Cloud does not parse the ID. You need to manage your own user IDs. Based on your needs, you can either define unique IDs for users or use timestamps to generate random IDs. Make sure the same ID is used when a user reconnects to your application.
	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 

type DestroySessionResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type StartPublishStreamRequest 

type StartPublishStreamRequest struct {
	*tchttp.BaseRequest

	// Unique user ID, which is customized by you and is not understood by CAR. It will be used as the `StreamId` for pushing streams. For example, if the bound push domain is **abc.livepush.myqcloud.com**, the push address will be **rtmp://abc.livepush.myqcloud.com/live/UserId?txSecret=xxx&txTime=xxx**.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// Push parameter, which is a custom parameter carried during stream pushing.
	PublishStreamArgs *string `json:"PublishStreamArgs,omitnil,omitempty" name:"PublishStreamArgs"`
}

func NewStartPublishStreamRequest 

func NewStartPublishStreamRequest() (request *StartPublishStreamRequest)

func (*StartPublishStreamRequest) FromJsonString 

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 

func (r *StartPublishStreamRequest) ToJsonString() string

type StartPublishStreamRequestParams 

type StartPublishStreamRequestParams struct {
	// Unique user ID, which is customized by you and is not understood by CAR. It will be used as the `StreamId` for pushing streams. For example, if the bound push domain is **abc.livepush.myqcloud.com**, the push address will be **rtmp://abc.livepush.myqcloud.com/live/UserId?txSecret=xxx&txTime=xxx**.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// Push parameter, which is a custom parameter carried during stream pushing.
	PublishStreamArgs *string `json:"PublishStreamArgs,omitnil,omitempty" name:"PublishStreamArgs"`
}

Predefined struct for user

type StartPublishStreamResponse 

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

func NewStartPublishStreamResponse 

func NewStartPublishStreamResponse() (response *StartPublishStreamResponse)

func (*StartPublishStreamResponse) FromJsonString 

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 

func (r *StartPublishStreamResponse) ToJsonString() string

type StartPublishStreamResponseParams 

type StartPublishStreamResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type StartPublishStreamWithURLRequest 

type StartPublishStreamWithURLRequest struct {
	*tchttp.BaseRequest

	// Unique user ID, which is customized by you and is not understood by CAR.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// Push address. Only RTMP is supported for push currently.
	PublishStreamURL *string `json:"PublishStreamURL,omitnil,omitempty" name:"PublishStreamURL"`
}

func NewStartPublishStreamWithURLRequest 

func NewStartPublishStreamWithURLRequest() (request *StartPublishStreamWithURLRequest)

func (*StartPublishStreamWithURLRequest) FromJsonString 

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 

func (r *StartPublishStreamWithURLRequest) ToJsonString() string

type StartPublishStreamWithURLRequestParams 

type StartPublishStreamWithURLRequestParams struct {
	// Unique user ID, which is customized by you and is not understood by CAR.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// Push address. Only RTMP is supported for push currently.
	PublishStreamURL *string `json:"PublishStreamURL,omitnil,omitempty" name:"PublishStreamURL"`
}

Predefined struct for user

type StartPublishStreamWithURLResponse 

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

func NewStartPublishStreamWithURLResponse 

func NewStartPublishStreamWithURLResponse() (response *StartPublishStreamWithURLResponse)

func (*StartPublishStreamWithURLResponse) FromJsonString 

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 

func (r *StartPublishStreamWithURLResponse) ToJsonString() string

type StartPublishStreamWithURLResponseParams 

type StartPublishStreamWithURLResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type StopPublishStreamRequest 

type StopPublishStreamRequest struct {
	*tchttp.BaseRequest

	// Unique user ID, which is customized by you and is not understood by CAR. It can also be randomly generated using the timestamp and should be kept unchanged during user reconnection.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`
}

func NewStopPublishStreamRequest 

func NewStopPublishStreamRequest() (request *StopPublishStreamRequest)

func (*StopPublishStreamRequest) FromJsonString 

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 

func (r *StopPublishStreamRequest) ToJsonString() string

type StopPublishStreamRequestParams 

type StopPublishStreamRequestParams struct {
	// Unique user ID, which is customized by you and is not understood by CAR. It can also be randomly generated using the timestamp and should be kept unchanged during user reconnection.
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`
}

Predefined struct for user

type StopPublishStreamResponse 

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

func NewStopPublishStreamResponse 

func NewStopPublishStreamResponse() (response *StopPublishStreamResponse)

func (*StopPublishStreamResponse) FromJsonString 

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 

func (r *StopPublishStreamResponse) ToJsonString() string

type StopPublishStreamResponseParams 

type StopPublishStreamResponseParams struct {
	// The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
	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.