v20220527

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 (

	// CAM签名/鉴权错误。
	AUTHFAILURE = "AuthFailure"

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

	// 交易流水号重复
	FAILEDOPERATION_DUPLICATETRADESERIALNO = "FailedOperation.DuplicateTradeSerialNo"

	// 直播会员已经过期
	FAILEDOPERATION_USERLIVEVIPTIMEEXPIRE = "FailedOperation.UserLiveVipTimeExpire"

	// 非直播会员用户
	FAILEDOPERATION_USERNOTLIVEVIP = "FailedOperation.UserNotLiveVip"

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

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

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

	// 缺少参数错误。
	MISSINGPARAMETER = "MissingParameter"

	// 资源不存在。
	RESOURCENOTFOUND = "ResourceNotFound"

	// 资源不可用。
	RESOURCEUNAVAILABLE = "ResourceUnavailable"
)
View Source 
const APIVersion = "2022-05-27"

Variables

This section is empty.

Functions

This section is empty.

Types

type AMEMusicBaseInfo added in v1.0.567 

type AMEMusicBaseInfo struct {
	// 歌曲 Id。
	MusicId *string `json:"MusicId,omitnil,omitempty" name:"MusicId"`

	// 歌曲名称。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 歌手列表。
	SingerSet []*string `json:"SingerSet,omitnil,omitempty" name:"SingerSet"`
}

type ApplyChorusRequest added in v1.0.575 

type ApplyChorusRequest struct {
	*tchttp.BaseRequest

	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 房间号。
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 歌曲 Id。
	MusicId *string `json:"MusicId,omitnil,omitempty" name:"MusicId"`

	// 最大合唱人数，默认值为 8，最大值为 20。
	MaxChorusNum *uint64 `json:"MaxChorusNum,omitnil,omitempty" name:"MaxChorusNum"`

	// 合唱用户标识列表。
	ChorusUserIds []*string `json:"ChorusUserIds,omitnil,omitempty" name:"ChorusUserIds"`
}

func NewApplyChorusRequest added in v1.0.575 

func NewApplyChorusRequest() (request *ApplyChorusRequest)

func (*ApplyChorusRequest) FromJsonString added in v1.0.575 

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

func (r *ApplyChorusRequest) ToJsonString() string

type ApplyChorusRequestParams added in v1.0.575 

type ApplyChorusRequestParams struct {
	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 房间号。
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 歌曲 Id。
	MusicId *string `json:"MusicId,omitnil,omitempty" name:"MusicId"`

	// 最大合唱人数，默认值为 8，最大值为 20。
	MaxChorusNum *uint64 `json:"MaxChorusNum,omitnil,omitempty" name:"MaxChorusNum"`

	// 合唱用户标识列表。
	ChorusUserIds []*string `json:"ChorusUserIds,omitnil,omitempty" name:"ChorusUserIds"`
}

Predefined struct for user

type ApplyChorusResponse added in v1.0.575 

type ApplyChorusResponse struct {
	*tchttp.BaseResponse
	Response *ApplyChorusResponseParams `json:"Response"`
}

func NewApplyChorusResponse added in v1.0.575 

func NewApplyChorusResponse() (response *ApplyChorusResponse)

func (*ApplyChorusResponse) FromJsonString added in v1.0.575 

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

func (r *ApplyChorusResponse) ToJsonString() string

type ApplyChorusResponseParams added in v1.0.575 

