Documentation
¶
Index ¶
- Constants
- type Album
- type Artist
- type Client
- func (c *Client) DescribeItems(request *DescribeItemsRequest) (response *DescribeItemsResponse, err error)
- func (c *Client) DescribeLyric(request *DescribeLyricRequest) (response *DescribeLyricResponse, err error)
- func (c *Client) DescribeMusic(request *DescribeMusicRequest) (response *DescribeMusicResponse, err error)
- func (c *Client) DescribeStations(request *DescribeStationsRequest) (response *DescribeStationsResponse, err error)
- type DataInfo
- type DescribeItemsRequest
- type DescribeItemsResponse
- type DescribeLyricRequest
- type DescribeLyricResponse
- type DescribeMusicRequest
- type DescribeMusicResponse
- type DescribeStationsRequest
- type DescribeStationsResponse
- type ImagePath
- type Item
- type Lyric
- type Music
- type Station
Constants ¶
View Source
const APIVersion = "2019-09-16"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Artist ¶
type Artist struct {
// 歌手名
ArtistName *string `json:"ArtistName,omitempty" name:"ArtistName"`
}
type Client ¶
func NewClient ¶
func NewClient(credential *common.Credential, region string, clientProfile *profile.ClientProfile) (client *Client, err error)
func NewClientWithSecretId ¶
Deprecated
func (*Client) DescribeItems ¶
func (c *Client) DescribeItems(request *DescribeItemsRequest) (response *DescribeItemsResponse, err error)
分类内容下歌曲列表获取,根据CategoryID或CategoryCode
func (*Client) DescribeLyric ¶
func (c *Client) DescribeLyric(request *DescribeLyricRequest) (response *DescribeLyricResponse, err error)
根据接口的模式及歌曲ID来取得歌词信息。
func (*Client) DescribeMusic ¶
func (c *Client) DescribeMusic(request *DescribeMusicRequest) (response *DescribeMusicResponse, err error)
根据接口的模式及歌曲ID来取得对应权限的歌曲播放地址等信息。
func (*Client) DescribeStations ¶
func (c *Client) DescribeStations(request *DescribeStationsRequest) (response *DescribeStationsResponse, err error)
获取素材库列表时使用
type DataInfo ¶
type DataInfo struct {
// Song Name
Name *string `json:"Name,omitempty" name:"Name"`
// 歌曲版本
Version *string `json:"Version,omitempty" name:"Version"`
// 歌曲总时长(非试听时长)
Duration *string `json:"Duration,omitempty" name:"Duration"`
// 试听开始时间
AuditionBegin *uint64 `json:"AuditionBegin,omitempty" name:"AuditionBegin"`
// 试听结束时间
AuditionEnd *uint64 `json:"AuditionEnd,omitempty" name:"AuditionEnd"`
}
type DescribeItemsRequest ¶
type DescribeItemsRequest struct {
*tchttp.BaseRequest
// offset (Default = 0),(当前页-1) * Limit
Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
// 条数,必须大于0,最大值为30
Limit *uint64 `json:"Limit,omitempty" name:"Limit"`
// (电台/歌单)ID,CategoryId和CategoryCode两个必传1个
CategoryId *string `json:"CategoryId,omitempty" name:"CategoryId"`
// (电台/歌单)代码,CategoryId和CategoryCode两个必传1个
CategoryCode *string `json:"CategoryCode,omitempty" name:"CategoryCode"`
}
func NewDescribeItemsRequest ¶
func NewDescribeItemsRequest() (request *DescribeItemsRequest)
func (*DescribeItemsRequest) FromJsonString ¶
func (r *DescribeItemsRequest) FromJsonString(s string) error
func (*DescribeItemsRequest) ToJsonString ¶
func (r *DescribeItemsRequest) ToJsonString() string
type DescribeItemsResponse ¶
type DescribeItemsResponse struct {
*tchttp.BaseResponse
Response *struct {
// 分页偏移量
Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
// 当前页歌曲数量
Size *uint64 `json:"Size,omitempty" name:"Size"`
// 总数据条数
Total *uint64 `json:"Total,omitempty" name:"Total"`
// 剩余数量(total-offset-size),通过这个值判断是否
// 还有下一页
HaveMore *uint64 `json:"HaveMore,omitempty" name:"HaveMore"`
// Items 歌曲列表
// 注意:此字段可能返回 null,表示取不到有效值。
Items []*Item `json:"Items,omitempty" name:"Items" list`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeItemsResponse ¶
func NewDescribeItemsResponse() (response *DescribeItemsResponse)
func (*DescribeItemsResponse) FromJsonString ¶
func (r *DescribeItemsResponse) FromJsonString(s string) error
func (*DescribeItemsResponse) ToJsonString ¶
func (r *DescribeItemsResponse) ToJsonString() string
type DescribeLyricRequest ¶
type DescribeLyricRequest struct {
*tchttp.BaseRequest
// 歌曲ID
ItemId *string `json:"ItemId,omitempty" name:"ItemId"`
// 歌词格式,可选项,可不填写,目前填写只能填LRC-LRC。该字段为预留的扩展字段。后续如果不填,会返回歌曲的所有格式的歌词。如果填写某个正确的格式,则只返回该格式的歌词。
SubItemType *string `json:"SubItemType,omitempty" name:"SubItemType"`
}
func NewDescribeLyricRequest ¶
func NewDescribeLyricRequest() (request *DescribeLyricRequest)
func (*DescribeLyricRequest) FromJsonString ¶
func (r *DescribeLyricRequest) FromJsonString(s string) error
func (*DescribeLyricRequest) ToJsonString ¶
func (r *DescribeLyricRequest) ToJsonString() string
type DescribeLyricResponse ¶
type DescribeLyricResponse struct {
*tchttp.BaseResponse
Response *struct {
// 歌词详情
// 注意:此字段可能返回 null,表示取不到有效值。
Lyric *Lyric `json:"Lyric,omitempty" name:"Lyric"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeLyricResponse ¶
func NewDescribeLyricResponse() (response *DescribeLyricResponse)
func (*DescribeLyricResponse) FromJsonString ¶
func (r *DescribeLyricResponse) FromJsonString(s string) error
func (*DescribeLyricResponse) ToJsonString ¶
func (r *DescribeLyricResponse) ToJsonString() string
type DescribeMusicRequest ¶
type DescribeMusicRequest struct {
*tchttp.BaseRequest
// 歌曲ID
ItemId *string `json:"ItemId,omitempty" name:"ItemId"`
// User identity ID,用来唯一标识用户
IdentityId *string `json:"IdentityId,omitempty" name:"IdentityId"`
// 填 MP3-64K-FTD-P 获取歌曲热门片段
SubItemType *string `json:"SubItemType,omitempty" name:"SubItemType"`
// CDN URL Protocol:HTTP or HTTPS/SSL
// Values:Y , N(default)
Ssl *string `json:"Ssl,omitempty" name:"Ssl"`
}
func NewDescribeMusicRequest ¶
func NewDescribeMusicRequest() (request *DescribeMusicRequest)
func (*DescribeMusicRequest) FromJsonString ¶
func (r *DescribeMusicRequest) FromJsonString(s string) error
func (*DescribeMusicRequest) ToJsonString ¶
func (r *DescribeMusicRequest) ToJsonString() string
type DescribeMusicResponse ¶
type DescribeMusicResponse struct {
*tchttp.BaseResponse
Response *struct {
// 音乐相关信息
// 注意:此字段可能返回 null,表示取不到有效值。
Music *Music `json:"Music,omitempty" name:"Music"`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeMusicResponse ¶
func NewDescribeMusicResponse() (response *DescribeMusicResponse)
func (*DescribeMusicResponse) FromJsonString ¶
func (r *DescribeMusicResponse) FromJsonString(s string) error
func (*DescribeMusicResponse) ToJsonString ¶
func (r *DescribeMusicResponse) ToJsonString() string
type DescribeStationsRequest ¶
type DescribeStationsRequest struct {
*tchttp.BaseRequest
// 条数,必须大于0
Limit *uint64 `json:"Limit,omitempty" name:"Limit"`
// offset (Default = 0),(当前页-1) * Limit
Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
}
func NewDescribeStationsRequest ¶
func NewDescribeStationsRequest() (request *DescribeStationsRequest)
func (*DescribeStationsRequest) FromJsonString ¶
func (r *DescribeStationsRequest) FromJsonString(s string) error
func (*DescribeStationsRequest) ToJsonString ¶
func (r *DescribeStationsRequest) ToJsonString() string
type DescribeStationsResponse ¶
type DescribeStationsResponse struct {
*tchttp.BaseResponse
Response *struct {
// 总数量
Total *uint64 `json:"Total,omitempty" name:"Total"`
// 分页偏移量
Offset *uint64 `json:"Offset,omitempty" name:"Offset"`
// 当前页station数量
Size *uint64 `json:"Size,omitempty" name:"Size"`
// 剩余数量(total-offset-size),通过这个值判断是否还有下一页
HaveMore *uint64 `json:"HaveMore,omitempty" name:"HaveMore"`
// Stations 素材库列表
// 注意:此字段可能返回 null,表示取不到有效值。
Stations []*Station `json:"Stations,omitempty" name:"Stations" list`
// 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
} `json:"Response"`
}
func NewDescribeStationsResponse ¶
func NewDescribeStationsResponse() (response *DescribeStationsResponse)
func (*DescribeStationsResponse) FromJsonString ¶
func (r *DescribeStationsResponse) FromJsonString(s string) error
func (*DescribeStationsResponse) ToJsonString ¶
func (r *DescribeStationsResponse) ToJsonString() string
type Item ¶
type Item struct {
// Song ID
ItemID *string `json:"ItemID,omitempty" name:"ItemID"`
// Song info
// 注意:此字段可能返回 null,表示取不到有效值。
DataInfo *DataInfo `json:"DataInfo,omitempty" name:"DataInfo"`
// 专辑信息
// 注意:此字段可能返回 null,表示取不到有效值。
Album *Album `json:"Album,omitempty" name:"Album"`
// 多个歌手集合
// 注意:此字段可能返回 null,表示取不到有效值。
Artists []*Artist `json:"Artists,omitempty" name:"Artists" list`
}
type Music ¶
type Music struct {
// 音乐播放链接相对路径,必须通过在音乐版权助手上登记的域名进行拼接。
Url *string `json:"Url,omitempty" name:"Url"`
// 音频文件大小
FileSize *uint64 `json:"FileSize,omitempty" name:"FileSize"`
// 音频文件类型
FileExtension *string `json:"FileExtension,omitempty" name:"FileExtension"`
// Song fragment start.试听片段开始时间,试听时长为auditionEnd-auditionBegin
// Unit :ms
AuditionBegin *uint64 `json:"AuditionBegin,omitempty" name:"AuditionBegin"`
// Song fragment end.试听片段结束时间, 试听时长为auditionEnd-auditionBegin
// Unit :ms
AuditionEnd *uint64 `json:"AuditionEnd,omitempty" name:"AuditionEnd"`
}
type Station ¶
type Station struct {
// StationID
CategoryID *string `json:"CategoryID,omitempty" name:"CategoryID"`
// Station MCCode
// 注意:此字段可能返回 null,表示取不到有效值。
CategoryCode *string `json:"CategoryCode,omitempty" name:"CategoryCode"`
// Category Name
// 注意:此字段可能返回 null,表示取不到有效值。
Name *string `json:"Name,omitempty" name:"Name"`
// Station的排序值,供参考(返回结果已按其升序)
// 注意:此字段可能返回 null,表示取不到有效值。
Rank *int64 `json:"Rank,omitempty" name:"Rank"`
// station图片集合
// 注意:此字段可能返回 null,表示取不到有效值。
ImagePathMap []*ImagePath `json:"ImagePathMap,omitempty" name:"ImagePathMap" list`
}
Click to show internal directories.
Click to hide internal directories.