type ApplyChorusResponseParams struct {
	// 合唱 Token。
	ChorusToken *string `json:"ChorusToken,omitnil,omitempty" name:"ChorusToken"`

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

Predefined struct for user

type BatchDescribeKTVMusicDetailsRequest 

type BatchDescribeKTVMusicDetailsRequest struct {
	*tchttp.BaseRequest

	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 歌曲 Id 列表。
	MusicIds []*string `json:"MusicIds,omitnil,omitempty" name:"MusicIds"`

	// 播放场景。默认为Chat
	// <li>Live：直播</li><li>Chat：语聊</li>
	PlayScene *string `json:"PlayScene,omitnil,omitempty" name:"PlayScene"`

	// 玩家用户标识
	GuestUserId *string `json:"GuestUserId,omitnil,omitempty" name:"GuestUserId"`

	// 房间Id
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`
}

func NewBatchDescribeKTVMusicDetailsRequest 

func NewBatchDescribeKTVMusicDetailsRequest() (request *BatchDescribeKTVMusicDetailsRequest)

func (*BatchDescribeKTVMusicDetailsRequest) FromJsonString 

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

func (r *BatchDescribeKTVMusicDetailsRequest) ToJsonString() string

type BatchDescribeKTVMusicDetailsRequestParams 

type BatchDescribeKTVMusicDetailsRequestParams struct {
	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 歌曲 Id 列表。
	MusicIds []*string `json:"MusicIds,omitnil,omitempty" name:"MusicIds"`

	// 播放场景。默认为Chat
	// <li>Live：直播</li><li>Chat：语聊</li>
	PlayScene *string `json:"PlayScene,omitnil,omitempty" name:"PlayScene"`

	// 玩家用户标识
	GuestUserId *string `json:"GuestUserId,omitnil,omitempty" name:"GuestUserId"`

	// 房间Id
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`
}

Predefined struct for user

type BatchDescribeKTVMusicDetailsResponse 

type BatchDescribeKTVMusicDetailsResponse struct {
	*tchttp.BaseResponse
	Response *BatchDescribeKTVMusicDetailsResponseParams `json:"Response"`
}

func NewBatchDescribeKTVMusicDetailsResponse 

func NewBatchDescribeKTVMusicDetailsResponse() (response *BatchDescribeKTVMusicDetailsResponse)

func (*BatchDescribeKTVMusicDetailsResponse) FromJsonString 

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

func (r *BatchDescribeKTVMusicDetailsResponse) ToJsonString() string

type BatchDescribeKTVMusicDetailsResponseParams 

type BatchDescribeKTVMusicDetailsResponseParams struct {
	// 歌曲详细信息列表。
	KTVMusicDetailInfoSet []*KTVMusicDetailInfo `json:"KTVMusicDetailInfoSet,omitnil,omitempty" name:"KTVMusicDetailInfoSet"`

	// 不存在歌曲Id列表。
	NotExistMusicIdSet []*string `json:"NotExistMusicIdSet,omitnil,omitempty" name:"NotExistMusicIdSet"`

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

Predefined struct for user

type ChorusClip 

type ChorusClip struct {
	// 开始时间，单位：毫秒。
	StartTime *int64 `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// 结束时间，单位：毫秒。
	EndTime *int64 `json:"EndTime,omitnil,omitempty" name:"EndTime"`
}

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) ApplyChorus added in v1.0.575 

func (c *Client) ApplyChorus(request *ApplyChorusRequest) (response *ApplyChorusResponse, err error)

ApplyChorus 申请合唱相关信息，用于标记用户的演唱是在合唱场景下。

func (*Client) ApplyChorusWithContext added in v1.0.575 

func (c *Client) ApplyChorusWithContext(ctx context.Context, request *ApplyChorusRequest) (response *ApplyChorusResponse, err error)

ApplyChorus 申请合唱相关信息，用于标记用户的演唱是在合唱场景下。

func (*Client) BatchDescribeKTVMusicDetails 

func (c *Client) BatchDescribeKTVMusicDetails(request *BatchDescribeKTVMusicDetailsRequest) (response *BatchDescribeKTVMusicDetailsResponse, err error)

BatchDescribeKTVMusicDetails 批量获取歌曲详细信息，包括：歌词下载链接、播放凭证、音高数据下载链接信息等。

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_USERLIVEVIPTIMEEXPIRE = "FailedOperation.UserLiveVipTimeExpire"
FAILEDOPERATION_USERNOTLIVEVIP = "FailedOperation.UserNotLiveVip"

func (*Client) BatchDescribeKTVMusicDetailsWithContext 

func (c *Client) BatchDescribeKTVMusicDetailsWithContext(ctx context.Context, request *BatchDescribeKTVMusicDetailsRequest) (response *BatchDescribeKTVMusicDetailsResponse, err error)

BatchDescribeKTVMusicDetails 批量获取歌曲详细信息，包括：歌词下载链接、播放凭证、音高数据下载链接信息等。

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_USERLIVEVIPTIMEEXPIRE = "FailedOperation.UserLiveVipTimeExpire"
FAILEDOPERATION_USERNOTLIVEVIP = "FailedOperation.UserNotLiveVip"

func (*Client) CreateKTVRobot added in v1.0.482 

func (c *Client) CreateKTVRobot(request *CreateKTVRobotRequest) (response *CreateKTVRobotResponse, err error)

CreateKTVRobot 创建机器人，支持进入 RTC 房间，播放曲库歌曲。

可能返回的错误码: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"

func (*Client) CreateKTVRobotWithContext added in v1.0.482 

func (c *Client) CreateKTVRobotWithContext(ctx context.Context, request *CreateKTVRobotRequest) (response *CreateKTVRobotResponse, err error)

CreateKTVRobot 创建机器人，支持进入 RTC 房间，播放曲库歌曲。

可能返回的错误码: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"

func (*Client) DescribeKTVMatchMusics added in v1.0.480 

func (c *Client) DescribeKTVMatchMusics(request *DescribeKTVMatchMusicsRequest) (response *DescribeKTVMatchMusicsResponse, err error)

DescribeKTVMatchMusics 根据输入的规则匹配曲库中的歌曲。

可能返回的错误码: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"

func (*Client) DescribeKTVMatchMusicsWithContext added in v1.0.480 

func (c *Client) DescribeKTVMatchMusicsWithContext(ctx context.Context, request *DescribeKTVMatchMusicsRequest) (response *DescribeKTVMatchMusicsResponse, err error)

DescribeKTVMatchMusics 根据输入的规则匹配曲库中的歌曲。

可能返回的错误码: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"

func (*Client) DescribeKTVMusicAccompanySegmentUrl added in v1.0.686 

func (c *Client) DescribeKTVMusicAccompanySegmentUrl(request *DescribeKTVMusicAccompanySegmentUrlRequest) (response *DescribeKTVMusicAccompanySegmentUrlResponse, err error)

DescribeKTVMusicAccompanySegmentUrl 获取歌曲伴奏片段链接，可用于抢唱

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_USERLIVEVIPTIMEEXPIRE = "FailedOperation.UserLiveVipTimeExpire"
FAILEDOPERATION_USERNOTLIVEVIP = "FailedOperation.UserNotLiveVip"

func (*Client) DescribeKTVMusicAccompanySegmentUrlVip added in v1.0.826 

func (c *Client) DescribeKTVMusicAccompanySegmentUrlVip(request *DescribeKTVMusicAccompanySegmentUrlVipRequest) (response *DescribeKTVMusicAccompanySegmentUrlVipResponse, err error)

DescribeKTVMusicAccompanySegmentUrlVip 获取歌曲伴奏高潮的开始、结束时间，可用于抢唱

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_USERLIVEVIPTIMEEXPIRE = "FailedOperation.UserLiveVipTimeExpire"
FAILEDOPERATION_USERNOTLIVEVIP = "FailedOperation.UserNotLiveVip"

func (*Client) DescribeKTVMusicAccompanySegmentUrlVipWithContext added in v1.0.826 

func (c *Client) DescribeKTVMusicAccompanySegmentUrlVipWithContext(ctx context.Context, request *DescribeKTVMusicAccompanySegmentUrlVipRequest) (response *DescribeKTVMusicAccompanySegmentUrlVipResponse, err error)

DescribeKTVMusicAccompanySegmentUrlVip 获取歌曲伴奏高潮的开始、结束时间，可用于抢唱

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_USERLIVEVIPTIMEEXPIRE = "FailedOperation.UserLiveVipTimeExpire"
FAILEDOPERATION_USERNOTLIVEVIP = "FailedOperation.UserNotLiveVip"

func (*Client) DescribeKTVMusicAccompanySegmentUrlWithContext added in v1.0.686 

func (c *Client) DescribeKTVMusicAccompanySegmentUrlWithContext(ctx context.Context, request *DescribeKTVMusicAccompanySegmentUrlRequest) (response *DescribeKTVMusicAccompanySegmentUrlResponse, err error)

DescribeKTVMusicAccompanySegmentUrl 获取歌曲伴奏片段链接，可用于抢唱

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_USERLIVEVIPTIMEEXPIRE = "FailedOperation.UserLiveVipTimeExpire"
FAILEDOPERATION_USERNOTLIVEVIP = "FailedOperation.UserNotLiveVip"

func (*Client) DescribeKTVMusicsByTag added in v1.0.498 

func (c *Client) DescribeKTVMusicsByTag(request *DescribeKTVMusicsByTagRequest) (response *DescribeKTVMusicsByTagResponse, err error)

DescribeKTVMusicsByTag 通过标签过滤歌曲列表。

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_USERLIVEVIPTIMEEXPIRE = "FailedOperation.UserLiveVipTimeExpire"
FAILEDOPERATION_USERNOTLIVEVIP = "FailedOperation.UserNotLiveVip"

func (*Client) DescribeKTVMusicsByTagWithContext added in v1.0.498 

func (c *Client) DescribeKTVMusicsByTagWithContext(ctx context.Context, request *DescribeKTVMusicsByTagRequest) (response *DescribeKTVMusicsByTagResponse, err error)

DescribeKTVMusicsByTag 通过标签过滤歌曲列表。

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_USERLIVEVIPTIMEEXPIRE = "FailedOperation.UserLiveVipTimeExpire"
FAILEDOPERATION_USERNOTLIVEVIP = "FailedOperation.UserNotLiveVip"

func (*Client) DescribeKTVPlaylistDetail 

func (c *Client) DescribeKTVPlaylistDetail(request *DescribeKTVPlaylistDetailRequest) (response *DescribeKTVPlaylistDetailResponse, err error)

DescribeKTVPlaylistDetail 根据歌单 Id 获取歌单详情。

可能返回的错误码: 

RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DescribeKTVPlaylistDetailWithContext 

func (c *Client) DescribeKTVPlaylistDetailWithContext(ctx context.Context, request *DescribeKTVPlaylistDetailRequest) (response *DescribeKTVPlaylistDetailResponse, err error)

DescribeKTVPlaylistDetail 根据歌单 Id 获取歌单详情。

可能返回的错误码: 

RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DescribeKTVPlaylists 

func (c *Client) DescribeKTVPlaylists(request *DescribeKTVPlaylistsRequest) (response *DescribeKTVPlaylistsResponse, err error)

DescribeKTVPlaylists 获取歌单列表。

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) DescribeKTVPlaylistsWithContext 

func (c *Client) DescribeKTVPlaylistsWithContext(ctx context.Context, request *DescribeKTVPlaylistsRequest) (response *DescribeKTVPlaylistsResponse, err error)

DescribeKTVPlaylists 获取歌单列表。

可能返回的错误码: 

INTERNALERROR = "InternalError"

func (*Client) DescribeKTVRobots added in v1.0.482 

func (c *Client) DescribeKTVRobots(request *DescribeKTVRobotsRequest) (response *DescribeKTVRobotsResponse, err error)

DescribeKTVRobots 获取机器人列表，支持 Id、状态等过滤条件。

可能返回的错误码: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"

func (*Client) DescribeKTVRobotsWithContext added in v1.0.482 

func (c *Client) DescribeKTVRobotsWithContext(ctx context.Context, request *DescribeKTVRobotsRequest) (response *DescribeKTVRobotsResponse, err error)

DescribeKTVRobots 获取机器人列表，支持 Id、状态等过滤条件。

可能返回的错误码: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"

func (*Client) DescribeKTVSuggestions 

func (c *Client) DescribeKTVSuggestions(request *DescribeKTVSuggestionsRequest) (response *DescribeKTVSuggestionsResponse, err error)

DescribeKTVSuggestions 根据关键词获取联想词列表。

可能返回的错误码: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"

func (*Client) DescribeKTVSuggestionsWithContext 

func (c *Client) DescribeKTVSuggestionsWithContext(ctx context.Context, request *DescribeKTVSuggestionsRequest) (response *DescribeKTVSuggestionsResponse, err error)

DescribeKTVSuggestions 根据关键词获取联想词列表。

可能返回的错误码: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"

func (*Client) DescribeKTVTags added in v1.0.498 

func (c *Client) DescribeKTVTags(request *DescribeKTVTagsRequest) (response *DescribeKTVTagsResponse, err error)

DescribeKTVTags 获取标签分组及分组下的标签列表信息。

可能返回的错误码: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"

func (*Client) DescribeKTVTagsWithContext added in v1.0.498 

func (c *Client) DescribeKTVTagsWithContext(ctx context.Context, request *DescribeKTVTagsRequest) (response *DescribeKTVTagsResponse, err error)

DescribeKTVTags 获取标签分组及分组下的标签列表信息。

可能返回的错误码: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"

func (*Client) DescribeLiveVipTradeInfos added in v1.0.618 

func (c *Client) DescribeLiveVipTradeInfos(request *DescribeLiveVipTradeInfosRequest) (response *DescribeLiveVipTradeInfosResponse, err error)

DescribeLiveVipTradeInfos 批量获取直播会员充值流水详细信息，包括：流水号，订单状态，下订单时间等

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"

func (*Client) DescribeLiveVipTradeInfosWithContext added in v1.0.618 

func (c *Client) DescribeLiveVipTradeInfosWithContext(ctx context.Context, request *DescribeLiveVipTradeInfosRequest) (response *DescribeLiveVipTradeInfosResponse, err error)

DescribeLiveVipTradeInfos 批量获取直播会员充值流水详细信息，包括：流水号，订单状态，下订单时间等

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"

func (*Client) DescribeUserInfo added in v1.0.618 

func (c *Client) DescribeUserInfo(request *DescribeUserInfoRequest) (response *DescribeUserInfoResponse, err error)

DescribeUserInfo 获取用户信息，包括是否为直播会员，及直播会员信息等

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DescribeUserInfoWithContext added in v1.0.618 

func (c *Client) DescribeUserInfoWithContext(ctx context.Context, request *DescribeUserInfoRequest) (response *DescribeUserInfoResponse, err error)

DescribeUserInfo 获取用户信息，包括是否为直播会员，及直播会员信息等

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DescribeVipUserInfo added in v1.0.826 

func (c *Client) DescribeVipUserInfo(request *DescribeVipUserInfoRequest) (response *DescribeVipUserInfoResponse, err error)

DescribeVipUserInfo 获取会员信息：获取用户是否开通会员

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DescribeVipUserInfoWithContext added in v1.0.826 

func (c *Client) DescribeVipUserInfoWithContext(ctx context.Context, request *DescribeVipUserInfoRequest) (response *DescribeVipUserInfoResponse, err error)

DescribeVipUserInfo 获取会员信息：获取用户是否开通会员

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DestroyKTVRobot added in v1.0.482 

func (c *Client) DestroyKTVRobot(request *DestroyKTVRobotRequest) (response *DestroyKTVRobotResponse, err error)

DestroyKTVRobot 销毁机器人，机器人退出 RTC 房间。

可能返回的错误码: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"

func (*Client) DestroyKTVRobotWithContext added in v1.0.482 

func (c *Client) DestroyKTVRobotWithContext(ctx context.Context, request *DestroyKTVRobotRequest) (response *DestroyKTVRobotResponse, err error)

DestroyKTVRobot 销毁机器人，机器人退出 RTC 房间。

可能返回的错误码: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"

func (*Client) RechargeLiveVip added in v1.0.618 

func (c *Client) RechargeLiveVip(request *RechargeLiveVipRequest) (response *RechargeLiveVipResponse, err error)

RechargeLiveVip 充值直播会员，使该用户可以在直播场景使用

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_DUPLICATETRADESERIALNO = "FailedOperation.DuplicateTradeSerialNo"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) RechargeLiveVipWithContext added in v1.0.618 

func (c *Client) RechargeLiveVipWithContext(ctx context.Context, request *RechargeLiveVipRequest) (response *RechargeLiveVipResponse, err error)

RechargeLiveVip 充值直播会员，使该用户可以在直播场景使用

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_DUPLICATETRADESERIALNO = "FailedOperation.DuplicateTradeSerialNo"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) RechargeVip added in v1.0.826 

func (c *Client) RechargeVip(request *RechargeVipRequest) (response *RechargeVipResponse, err error)

RechargeVip 充值会员

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_DUPLICATETRADESERIALNO = "FailedOperation.DuplicateTradeSerialNo"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) RechargeVipWithContext added in v1.0.826 

func (c *Client) RechargeVipWithContext(ctx context.Context, request *RechargeVipRequest) (response *RechargeVipResponse, err error)

RechargeVip 充值会员

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_DUPLICATETRADESERIALNO = "FailedOperation.DuplicateTradeSerialNo"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) SearchKTVMusics 

func (c *Client) SearchKTVMusics(request *SearchKTVMusicsRequest) (response *SearchKTVMusicsResponse, err error)

SearchKTVMusics 根据关键词搜索歌曲，返回相关歌曲列表。

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_DUPLICATETRADESERIALNO = "FailedOperation.DuplicateTradeSerialNo"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) SearchKTVMusicsWithContext 

func (c *Client) SearchKTVMusicsWithContext(ctx context.Context, request *SearchKTVMusicsRequest) (response *SearchKTVMusicsResponse, err error)

SearchKTVMusics 根据关键词搜索歌曲，返回相关歌曲列表。

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_DUPLICATETRADESERIALNO = "FailedOperation.DuplicateTradeSerialNo"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
MISSINGPARAMETER = "MissingParameter"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) SyncKTVRobotCommand added in v1.0.482 

func (c *Client) SyncKTVRobotCommand(request *SyncKTVRobotCommandRequest) (response *SyncKTVRobotCommandResponse, err error)

SyncKTVRobotCommand 下发操作机器人指令，支持播放、暂停、恢复、歌单设置等操作指令，实现对机器人行为的控制。

可能返回的错误码: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"

func (*Client) SyncKTVRobotCommandWithContext added in v1.0.482 

func (c *Client) SyncKTVRobotCommandWithContext(ctx context.Context, request *SyncKTVRobotCommandRequest) (response *SyncKTVRobotCommandResponse, err error)

SyncKTVRobotCommand 下发操作机器人指令，支持播放、暂停、恢复、歌单设置等操作指令，实现对机器人行为的控制。

可能返回的错误码: 

AUTHFAILURE = "AuthFailure"
FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"

type CreateKTVRobotRequest added in v1.0.482 

type CreateKTVRobotRequest struct {
	*tchttp.BaseRequest

	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// RTC厂商类型，取值有：
	// <li>TRTC</li>
	RTCSystem *string `json:"RTCSystem,omitnil,omitempty" name:"RTCSystem"`

	// 进房参数。
	JoinRoomInput *JoinRoomInput `json:"JoinRoomInput,omitnil,omitempty" name:"JoinRoomInput"`

	// 创建机器人时初始化参数。
	SyncRobotCommands []*SyncRobotCommand `json:"SyncRobotCommands,omitnil,omitempty" name:"SyncRobotCommands"`
}

func NewCreateKTVRobotRequest added in v1.0.482 

func NewCreateKTVRobotRequest() (request *CreateKTVRobotRequest)

func (*CreateKTVRobotRequest) FromJsonString added in v1.0.482 

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

func (r *CreateKTVRobotRequest) ToJsonString() string

type CreateKTVRobotRequestParams added in v1.0.482 

type CreateKTVRobotRequestParams struct {
	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// RTC厂商类型，取值有：
	// <li>TRTC</li>
	RTCSystem *string `json:"RTCSystem,omitnil,omitempty" name:"RTCSystem"`

	// 进房参数。
	JoinRoomInput *JoinRoomInput `json:"JoinRoomInput,omitnil,omitempty" name:"JoinRoomInput"`

	// 创建机器人时初始化参数。
	SyncRobotCommands []*SyncRobotCommand `json:"SyncRobotCommands,omitnil,omitempty" name:"SyncRobotCommands"`
}

Predefined struct for user

type CreateKTVRobotResponse added in v1.0.482 

type CreateKTVRobotResponse struct {
	*tchttp.BaseResponse
	Response *CreateKTVRobotResponseParams `json:"Response"`
}

func NewCreateKTVRobotResponse added in v1.0.482 

func NewCreateKTVRobotResponse() (response *CreateKTVRobotResponse)

func (*CreateKTVRobotResponse) FromJsonString added in v1.0.482 

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

func (r *CreateKTVRobotResponse) ToJsonString() string

type CreateKTVRobotResponseParams added in v1.0.482 

type CreateKTVRobotResponseParams struct {
	// 机器人Id。
	RobotId *string `json:"RobotId,omitnil,omitempty" name:"RobotId"`

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

Predefined struct for user

type DescribeKTVMatchMusicsRequest added in v1.0.480 

type DescribeKTVMatchMusicsRequest struct {
	*tchttp.BaseRequest

	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 匹配规则列表。
	Rules []*KTVMatchRule `json:"Rules,omitnil,omitempty" name:"Rules"`
}

func NewDescribeKTVMatchMusicsRequest added in v1.0.480 

func NewDescribeKTVMatchMusicsRequest() (request *DescribeKTVMatchMusicsRequest)

func (*DescribeKTVMatchMusicsRequest) FromJsonString added in v1.0.480 

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

func (r *DescribeKTVMatchMusicsRequest) ToJsonString() string

type DescribeKTVMatchMusicsRequestParams added in v1.0.480 

type DescribeKTVMatchMusicsRequestParams struct {
	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 匹配规则列表。
	Rules []*KTVMatchRule `json:"Rules,omitnil,omitempty" name:"Rules"`
}

Predefined struct for user

type DescribeKTVMatchMusicsResponse added in v1.0.480 

type DescribeKTVMatchMusicsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeKTVMatchMusicsResponseParams `json:"Response"`
}

func NewDescribeKTVMatchMusicsResponse added in v1.0.480 

func NewDescribeKTVMatchMusicsResponse() (response *DescribeKTVMatchMusicsResponse)

func (*DescribeKTVMatchMusicsResponse) FromJsonString added in v1.0.480 

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

func (r *DescribeKTVMatchMusicsResponse) ToJsonString() string

type DescribeKTVMatchMusicsResponseParams added in v1.0.480 

type DescribeKTVMatchMusicsResponseParams struct {
	// 匹配到的歌曲列表。
	MatchMusicSet []*KTVMatchMusic `json:"MatchMusicSet,omitnil,omitempty" name:"MatchMusicSet"`

	// 未匹配的规则列表。
	NotMatchRuleSet []*KTVMatchRule `json:"NotMatchRuleSet,omitnil,omitempty" name:"NotMatchRuleSet"`

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

Predefined struct for user

type DescribeKTVMusicAccompanySegmentUrlRequest added in v1.0.686 

type DescribeKTVMusicAccompanySegmentUrlRequest struct {
	*tchttp.BaseRequest

	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 歌曲 Id 。
	MusicId *string `json:"MusicId,omitnil,omitempty" name:"MusicId"`

	// 播放场景。默认为Chat
	// <li>Live：直播</li><li>Chat：语聊</li>
	PlayScene *string `json:"PlayScene,omitnil,omitempty" name:"PlayScene"`

	// 房间Id
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`
}

func NewDescribeKTVMusicAccompanySegmentUrlRequest added in v1.0.686 

func NewDescribeKTVMusicAccompanySegmentUrlRequest() (request *DescribeKTVMusicAccompanySegmentUrlRequest)

func (*DescribeKTVMusicAccompanySegmentUrlRequest) FromJsonString added in v1.0.686 

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

func (r *DescribeKTVMusicAccompanySegmentUrlRequest) ToJsonString() string

type DescribeKTVMusicAccompanySegmentUrlRequestParams added in v1.0.686 

type DescribeKTVMusicAccompanySegmentUrlRequestParams struct {
	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 歌曲 Id 。
	MusicId *string `json:"MusicId,omitnil,omitempty" name:"MusicId"`

	// 播放场景。默认为Chat
	// <li>Live：直播</li><li>Chat：语聊</li>
	PlayScene *string `json:"PlayScene,omitnil,omitempty" name:"PlayScene"`

	// 房间Id
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`
}

Predefined struct for user

type DescribeKTVMusicAccompanySegmentUrlResponse added in v1.0.686 

type DescribeKTVMusicAccompanySegmentUrlResponse struct {
	*tchttp.BaseResponse
	Response *DescribeKTVMusicAccompanySegmentUrlResponseParams `json:"Response"`
}

func NewDescribeKTVMusicAccompanySegmentUrlResponse added in v1.0.686 

func NewDescribeKTVMusicAccompanySegmentUrlResponse() (response *DescribeKTVMusicAccompanySegmentUrlResponse)

func (*DescribeKTVMusicAccompanySegmentUrlResponse) FromJsonString added in v1.0.686 

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

func (r *DescribeKTVMusicAccompanySegmentUrlResponse) ToJsonString() string

type DescribeKTVMusicAccompanySegmentUrlResponseParams added in v1.0.686 

type DescribeKTVMusicAccompanySegmentUrlResponseParams struct {
	// 歌曲状态。
	// 0：可用
	// 1：下线
	// 2：没权限
	// 3：没伴奏
	// 当返回2时，其他参数有可能全部为空
	Status *int64 `json:"Status,omitnil,omitempty" name:"Status"`

	// 伴奏链接
	Url *string `json:"Url,omitnil,omitempty" name:"Url"`

	// 伴奏类型，如mkv，mp3等
	ExtName *string `json:"ExtName,omitnil,omitempty" name:"ExtName"`

	// 高潮开始时间
	SegmentBegin *int64 `json:"SegmentBegin,omitnil,omitempty" name:"SegmentBegin"`

	// 高潮结束时间
	SegmentEnd *int64 `json:"SegmentEnd,omitnil,omitempty" name:"SegmentEnd"`

	// 链接文件大小 单位 字节
	FileSize *int64 `json:"FileSize,omitnil,omitempty" name:"FileSize"`

	// 其它片段时间（可用于抢唱）
	// 注意：此字段可能返回 null，表示取不到有效值。
	OtherSegments []*KTVOtherSegments `json:"OtherSegments,omitnil,omitempty" name:"OtherSegments"`

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

Predefined struct for user

type DescribeKTVMusicAccompanySegmentUrlVipRequest added in v1.0.826 

type DescribeKTVMusicAccompanySegmentUrlVipRequest struct {
	*tchttp.BaseRequest

	// 应用名称
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 歌曲 Id
	MusicId *string `json:"MusicId,omitnil,omitempty" name:"MusicId"`

	// 房间Id
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`
}

func NewDescribeKTVMusicAccompanySegmentUrlVipRequest added in v1.0.826 

func NewDescribeKTVMusicAccompanySegmentUrlVipRequest() (request *DescribeKTVMusicAccompanySegmentUrlVipRequest)

func (*DescribeKTVMusicAccompanySegmentUrlVipRequest) FromJsonString added in v1.0.826 

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

func (r *DescribeKTVMusicAccompanySegmentUrlVipRequest) ToJsonString() string

type DescribeKTVMusicAccompanySegmentUrlVipRequestParams added in v1.0.826 

type DescribeKTVMusicAccompanySegmentUrlVipRequestParams struct {
	// 应用名称
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 歌曲 Id
	MusicId *string `json:"MusicId,omitnil,omitempty" name:"MusicId"`

	// 房间Id
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`
}

Predefined struct for user

type DescribeKTVMusicAccompanySegmentUrlVipResponse added in v1.0.826 

type DescribeKTVMusicAccompanySegmentUrlVipResponse struct {
	*tchttp.BaseResponse
	Response *DescribeKTVMusicAccompanySegmentUrlVipResponseParams `json:"Response"`
}

func NewDescribeKTVMusicAccompanySegmentUrlVipResponse added in v1.0.826 

func NewDescribeKTVMusicAccompanySegmentUrlVipResponse() (response *DescribeKTVMusicAccompanySegmentUrlVipResponse)

func (*DescribeKTVMusicAccompanySegmentUrlVipResponse) FromJsonString added in v1.0.826 

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

func (r *DescribeKTVMusicAccompanySegmentUrlVipResponse) ToJsonString() string

type DescribeKTVMusicAccompanySegmentUrlVipResponseParams added in v1.0.826 

type DescribeKTVMusicAccompanySegmentUrlVipResponseParams struct {
	// 0:成功获取 1:歌曲下架 2:无权限 3: 非包月会员 4:没有对应的链接
	Status *int64 `json:"Status,omitnil,omitempty" name:"Status"`

	// 伴奏链接
	Url *string `json:"Url,omitnil,omitempty" name:"Url"`

	// 伴奏类型，如mkv，mp3等
	ExtName *string `json:"ExtName,omitnil,omitempty" name:"ExtName"`

	// 高潮开始时间
	SegmentBegin *int64 `json:"SegmentBegin,omitnil,omitempty" name:"SegmentBegin"`

	// 高潮结束时间
	SegmentEnd *int64 `json:"SegmentEnd,omitnil,omitempty" name:"SegmentEnd"`

	// 链接文件大小 (单位:字节)
	FileSize *int64 `json:"FileSize,omitnil,omitempty" name:"FileSize"`

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

Predefined struct for user

type DescribeKTVMusicsByTagRequest added in v1.0.498 

type DescribeKTVMusicsByTagRequest struct {
	*tchttp.BaseRequest

	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 标签 Id。
	TagId *string `json:"TagId,omitnil,omitempty" name:"TagId"`

	// 滚动标记。
	ScrollToken *string `json:"ScrollToken,omitnil,omitempty" name:"ScrollToken"`

	// 返回条数限制，默认 20，最大 50。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 权益过滤，取值有：
	// <li>Play：可播；</li>
	// <li>Sing：可唱。</li>
	RightFilters []*string `json:"RightFilters,omitnil,omitempty" name:"RightFilters"`

	// 物料过滤，取值有：
	// <li>Lyrics：含有歌词；</li>
	// <li>Midi：含有音高线。</li>
	MaterialFilters []*string `json:"MaterialFilters,omitnil,omitempty" name:"MaterialFilters"`
}

func NewDescribeKTVMusicsByTagRequest added in v1.0.498 

func NewDescribeKTVMusicsByTagRequest() (request *DescribeKTVMusicsByTagRequest)

func (*DescribeKTVMusicsByTagRequest) FromJsonString added in v1.0.498 

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

func (r *DescribeKTVMusicsByTagRequest) ToJsonString() string

type DescribeKTVMusicsByTagRequestParams added in v1.0.498 

type DescribeKTVMusicsByTagRequestParams struct {
	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 标签 Id。
	TagId *string `json:"TagId,omitnil,omitempty" name:"TagId"`

	// 滚动标记。
	ScrollToken *string `json:"ScrollToken,omitnil,omitempty" name:"ScrollToken"`

	// 返回条数限制，默认 20，最大 50。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 权益过滤，取值有：
	// <li>Play：可播；</li>
	// <li>Sing：可唱。</li>
	RightFilters []*string `json:"RightFilters,omitnil,omitempty" name:"RightFilters"`

	// 物料过滤，取值有：
	// <li>Lyrics：含有歌词；</li>
	// <li>Midi：含有音高线。</li>
	MaterialFilters []*string `json:"MaterialFilters,omitnil,omitempty" name:"MaterialFilters"`
}

Predefined struct for user

type DescribeKTVMusicsByTagResponse added in v1.0.498 

type DescribeKTVMusicsByTagResponse struct {
	*tchttp.BaseResponse
	Response *DescribeKTVMusicsByTagResponseParams `json:"Response"`
}

func NewDescribeKTVMusicsByTagResponse added in v1.0.498 

func NewDescribeKTVMusicsByTagResponse() (response *DescribeKTVMusicsByTagResponse)

func (*DescribeKTVMusicsByTagResponse) FromJsonString added in v1.0.498 

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

func (r *DescribeKTVMusicsByTagResponse) ToJsonString() string

type DescribeKTVMusicsByTagResponseParams added in v1.0.498 

type DescribeKTVMusicsByTagResponseParams struct {
	// 歌曲信息列表。
	KTVMusicInfoSet []*KTVMusicBaseInfo `json:"KTVMusicInfoSet,omitnil,omitempty" name:"KTVMusicInfoSet"`

	// 滚动标记，用于设置下次请求的 ScrollToken 参数。
	ScrollToken *string `json:"ScrollToken,omitnil,omitempty" name:"ScrollToken"`

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

Predefined struct for user

type DescribeKTVPlaylistDetailRequest 

type DescribeKTVPlaylistDetailRequest struct {
	*tchttp.BaseRequest

	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 歌单 Id。
	PlaylistId *string `json:"PlaylistId,omitnil,omitempty" name:"PlaylistId"`

	// 滚动标记。
	ScrollToken *string `json:"ScrollToken,omitnil,omitempty" name:"ScrollToken"`

	// 返回条数，默认：20，最大：50。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 权益过滤，取值有：
	// <li>Play：可播；</li>
	// <li>Sing：可唱。</li>
	RightFilters []*string `json:"RightFilters,omitnil,omitempty" name:"RightFilters"`

	// 播放场景。默认为Chat
	// <li>Live：直播</li><li>Chat：语聊</li>
	PlayScene *string `json:"PlayScene,omitnil,omitempty" name:"PlayScene"`

	// 物料过滤，取值有：
	// <li>Lyrics：含有歌词；</li>
	// <li>Midi：含有音高线。</li>
	MaterialFilters []*string `json:"MaterialFilters,omitnil,omitempty" name:"MaterialFilters"`
}

func NewDescribeKTVPlaylistDetailRequest 

func NewDescribeKTVPlaylistDetailRequest() (request *DescribeKTVPlaylistDetailRequest)

func (*DescribeKTVPlaylistDetailRequest) FromJsonString 

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

func (r *DescribeKTVPlaylistDetailRequest) ToJsonString() string

type DescribeKTVPlaylistDetailRequestParams 

type DescribeKTVPlaylistDetailRequestParams struct {
	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 歌单 Id。
	PlaylistId *string `json:"PlaylistId,omitnil,omitempty" name:"PlaylistId"`

	// 滚动标记。
	ScrollToken *string `json:"ScrollToken,omitnil,omitempty" name:"ScrollToken"`

	// 返回条数，默认：20，最大：50。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 权益过滤，取值有：
	// <li>Play：可播；</li>
	// <li>Sing：可唱。</li>
	RightFilters []*string `json:"RightFilters,omitnil,omitempty" name:"RightFilters"`

	// 播放场景。默认为Chat
	// <li>Live：直播</li><li>Chat：语聊</li>
	PlayScene *string `json:"PlayScene,omitnil,omitempty" name:"PlayScene"`

	// 物料过滤，取值有：
	// <li>Lyrics：含有歌词；</li>
	// <li>Midi：含有音高线。</li>
	MaterialFilters []*string `json:"MaterialFilters,omitnil,omitempty" name:"MaterialFilters"`
}

Predefined struct for user

type DescribeKTVPlaylistDetailResponse 

type DescribeKTVPlaylistDetailResponse struct {
	*tchttp.BaseResponse
	Response *DescribeKTVPlaylistDetailResponseParams `json:"Response"`
}

func NewDescribeKTVPlaylistDetailResponse 

func NewDescribeKTVPlaylistDetailResponse() (response *DescribeKTVPlaylistDetailResponse)

func (*DescribeKTVPlaylistDetailResponse) FromJsonString 

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

func (r *DescribeKTVPlaylistDetailResponse) ToJsonString() string

type DescribeKTVPlaylistDetailResponseParams 

type DescribeKTVPlaylistDetailResponseParams struct {
	// 歌曲信息列表。
	KTVMusicInfoSet []*KTVMusicBaseInfo `json:"KTVMusicInfoSet,omitnil,omitempty" name:"KTVMusicInfoSet"`

	// 滚动标记，用于设置下次请求的 ScrollToken 参数。
	ScrollToken *string `json:"ScrollToken,omitnil,omitempty" name:"ScrollToken"`

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

Predefined struct for user

type DescribeKTVPlaylistsRequest 

type DescribeKTVPlaylistsRequest struct {
	*tchttp.BaseRequest

	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 类型列表，取值有：
	// <li>OfficialRec：官方推荐；</li>
	// <li>Customize：自定义。</li>
	// 默认值为 OfficialRec。
	Types []*string `json:"Types,omitnil,omitempty" name:"Types"`

	// 分页返回的起始偏移量，默认值：0。将返回第 Offset 到第 Offset+Limit-1 条。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 分页返回的记录条数，默认值：20，最大值：50。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

func NewDescribeKTVPlaylistsRequest 

func NewDescribeKTVPlaylistsRequest() (request *DescribeKTVPlaylistsRequest)

func (*DescribeKTVPlaylistsRequest) FromJsonString 

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

func (r *DescribeKTVPlaylistsRequest) ToJsonString() string

type DescribeKTVPlaylistsRequestParams 

type DescribeKTVPlaylistsRequestParams struct {
	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 类型列表，取值有：
	// <li>OfficialRec：官方推荐；</li>
	// <li>Customize：自定义。</li>
	// 默认值为 OfficialRec。
	Types []*string `json:"Types,omitnil,omitempty" name:"Types"`

	// 分页返回的起始偏移量，默认值：0。将返回第 Offset 到第 Offset+Limit-1 条。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 分页返回的记录条数，默认值：20，最大值：50。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

Predefined struct for user

type DescribeKTVPlaylistsResponse 

type DescribeKTVPlaylistsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeKTVPlaylistsResponseParams `json:"Response"`
}

func NewDescribeKTVPlaylistsResponse 

func NewDescribeKTVPlaylistsResponse() (response *DescribeKTVPlaylistsResponse)

func (*DescribeKTVPlaylistsResponse) FromJsonString 

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

func (r *DescribeKTVPlaylistsResponse) ToJsonString() string

type DescribeKTVPlaylistsResponseParams 

type DescribeKTVPlaylistsResponseParams struct {
	// 歌单基础信息。
	PlaylistBaseInfoSet []*KTVPlaylistBaseInfo `json:"PlaylistBaseInfoSet,omitnil,omitempty" name:"PlaylistBaseInfoSet"`

	// 歌单总数。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

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

Predefined struct for user

type DescribeKTVRobotsRequest added in v1.0.482 

type DescribeKTVRobotsRequest struct {
	*tchttp.BaseRequest

	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 机器人Id列表。
	RobotIds []*string `json:"RobotIds,omitnil,omitempty" name:"RobotIds"`

	// 机器人状态，取值有：
	// <li>Play：播放</li>
	// <li>Pause：暂停</li>
	// <li>Destroy：销毁</li>
	Statuses []*string `json:"Statuses,omitnil,omitempty" name:"Statuses"`

	// 匹配创建时间在此时间段内的机器人。
	// <li>包含所指定的头尾时间点。</li>
	CreateTime *TimeRange `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// 分页返回的起始偏移量，默认值：0。将返回第 Offset 到第 Offset+Limit-1 条。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 分页返回的起始偏移量，默认值：10。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

func NewDescribeKTVRobotsRequest added in v1.0.482 

func NewDescribeKTVRobotsRequest() (request *DescribeKTVRobotsRequest)

func (*DescribeKTVRobotsRequest) FromJsonString added in v1.0.482 

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

func (r *DescribeKTVRobotsRequest) ToJsonString() string

type DescribeKTVRobotsRequestParams added in v1.0.482 

type DescribeKTVRobotsRequestParams struct {
	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 机器人Id列表。
	RobotIds []*string `json:"RobotIds,omitnil,omitempty" name:"RobotIds"`

	// 机器人状态，取值有：
	// <li>Play：播放</li>
	// <li>Pause：暂停</li>
	// <li>Destroy：销毁</li>
	Statuses []*string `json:"Statuses,omitnil,omitempty" name:"Statuses"`

	// 匹配创建时间在此时间段内的机器人。
	// <li>包含所指定的头尾时间点。</li>
	CreateTime *TimeRange `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// 分页返回的起始偏移量，默认值：0。将返回第 Offset 到第 Offset+Limit-1 条。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 分页返回的起始偏移量，默认值：10。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

Predefined struct for user

type DescribeKTVRobotsResponse added in v1.0.482 

type DescribeKTVRobotsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeKTVRobotsResponseParams `json:"Response"`
}

func NewDescribeKTVRobotsResponse added in v1.0.482 

func NewDescribeKTVRobotsResponse() (response *DescribeKTVRobotsResponse)

func (*DescribeKTVRobotsResponse) FromJsonString added in v1.0.482 

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

func (r *DescribeKTVRobotsResponse) ToJsonString() string

type DescribeKTVRobotsResponseParams added in v1.0.482 

type DescribeKTVRobotsResponseParams struct {
	// 机器人总数。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 机器人信息集合。
	KTVRobotInfoSet []*KTVRobotInfo `json:"KTVRobotInfoSet,omitnil,omitempty" name:"KTVRobotInfoSet"`

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

Predefined struct for user

type DescribeKTVSuggestionsRequest 

type DescribeKTVSuggestionsRequest struct {
	*tchttp.BaseRequest

	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 搜索词。
	KeyWord *string `json:"KeyWord,omitnil,omitempty" name:"KeyWord"`
}

func NewDescribeKTVSuggestionsRequest 

func NewDescribeKTVSuggestionsRequest() (request *DescribeKTVSuggestionsRequest)

func (*DescribeKTVSuggestionsRequest) FromJsonString 

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

func (r *DescribeKTVSuggestionsRequest) ToJsonString() string

type DescribeKTVSuggestionsRequestParams 

type DescribeKTVSuggestionsRequestParams struct {
	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 搜索词。
	KeyWord *string `json:"KeyWord,omitnil,omitempty" name:"KeyWord"`
}

Predefined struct for user

type DescribeKTVSuggestionsResponse 

type DescribeKTVSuggestionsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeKTVSuggestionsResponseParams `json:"Response"`
}

func NewDescribeKTVSuggestionsResponse 

func NewDescribeKTVSuggestionsResponse() (response *DescribeKTVSuggestionsResponse)

func (*DescribeKTVSuggestionsResponse) FromJsonString 

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

func (r *DescribeKTVSuggestionsResponse) ToJsonString() string

type DescribeKTVSuggestionsResponseParams 

type DescribeKTVSuggestionsResponseParams struct {
	// 联想词信息列表。
	KTVSuggestionInfoSet []*KTVSuggestionInfo `json:"KTVSuggestionInfoSet,omitnil,omitempty" name:"KTVSuggestionInfoSet"`

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

Predefined struct for user

type DescribeKTVTagsRequest added in v1.0.498 

type DescribeKTVTagsRequest struct {
	*tchttp.BaseRequest

	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`
}

func NewDescribeKTVTagsRequest added in v1.0.498 

func NewDescribeKTVTagsRequest() (request *DescribeKTVTagsRequest)

func (*DescribeKTVTagsRequest) FromJsonString added in v1.0.498 

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

func (r *DescribeKTVTagsRequest) ToJsonString() string

type DescribeKTVTagsRequestParams added in v1.0.498 

type DescribeKTVTagsRequestParams struct {
	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`
}

Predefined struct for user

type DescribeKTVTagsResponse added in v1.0.498 

type DescribeKTVTagsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeKTVTagsResponseParams `json:"Response"`
}

func NewDescribeKTVTagsResponse added in v1.0.498 

func NewDescribeKTVTagsResponse() (response *DescribeKTVTagsResponse)

func (*DescribeKTVTagsResponse) FromJsonString added in v1.0.498 

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

func (r *DescribeKTVTagsResponse) ToJsonString() string

type DescribeKTVTagsResponseParams added in v1.0.498 

type DescribeKTVTagsResponseParams struct {
	// 标签分组列表。
	TagGroupInfoSet []*KTVTagGroupInfo `json:"TagGroupInfoSet,omitnil,omitempty" name:"TagGroupInfoSet"`

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

Predefined struct for user

type DescribeLiveVipTradeInfosRequest added in v1.0.618 

type DescribeLiveVipTradeInfosRequest struct {
	*tchttp.BaseRequest

	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 直播会员充值下单起始时间，格式为 ISO。默认为当前时间前一天。
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// 直播会员充值下单截止时间，格式为 ISO。默认为当前时间。 EndTime不能小于StartTime
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// 交易流水号集合，匹配集合指定所有流水号 。
	// <li>数组长度限制：10。</li>
	TradeSerialNos []*string `json:"TradeSerialNos,omitnil,omitempty" name:"TradeSerialNos"`

	// 用户标识集合，匹配集合指定所有用户标识 。
	// <li>数组长度限制：10。</li>
	UserIds []*string `json:"UserIds,omitnil,omitempty" name:"UserIds"`

	// 分页返回的起始偏移量，默认值：0。将返回第 Offset 到第 Offset+Limit-1 条。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 分页返回的记录条数，默认值：20，最大值：50。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

func NewDescribeLiveVipTradeInfosRequest added in v1.0.618 

func NewDescribeLiveVipTradeInfosRequest() (request *DescribeLiveVipTradeInfosRequest)

func (*DescribeLiveVipTradeInfosRequest) FromJsonString added in v1.0.618 

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

func (r *DescribeLiveVipTradeInfosRequest) ToJsonString() string

type DescribeLiveVipTradeInfosRequestParams added in v1.0.618 

type DescribeLiveVipTradeInfosRequestParams struct {
	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 直播会员充值下单起始时间，格式为 ISO。默认为当前时间前一天。
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// 直播会员充值下单截止时间，格式为 ISO。默认为当前时间。 EndTime不能小于StartTime
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// 交易流水号集合，匹配集合指定所有流水号 。
	// <li>数组长度限制：10。</li>
	TradeSerialNos []*string `json:"TradeSerialNos,omitnil,omitempty" name:"TradeSerialNos"`

	// 用户标识集合，匹配集合指定所有用户标识 。
	// <li>数组长度限制：10。</li>
	UserIds []*string `json:"UserIds,omitnil,omitempty" name:"UserIds"`

	// 分页返回的起始偏移量，默认值：0。将返回第 Offset 到第 Offset+Limit-1 条。
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 分页返回的记录条数，默认值：20，最大值：50。
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`
}

Predefined struct for user

type DescribeLiveVipTradeInfosResponse added in v1.0.618 

type DescribeLiveVipTradeInfosResponse struct {
	*tchttp.BaseResponse
	Response *DescribeLiveVipTradeInfosResponseParams `json:"Response"`
}

func NewDescribeLiveVipTradeInfosResponse added in v1.0.618 

func NewDescribeLiveVipTradeInfosResponse() (response *DescribeLiveVipTradeInfosResponse)

func (*DescribeLiveVipTradeInfosResponse) FromJsonString added in v1.0.618 

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

func (r *DescribeLiveVipTradeInfosResponse) ToJsonString() string

type DescribeLiveVipTradeInfosResponseParams added in v1.0.618 

type DescribeLiveVipTradeInfosResponseParams struct {
	// 直播会员充值流水信息列表
	LiveVipTradeInfoSet []*LiveVipTradeInfo `json:"LiveVipTradeInfoSet,omitnil,omitempty" name:"LiveVipTradeInfoSet"`

	// 直播会员充值流水总数。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

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

Predefined struct for user

type DescribeUserInfoRequest added in v1.0.618 

type DescribeUserInfoRequest struct {
	*tchttp.BaseRequest

	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`
}

func NewDescribeUserInfoRequest added in v1.0.618 

func NewDescribeUserInfoRequest() (request *DescribeUserInfoRequest)

func (*DescribeUserInfoRequest) FromJsonString added in v1.0.618 

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

func (r *DescribeUserInfoRequest) ToJsonString() string

type DescribeUserInfoRequestParams added in v1.0.618 

type DescribeUserInfoRequestParams struct {
	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`
}

Predefined struct for user

type DescribeUserInfoResponse added in v1.0.618 

type DescribeUserInfoResponse struct {
	*tchttp.BaseResponse
	Response *DescribeUserInfoResponseParams `json:"Response"`
}

func NewDescribeUserInfoResponse added in v1.0.618 

func NewDescribeUserInfoResponse() (response *DescribeUserInfoResponse)

func (*DescribeUserInfoResponse) FromJsonString added in v1.0.618 

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

func (r *DescribeUserInfoResponse) ToJsonString() string

type DescribeUserInfoResponseParams added in v1.0.618 

type DescribeUserInfoResponseParams struct {
	// 用户信息。
	UserInfo *UserInfo `json:"UserInfo,omitnil,omitempty" name:"UserInfo"`

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

Predefined struct for user

type DescribeVipUserInfoRequest added in v1.0.826 

type DescribeVipUserInfoRequest struct {
	*tchttp.BaseRequest

	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`
}

func NewDescribeVipUserInfoRequest added in v1.0.826 

func NewDescribeVipUserInfoRequest() (request *DescribeVipUserInfoRequest)

func (*DescribeVipUserInfoRequest) FromJsonString added in v1.0.826 

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

func (r *DescribeVipUserInfoRequest) ToJsonString() string

type DescribeVipUserInfoRequestParams added in v1.0.826 

type DescribeVipUserInfoRequestParams struct {
	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`
}

Predefined struct for user

type DescribeVipUserInfoResponse added in v1.0.826 

type DescribeVipUserInfoResponse struct {
	*tchttp.BaseResponse
	Response *DescribeVipUserInfoResponseParams `json:"Response"`
}

func NewDescribeVipUserInfoResponse added in v1.0.826 

func NewDescribeVipUserInfoResponse() (response *DescribeVipUserInfoResponse)

func (*DescribeVipUserInfoResponse) FromJsonString added in v1.0.826 

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

func (r *DescribeVipUserInfoResponse) ToJsonString() string

type DescribeVipUserInfoResponseParams added in v1.0.826 

type DescribeVipUserInfoResponseParams struct {
	// 是否是会员。（0:不是会员 1:是会员）
	IsVip *int64 `json:"IsVip,omitnil,omitempty" name:"IsVip"`

	// 主播id
	AnchorId *string `json:"AnchorId,omitnil,omitempty" name:"AnchorId"`

	// 房间id
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 会员过期时间
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// 会员状态。（-1:未开通过；1:已开通，未过期；2:已开通，已过期）
	Status *int64 `json:"Status,omitnil,omitempty" name:"Status"`

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

Predefined struct for user

type DestroyKTVRobotRequest added in v1.0.482 

type DestroyKTVRobotRequest struct {
	*tchttp.BaseRequest

	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 机器人Id。
	RobotId *string `json:"RobotId,omitnil,omitempty" name:"RobotId"`
}

func NewDestroyKTVRobotRequest added in v1.0.482 

func NewDestroyKTVRobotRequest() (request *DestroyKTVRobotRequest)

func (*DestroyKTVRobotRequest) FromJsonString added in v1.0.482 

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

func (r *DestroyKTVRobotRequest) ToJsonString() string

type DestroyKTVRobotRequestParams added in v1.0.482 

type DestroyKTVRobotRequestParams struct {
	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 机器人Id。
	RobotId *string `json:"RobotId,omitnil,omitempty" name:"RobotId"`
}

Predefined struct for user

type DestroyKTVRobotResponse added in v1.0.482 

type DestroyKTVRobotResponse struct {
	*tchttp.BaseResponse
	Response *DestroyKTVRobotResponseParams `json:"Response"`
}

func NewDestroyKTVRobotResponse added in v1.0.482 

func NewDestroyKTVRobotResponse() (response *DestroyKTVRobotResponse)

func (*DestroyKTVRobotResponse) FromJsonString added in v1.0.482 

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

func (r *DestroyKTVRobotResponse) ToJsonString() string

type DestroyKTVRobotResponseParams added in v1.0.482 

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

Predefined struct for user

type JoinRoomInput added in v1.0.482 

type JoinRoomInput struct {
	// TRTC进房参数
	TRTCJoinRoomInput *TRTCJoinRoomInput `json:"TRTCJoinRoomInput,omitnil,omitempty" name:"TRTCJoinRoomInput"`
}

type KTVBPMInfo added in v1.0.498 

type KTVBPMInfo struct {
	// 节拍类型，取值有：
	// <li>Slow：慢；</li>
	// <li>Middle：中等；</li>
	// <li>Fast：快；</li>
	// <li>Unknown：未知。</li>
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

	// BPM 值。
	Value *int64 `json:"Value,omitnil,omitempty" name:"Value"`
}

type KTVMatchMusic added in v1.0.480 

type KTVMatchMusic struct {
	// 匹配到的歌曲基础信息。
	KTVMusicBaseInfo *KTVMusicBaseInfo `json:"KTVMusicBaseInfo,omitnil,omitempty" name:"KTVMusicBaseInfo"`

	// 命中规则。
	MatchRule *KTVMatchRule `json:"MatchRule,omitnil,omitempty" name:"MatchRule"`

	// AME 歌曲基础信息，仅在使用音速达歌曲 Id 匹配 AME 曲库时有效。
	// 注意：此字段可能返回 null，表示取不到有效值。
	AMEMusicBaseInfo *AMEMusicBaseInfo `json:"AMEMusicBaseInfo,omitnil,omitempty" name:"AMEMusicBaseInfo"`
}

type KTVMatchRule added in v1.0.480 

type KTVMatchRule struct {
	// AME 曲库 Id。
	AMEMusicId *string `json:"AMEMusicId,omitnil,omitempty" name:"AMEMusicId"`

	// 歌曲匹配信息。
	// 注意：此字段可能返回 null，表示取不到有效值。
	MusicInfo *KTVMatchRuleMusicInfo `json:"MusicInfo,omitnil,omitempty" name:"MusicInfo"`

	// 音速达歌曲 Id，用于匹配 AME 曲库歌曲。
	MusicIdToMatchAME *string `json:"MusicIdToMatchAME,omitnil,omitempty" name:"MusicIdToMatchAME"`
}

type KTVMatchRuleMusicInfo added in v1.0.480 

type KTVMatchRuleMusicInfo struct {
	// 歌曲名称。
	MusicName *string `json:"MusicName,omitnil,omitempty" name:"MusicName"`

	// 歌手列表。
	SingerSet []*string `json:"SingerSet,omitnil,omitempty" name:"SingerSet"`
}

type KTVMusicBaseInfo 

type KTVMusicBaseInfo struct {
	// 歌曲Id。
	MusicId *string `json:"MusicId,omitnil,omitempty" name:"MusicId"`

	// 歌曲名称。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 歌手名称。
	SingerSet []*string `json:"SingerSet,omitnil,omitempty" name:"SingerSet"`

	// 播放时长。
	Duration *int64 `json:"Duration,omitnil,omitempty" name:"Duration"`

	// 歌手图片链接。
	SingerImageUrl *string `json:"SingerImageUrl,omitnil,omitempty" name:"SingerImageUrl"`

	// 专辑信息。
	// 注意：此字段可能返回 null，表示取不到有效值。
	AlbumInfo *MusicAlbumInfo `json:"AlbumInfo,omitnil,omitempty" name:"AlbumInfo"`

	// 权益列表，取值有：
	// <li>Play：可播；</li>
	// <li>Sing：可唱。</li>
	RightSet []*string `json:"RightSet,omitnil,omitempty" name:"RightSet"`

	// 推荐类型，取值有：
	// <li>Featured：精选；</li>
	// <li>Other：其他。</li>
	RecommendType *string `json:"RecommendType,omitnil,omitempty" name:"RecommendType"`
}

type KTVMusicDetailInfo 

type KTVMusicDetailInfo struct {
	// 歌曲基础信息。
	KTVMusicBaseInfo *KTVMusicBaseInfo `json:"KTVMusicBaseInfo,omitnil,omitempty" name:"KTVMusicBaseInfo"`

	// 播放凭证。
	PlayToken *string `json:"PlayToken,omitnil,omitempty" name:"PlayToken"`

	// 歌词下载链接。
	LyricsUrl *string `json:"LyricsUrl,omitnil,omitempty" name:"LyricsUrl"`

	// 音高数据下载链接。
	MidiUrl *string `json:"MidiUrl,omitnil,omitempty" name:"MidiUrl"`

	// 副歌片段信息。
	ChorusClipSet []*ChorusClip `json:"ChorusClipSet,omitnil,omitempty" name:"ChorusClipSet"`

	// 前奏间隔。
	PreludeInterval *int64 `json:"PreludeInterval,omitnil,omitempty" name:"PreludeInterval"`

	// 歌曲流派列表。
	GenreSet []*string `json:"GenreSet,omitnil,omitempty" name:"GenreSet"`

	// 节拍信息。
	// 注意：此字段可能返回 null，表示取不到有效值。
	BPMInfo *KTVBPMInfo `json:"BPMInfo,omitnil,omitempty" name:"BPMInfo"`
}

type KTVOtherSegments added in v1.0.686 

type KTVOtherSegments struct {
	// 片段开始时间
	// 注意：此字段可能返回 null，表示取不到有效值。
	SegmentBegin *int64 `json:"SegmentBegin,omitnil,omitempty" name:"SegmentBegin"`

	// 片段结束时间
	// 注意：此字段可能返回 null，表示取不到有效值。
	SegmentEnd *int64 `json:"SegmentEnd,omitnil,omitempty" name:"SegmentEnd"`
}

type KTVPlaylistBaseInfo 

type KTVPlaylistBaseInfo struct {
	// 歌单Id。
	PlaylistId *string `json:"PlaylistId,omitnil,omitempty" name:"PlaylistId"`

	// 歌单标题。
	Title *string `json:"Title,omitnil,omitempty" name:"Title"`
}

type KTVRobotInfo added in v1.0.482 

type KTVRobotInfo struct {
	// 机器人Id。
	RobotId *string `json:"RobotId,omitnil,omitempty" name:"RobotId"`

	// 状态，取值有：
	// <li>Play：播放</li>
	// <li>Pause：暂停</li>
	// <li>Destroy：销毁</li>
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// 播放列表。
	Playlists []*string `json:"Playlists,omitnil,omitempty" name:"Playlists"`

	// 当前歌单索引位置。
	CurIndex *int64 `json:"CurIndex,omitnil,omitempty" name:"CurIndex"`

	// 播放进度，单位：毫秒。
	Position *uint64 `json:"Position,omitnil,omitempty" name:"Position"`

	// 音频参数。
	SetAudioParamInput *SetAudioParamCommandInput `json:"SetAudioParamInput,omitnil,omitempty" name:"SetAudioParamInput"`

	// 进房信息。
	JoinRoomInput *JoinRoomInput `json:"JoinRoomInput,omitnil,omitempty" name:"JoinRoomInput"`

	// RTC厂商类型，取值有：
	// <li>TRTC</li>
	RTCSystem *string `json:"RTCSystem,omitnil,omitempty" name:"RTCSystem"`

	// 播放模式，PlayMode取值有：
	// <li>RepeatPlaylist：列表循环</li>
	// <li>Order：顺序播放</li>
	// <li>RepeatSingle：单曲循环</li>
	// <li>Shuffle：随机播放</li>
	SetPlayModeInput *SetPlayModeCommandInput `json:"SetPlayModeInput,omitnil,omitempty" name:"SetPlayModeInput"`
}

type KTVSuggestionInfo 

type KTVSuggestionInfo struct {
	// 联想词。
	Suggestion *string `json:"Suggestion,omitnil,omitempty" name:"Suggestion"`
}

type KTVTagGroupInfo added in v1.0.498 

type KTVTagGroupInfo struct {
	// 分组 Id。
	GroupId *string `json:"GroupId,omitnil,omitempty" name:"GroupId"`

	// 分组名。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 标签列表。
	TagInfoSet []*KTVTagInfo `json:"TagInfoSet,omitnil,omitempty" name:"TagInfoSet"`
}

type KTVTagInfo added in v1.0.498 

type KTVTagInfo struct {
	// 标签 Id。
	TagId *string `json:"TagId,omitnil,omitempty" name:"TagId"`

	// 标签名称。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`
}

type LiveVipTradeInfo added in v1.0.618 

type LiveVipTradeInfo struct {
	// 交易流水号。
	TradeSerialNo *string `json:"TradeSerialNo,omitnil,omitempty" name:"TradeSerialNo"`

	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 房间标识。
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 充值会员天数。
	// 取值有：
	// <li>31</li> <li>93</li><li>186</li> <li>372</li>
	VipDays *int64 `json:"VipDays,omitnil,omitempty" name:"VipDays"`

	// 订单状态。
	// 取值有：
	// <li>Success：成功</li><li>Fail：失败</li><li>Processing：订单处理中</li>
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// 创建时间。
	CreateTime *string `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`
}

type LiveVipUserInfo added in v1.0.618 

type LiveVipUserInfo struct {
	// 房间标识。
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 直播会员结束时间。
	LiveVipEndTime *string `json:"LiveVipEndTime,omitnil,omitempty" name:"LiveVipEndTime"`

	// 会员生效状态
	// <li>Valid：生效</li><li>Invalid：无效</li>
	LiveVipStatus *string `json:"LiveVipStatus,omitnil,omitempty" name:"LiveVipStatus"`
}

type MusicAlbumCoverInfo 

type MusicAlbumCoverInfo struct {
	// 尺寸规格，取值有：
	// <li>Mini：150 x 150 尺寸；</li>
	// <li>Small：240 x 240 尺寸；</li>
	// <li>Medium：480 x 480 尺寸。</li>
	Dimension *string `json:"Dimension,omitnil,omitempty" name:"Dimension"`

	// 下载链接。
	Url *string `json:"Url,omitnil,omitempty" name:"Url"`
}

type MusicAlbumInfo 

type MusicAlbumInfo struct {
	// 专辑名称。
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 封面列表。
	CoverInfoSet []*MusicAlbumCoverInfo `json:"CoverInfoSet,omitnil,omitempty" name:"CoverInfoSet"`
}

type PlayCommandInput added in v1.0.482 

type PlayCommandInput struct {
	// 歌曲位置索引。
	Index *int64 `json:"Index,omitnil,omitempty" name:"Index"`
}

type RechargeLiveVipRequest added in v1.0.618 

type RechargeLiveVipRequest struct {
	*tchttp.BaseRequest

	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 交易流水号，用于标记此次充值记录，多次充值记录传入相同的 TradeSerialNo 会判断为失败，可用于防止重提提交造成重复计费。
	TradeSerialNo *string `json:"TradeSerialNo,omitnil,omitempty" name:"TradeSerialNo"`

	// 房间标识。
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 充值会员天数。
	// 取值有：
	// <li>31</li>
	// <li>93</li>
	// <li>186</li>
	// <li>372</li>
	VipDays *int64 `json:"VipDays,omitnil,omitempty" name:"VipDays"`

	// 充值分类。取值有：room_card-包月房卡; 其他-保留。
	GiveType *string `json:"GiveType,omitnil,omitempty" name:"GiveType"`

	// 播放场景。默认为Live
	// <li>Live：直播</li><li>Chat：语聊</li>
	PlayScene *string `json:"PlayScene,omitnil,omitempty" name:"PlayScene"`
}

func NewRechargeLiveVipRequest added in v1.0.618 

func NewRechargeLiveVipRequest() (request *RechargeLiveVipRequest)

func (*RechargeLiveVipRequest) FromJsonString added in v1.0.618 

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

func (r *RechargeLiveVipRequest) ToJsonString() string

type RechargeLiveVipRequestParams added in v1.0.618 

type RechargeLiveVipRequestParams struct {
	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 交易流水号，用于标记此次充值记录，多次充值记录传入相同的 TradeSerialNo 会判断为失败，可用于防止重提提交造成重复计费。
	TradeSerialNo *string `json:"TradeSerialNo,omitnil,omitempty" name:"TradeSerialNo"`

	// 房间标识。
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 充值会员天数。
	// 取值有：
	// <li>31</li>
	// <li>93</li>
	// <li>186</li>
	// <li>372</li>
	VipDays *int64 `json:"VipDays,omitnil,omitempty" name:"VipDays"`

	// 充值分类。取值有：room_card-包月房卡; 其他-保留。
	GiveType *string `json:"GiveType,omitnil,omitempty" name:"GiveType"`

	// 播放场景。默认为Live
	// <li>Live：直播</li><li>Chat：语聊</li>
	PlayScene *string `json:"PlayScene,omitnil,omitempty" name:"PlayScene"`
}

Predefined struct for user

type RechargeLiveVipResponse added in v1.0.618 

type RechargeLiveVipResponse struct {
	*tchttp.BaseResponse
	Response *RechargeLiveVipResponseParams `json:"Response"`
}

func NewRechargeLiveVipResponse added in v1.0.618 

func NewRechargeLiveVipResponse() (response *RechargeLiveVipResponse)

func (*RechargeLiveVipResponse) FromJsonString added in v1.0.618 

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

func (r *RechargeLiveVipResponse) ToJsonString() string

type RechargeLiveVipResponseParams added in v1.0.618 

type RechargeLiveVipResponseParams struct {
	// 直播会员信息。
	LiveVipUserInfo *LiveVipUserInfo `json:"LiveVipUserInfo,omitnil,omitempty" name:"LiveVipUserInfo"`

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

Predefined struct for user

type RechargeVipRequest added in v1.0.826 

type RechargeVipRequest struct {
	*tchttp.BaseRequest

	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 房间Id。
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 充值会员天数。(取值有：31、93、186、372)
	VipDays *int64 `json:"VipDays,omitnil,omitempty" name:"VipDays"`

	// 主播id。
	AnchorId *string `json:"AnchorId,omitnil,omitempty" name:"AnchorId"`
}

func NewRechargeVipRequest added in v1.0.826 

func NewRechargeVipRequest() (request *RechargeVipRequest)

func (*RechargeVipRequest) FromJsonString added in v1.0.826 

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

func (r *RechargeVipRequest) ToJsonString() string

type RechargeVipRequestParams added in v1.0.826 

type RechargeVipRequestParams struct {
	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 房间Id。
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 充值会员天数。(取值有：31、93、186、372)
	VipDays *int64 `json:"VipDays,omitnil,omitempty" name:"VipDays"`

	// 主播id。
	AnchorId *string `json:"AnchorId,omitnil,omitempty" name:"AnchorId"`
}

Predefined struct for user

type RechargeVipResponse added in v1.0.826 

type RechargeVipResponse struct {
	*tchttp.BaseResponse
	Response *RechargeVipResponseParams `json:"Response"`
}

func NewRechargeVipResponse added in v1.0.826 

func NewRechargeVipResponse() (response *RechargeVipResponse)

func (*RechargeVipResponse) FromJsonString added in v1.0.826 

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

func (r *RechargeVipResponse) ToJsonString() string

type RechargeVipResponseParams added in v1.0.826 

type RechargeVipResponseParams struct {
	// 厂商订单号。
	PartnerNo *string `json:"PartnerNo,omitnil,omitempty" name:"PartnerNo"`

	// TME订单号。
	OrderNo *string `json:"OrderNo,omitnil,omitempty" name:"OrderNo"`

	// 订单创建时间。
	CreateTime *string `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

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

Predefined struct for user

type SearchKTVMusicsRequest 

type SearchKTVMusicsRequest struct {
	*tchttp.BaseRequest

	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 关键词。
	KeyWord *string `json:"KeyWord,omitnil,omitempty" name:"KeyWord"`

	// 滚动标记。
	ScrollToken *string `json:"ScrollToken,omitnil,omitempty" name:"ScrollToken"`

	// 返回条数限制，默认 20，最大 50.
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 权益过滤，取值有：
	// <li>Play：可播；</li>
	// <li>Sing：可唱。</li>
	RightFilters []*string `json:"RightFilters,omitnil,omitempty" name:"RightFilters"`

	// 播放场景。默认为Chat
	// <li>Live：直播</li><li>Chat：语聊</li>
	PlayScene *string `json:"PlayScene,omitnil,omitempty" name:"PlayScene"`

	// 物料过滤，取值有：
	// <li>Lyrics：含有歌词；</li>
	// <li>Midi：含有音高线。</li>
	MaterialFilters []*string `json:"MaterialFilters,omitnil,omitempty" name:"MaterialFilters"`
}

func NewSearchKTVMusicsRequest 

func NewSearchKTVMusicsRequest() (request *SearchKTVMusicsRequest)

func (*SearchKTVMusicsRequest) FromJsonString 

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

func (r *SearchKTVMusicsRequest) ToJsonString() string

type SearchKTVMusicsRequestParams 

type SearchKTVMusicsRequestParams struct {
	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 关键词。
	KeyWord *string `json:"KeyWord,omitnil,omitempty" name:"KeyWord"`

	// 滚动标记。
	ScrollToken *string `json:"ScrollToken,omitnil,omitempty" name:"ScrollToken"`

	// 返回条数限制，默认 20，最大 50.
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 权益过滤，取值有：
	// <li>Play：可播；</li>
	// <li>Sing：可唱。</li>
	RightFilters []*string `json:"RightFilters,omitnil,omitempty" name:"RightFilters"`

	// 播放场景。默认为Chat
	// <li>Live：直播</li><li>Chat：语聊</li>
	PlayScene *string `json:"PlayScene,omitnil,omitempty" name:"PlayScene"`

	// 物料过滤，取值有：
	// <li>Lyrics：含有歌词；</li>
	// <li>Midi：含有音高线。</li>
	MaterialFilters []*string `json:"MaterialFilters,omitnil,omitempty" name:"MaterialFilters"`
}

Predefined struct for user

type SearchKTVMusicsResponse 

type SearchKTVMusicsResponse struct {
	*tchttp.BaseResponse
	Response *SearchKTVMusicsResponseParams `json:"Response"`
}

func NewSearchKTVMusicsResponse 

func NewSearchKTVMusicsResponse() (response *SearchKTVMusicsResponse)

func (*SearchKTVMusicsResponse) FromJsonString 

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

func (r *SearchKTVMusicsResponse) ToJsonString() string

type SearchKTVMusicsResponseParams 

type SearchKTVMusicsResponseParams struct {
	// 歌曲信息列表。
	KTVMusicInfoSet []*KTVMusicBaseInfo `json:"KTVMusicInfoSet,omitnil,omitempty" name:"KTVMusicInfoSet"`

	// 滚动标记，用于设置下次请求的 ScrollToken 参数。
	ScrollToken *string `json:"ScrollToken,omitnil,omitempty" name:"ScrollToken"`

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

Predefined struct for user

type SeekCommandInput added in v1.0.482 

type SeekCommandInput struct {
	// 播放位置，单位：毫秒。
	Position *uint64 `json:"Position,omitnil,omitempty" name:"Position"`
}

type SendMessageCommandInput added in v1.0.482 

type SendMessageCommandInput struct {
	// 自定义消息，json格式字符串。
	Message *string `json:"Message,omitnil,omitempty" name:"Message"`

	// 消息重复次数，默认为 1。
	Repeat *uint64 `json:"Repeat,omitnil,omitempty" name:"Repeat"`
}

type SetAudioParamCommandInput added in v1.0.482 

type SetAudioParamCommandInput struct {
	// 音频类型，取值有：
	// <li>Original：原唱</li>
	// <li>Accompaniment：伴奏</li>
	// 注意：此字段可能返回 null，表示取不到有效值。
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`
}

type SetDestroyModeCommandInput added in v1.0.482 

type SetDestroyModeCommandInput struct {
	// 销毁模式，取值有：
	// <li>Auto：房间没人时自动销毁</li>
	// <li>Expire：房间没人时过期自动销毁</li>
	// <li>Never：不自动销毁，需手动销毁</li>默认为：Auto。
	DestroyMode *string `json:"DestroyMode,omitnil,omitempty" name:"DestroyMode"`

	// 过期销毁时间，单位：秒，当DestroyMode取Expire时必填。
	DestroyExpireTime *int64 `json:"DestroyExpireTime,omitnil,omitempty" name:"DestroyExpireTime"`
}

type SetPlayModeCommandInput added in v1.0.482 

type SetPlayModeCommandInput struct {
	// 播放模式，取值有：
	// <li>RepeatPlaylist：列表循环</li>
	// <li>Order：顺序播放</li>
	// <li>RepeatSingle：单曲循环</li>
	// <li>Shuffle：随机播放</li>
	// 注意：此字段可能返回 null，表示取不到有效值。
	PlayMode *string `json:"PlayMode,omitnil,omitempty" name:"PlayMode"`
}

type SetPlaylistCommandInput added in v1.0.482 

type SetPlaylistCommandInput struct {
	// 变更类型，取值有：
	// <li>Add：添加</li>
	// <li>Delete：删除</li>
	// <li>ClearList：清空歌曲列表</li>
	// <li>Move：移动歌曲</li>
	Type *string `json:"Type,omitnil,omitempty" name:"Type"`

	// 歌单索引位置，
	// 当 Type 取 Add 时，-1表示添加在列表最后位置，大于-1表示要添加的位置；
	// 当 Type 取 Delete 时，表示待删除歌曲的位置；
	// 当 Type 取 Move 时，表示待调整歌曲的位置。
	Index *int64 `json:"Index,omitnil,omitempty" name:"Index"`

	// 当 Type 取 Move 时，必填，表示移动歌曲的目标位置。
	ChangedIndex *int64 `json:"ChangedIndex,omitnil,omitempty" name:"ChangedIndex"`

	// 歌曲 ID 列表，当 Type 取 Add 时，必填。
	MusicIds []*string `json:"MusicIds,omitnil,omitempty" name:"MusicIds"`
}

type SyncKTVRobotCommandRequest added in v1.0.482 

type SyncKTVRobotCommandRequest struct {
	*tchttp.BaseRequest

	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 机器人Id。
	RobotId *string `json:"RobotId,omitnil,omitempty" name:"RobotId"`

	// 指令及指令参数数组。
	SyncRobotCommands []*SyncRobotCommand `json:"SyncRobotCommands,omitnil,omitempty" name:"SyncRobotCommands"`
}

func NewSyncKTVRobotCommandRequest added in v1.0.482 

func NewSyncKTVRobotCommandRequest() (request *SyncKTVRobotCommandRequest)

func (*SyncKTVRobotCommandRequest) FromJsonString added in v1.0.482 

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

func (r *SyncKTVRobotCommandRequest) ToJsonString() string

type SyncKTVRobotCommandRequestParams added in v1.0.482 

type SyncKTVRobotCommandRequestParams struct {
	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 机器人Id。
	RobotId *string `json:"RobotId,omitnil,omitempty" name:"RobotId"`

	// 指令及指令参数数组。
	SyncRobotCommands []*SyncRobotCommand `json:"SyncRobotCommands,omitnil,omitempty" name:"SyncRobotCommands"`
}

Predefined struct for user

type SyncKTVRobotCommandResponse added in v1.0.482 

type SyncKTVRobotCommandResponse struct {
	*tchttp.BaseResponse
	Response *SyncKTVRobotCommandResponseParams `json:"Response"`
}

func NewSyncKTVRobotCommandResponse added in v1.0.482 

func NewSyncKTVRobotCommandResponse() (response *SyncKTVRobotCommandResponse)

func (*SyncKTVRobotCommandResponse) FromJsonString added in v1.0.482 

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

func (r *SyncKTVRobotCommandResponse) ToJsonString() string

type SyncKTVRobotCommandResponseParams added in v1.0.482 

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

Predefined struct for user

type SyncRobotCommand added in v1.0.482 

type SyncRobotCommand struct {
	// 可同时传入多个指令，顺序执行。取值有：
	// <li>Play：播放</li>
	// <li>Pause：暂停</li>
	// <li>SwitchPrevious：上一首</li>
	// <li>SwitchNext：下一首</li>
	// <li>SetPlayMode：设置播放模式</li>
	// <li>Seek：调整播放进度</li>
	// <li>SetPlaylist：歌单变更</li>
	// <li>SetAudioParam：音频参数变更</li>
	// <li>SendMessage：发送自定义消息</li>
	// <li>SetDestroyMode：设置销毁模式</li>
	Command *string `json:"Command,omitnil,omitempty" name:"Command"`

	// 播放参数。
	PlayCommandInput *PlayCommandInput `json:"PlayCommandInput,omitnil,omitempty" name:"PlayCommandInput"`

	// 播放列表变更信息，当Command取SetPlaylist时，必填。
	SetPlaylistCommandInput *SetPlaylistCommandInput `json:"SetPlaylistCommandInput,omitnil,omitempty" name:"SetPlaylistCommandInput"`

	// 播放进度，当Command取Seek时，必填。
	SeekCommandInput *SeekCommandInput `json:"SeekCommandInput,omitnil,omitempty" name:"SeekCommandInput"`

	// 音频参数，当Command取SetAudioParam时，必填。
	SetAudioParamCommandInput *SetAudioParamCommandInput `json:"SetAudioParamCommandInput,omitnil,omitempty" name:"SetAudioParamCommandInput"`

	// 自定义消息，当Command取SendMessage时，必填。
	SendMessageCommandInput *SendMessageCommandInput `json:"SendMessageCommandInput,omitnil,omitempty" name:"SendMessageCommandInput"`

	// 播放模式，当Command取SetPlayMode时，必填。
	SetPlayModeCommandInput *SetPlayModeCommandInput `json:"SetPlayModeCommandInput,omitnil,omitempty" name:"SetPlayModeCommandInput"`

	// 销毁模式，当Command取SetDestroyMode时，必填。
	SetDestroyModeCommandInput *SetDestroyModeCommandInput `json:"SetDestroyModeCommandInput,omitnil,omitempty" name:"SetDestroyModeCommandInput"`
}

type TRTCJoinRoomInput added in v1.0.482 

type TRTCJoinRoomInput struct {
	// 签名。
	Sign *string `json:"Sign,omitnil,omitempty" name:"Sign"`

	// 房间号。
	RoomId *string `json:"RoomId,omitnil,omitempty" name:"RoomId"`

	// 推流应用ID。
	SdkAppId *string `json:"SdkAppId,omitnil,omitempty" name:"SdkAppId"`

	// 用户唯一标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// TRTC房间号的类型：
	//
	// Integer：数字类型
	// String：字符串类型
	// 默认为：Integer 。
	// 注意：此字段可能返回 null，表示取不到有效值。
	RoomIdType *string `json:"RoomIdType,omitnil,omitempty" name:"RoomIdType"`
}

type TimeRange added in v1.0.482 

type TimeRange struct {
	// <li>大于等于此时间（起始时间）。</li>
	// <li>格式按照 ISO 8601标准表示，详见 <a href="https://cloud.tencent.com/document/product/266/11732#I" target="_blank">ISO 日期格式说明</a>。</li>
	Before *string `json:"Before,omitnil,omitempty" name:"Before"`

	// <li>小于此时间（结束时间）。</li>
	// <li>格式按照 ISO 8601标准表示，详见 <a href="https://cloud.tencent.com/document/product/266/11732#I" target="_blank">ISO 日期格式说明</a>。</li>
	After *string `json:"After,omitnil,omitempty" name:"After"`
}

type UserInfo added in v1.0.618 

type UserInfo struct {
	// 应用名称。
	AppName *string `json:"AppName,omitnil,omitempty" name:"AppName"`

	// 用户标识。
	UserId *string `json:"UserId,omitnil,omitempty" name:"UserId"`

	// 直播会员详细信息。
	// 注意：此字段可能返回 null，表示取不到有效值。
	LiveVipUserInfo *LiveVipUserInfo `json:"LiveVipUserInfo,omitnil,omitempty" name:"LiveVipUserInfo"`

	// 用户类型
	// <li>Normal：普通用户</li>
	// <li>LiveVip：直播会员用户</li>
	UserType *string `json:"UserType,omitnil,omitempty" name:"UserType"`
}

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.