API 参考
音频
通过 app.capabilities 判断功能支持,通过 app.access 和宿主权限判断访问授权。示例使用合成数据,调用前请替换路径、ID、输入和筛选条件。
类型定义
graphql
type Query {
audios(query: String!, offset: Int!, limit: Int!, sortBy: AudioSortBy!): [Audio!]!
audioCount(query: String!): Int!
audioByPath(path: String!): AudioItem!
audioLyrics(mediaId: ID!): String
audioLyricsByPath(path: String!): String
audioArtists: [AudioArtist!]!
audioPlayback: AudioPlayback!
audioQueueItems(query: String!, offset: Int!, limit: Int!): [AudioItem!]!
audioQueueItemCount(query: String!): Int!
audioPlaylists: [AudioPlaylist!]!
audioPlaylist(id: ID!): AudioPlaylist
audioPlaylistItems(id: ID!, query: String!, offset: Int!, limit: Int!): [AudioItem!]!
audioPlaylistItemCount(id: ID!, query: String!): Int!
}
type Mutation {
selectAudio(mediaId: ID!): AudioItem!
selectAudioByPath(path: String!): AudioItem!
updateAudioPlayMode(mode: MediaPlayMode!): Boolean!
addAudioToQueue(query: String!): Boolean!
removeAudioFromQueue(mediaId: ID!): Boolean!
reorderAudioQueue(mediaIds: [ID!]!): Boolean!
replaceAudioQueue(query: String!, sortBy: AudioSortBy!, shuffle: Boolean!): AudioItem
clearAudioQueue: Boolean!
createAudioPlaylist(name: String!): AudioPlaylist!
updateAudioPlaylist(id: ID!, name: String!): AudioPlaylist!
addAudioPlaylistItems(id: ID!, query: String!): Boolean!
removeAudioPlaylistItems(id: ID!, query: String!): ActionResult!
deleteAudioPlaylist(id: ID!): Boolean!
}
type ActionResult {
affectedCount: Int!
}
type Audio implements MediaItem {
albumId: ID!
id: ID!
title: String!
artist: String!
path: String!
durationMs: Long!
size: Long!
bucketId: ID!
createdAt: Instant!
updatedAt: Instant!
isFavorite: Boolean!
albumFileId: String!
tags: [Tag!]!
}
type AudioAlbumCover {
albumId: ID!
trackCount: Int!
candidatePaths: [String!]!
}
type AudioArtist {
name: String!
itemCount: Int!
playCount: Long!
samplePath: String!
}
type AudioItem {
mediaId: ID
title: String!
artist: String!
path: String!
durationMs: Long!
}
type AudioPlayback {
mediaId: ID
path: String
}
type AudioPlaylist {
id: ID!
name: String!
itemCount: Int!
coverAlbums: [AudioAlbumCover!]!
createdAt: Instant!
updatedAt: Instant!
}
enum AudioSortBy {
UPDATED_AT_ASC
UPDATED_AT_DESC
SIZE_ASC
SIZE_DESC
TITLE_ASC
TITLE_DESC
}
enum DataType {
DEFAULT
AUDIO
VIDEO
IMAGE
SMS
CONTACT
NOTE
FEED_ENTRY
CALL
PACKAGE
FILE
APP_FILE
DOC
}
scalar Instant
scalar Long
interface MediaItem {
id: ID!
title: String!
path: String!
size: Long!
bucketId: ID!
createdAt: Instant!
updatedAt: Instant!
}
enum MediaPlayMode {
REPEAT
REPEAT_ONE
SHUFFLE
}
type Tag {
id: ID!
name: String!
type: DataType!
count: Int!
}操作
query
audios
搜索音频文件;query 留空时列出全部音频。
graphql
query audios($query: String!, $offset: Int!, $limit: Int!, $sortBy: AudioSortBy!) {
audios(query: $query, offset: $offset, limit: $limit, sortBy: $sortBy) { albumId id title artist path durationMs size bucketId }
}query
audioCount
统计符合查询条件的音频文件数。
graphql
query audioCount($query: String!) {
audioCount(query: $query)
}query
audioByPath
通过文件路径读取音频元数据。
graphql
query audioByPath($path: String!) {
audioByPath(path: $path) { mediaId title artist path durationMs }
}query
audioLyrics
读取媒体目录音频 ID 对应的歌词。
graphql
query audioLyrics($mediaId: ID!) {
audioLyrics(mediaId: $mediaId)
}query
audioLyricsByPath
读取音频文件路径对应的歌词。
graphql
query audioLyricsByPath($path: String!) {
audioLyricsByPath(path: $path)
}query
audioArtists
列出媒体库中的音频艺术家。
graphql
query audioArtists {
audioArtists { name itemCount playCount samplePath }
}query
audioPlayback
读取当前选中音频的 ID 和路径。
graphql
query audioPlayback {
audioPlayback { mediaId path }
}mutation
selectAudio
按 mediaId 选择并返回音轨,不启动播放。
graphql
mutation selectAudio($mediaId: ID!) {
selectAudio(mediaId: $mediaId) { mediaId title artist path durationMs }
}mutation
selectAudioByPath
按文件路径选择音频,不启动播放。
graphql
mutation selectAudioByPath($path: String!) {
selectAudioByPath(path: $path) { mediaId title artist path durationMs }
}mutation
updateAudioPlayMode
设置播放模式。
graphql
mutation updateAudioPlayMode($mode: MediaPlayMode!) {
updateAudioPlayMode(mode: $mode)
}query
audioQueueItems
分页读取队列中符合查询条件的音轨。
graphql
query audioQueueItems($query: String!, $offset: Int!, $limit: Int!) {
audioQueueItems(query: $query, offset: $offset, limit: $limit) { mediaId title artist path durationMs }
}query
audioQueueItemCount
统计音频播放队列中的项目数。
graphql
query audioQueueItemCount($query: String!) {
audioQueueItemCount(query: $query)
}mutation
addAudioToQueue
将符合查询条件的音轨追加到播放队列。
graphql
mutation addAudioToQueue($query: String!) {
addAudioToQueue(query: $query)
}mutation
removeAudioFromQueue
从播放队列中移除指定媒体 ID。
graphql
mutation removeAudioFromQueue($mediaId: ID!) {
removeAudioFromQueue(mediaId: $mediaId)
}mutation
reorderAudioQueue
按指定的媒体 ID 顺序重排队列音轨。
graphql
mutation reorderAudioQueue($mediaIds: [ID!]!) {
reorderAudioQueue(mediaIds: $mediaIds)
}mutation
replaceAudioQueue
使用所选搜索结果替换播放队列;有选中音轨时返回该音轨。
graphql
mutation replaceAudioQueue($query: String!, $sortBy: AudioSortBy!, $shuffle: Boolean!) {
replaceAudioQueue(query: $query, sortBy: $sortBy, shuffle: $shuffle) { mediaId title artist path durationMs }
}mutation
clearAudioQueue
移除音频播放队列中的全部项目。
graphql
mutation clearAudioQueue {
clearAudioQueue
}query
audioPlaylists
列出已存储的音频播放列表。
graphql
query audioPlaylists {
audioPlaylists { id name itemCount createdAt updatedAt }
}query
audioPlaylist
通过 ID 读取一个音频播放列表。
graphql
query audioPlaylist($id: ID!) {
audioPlaylist(id: $id) { id name itemCount createdAt updatedAt }
}query
audioPlaylistItems
分页读取播放列表中符合查询条件的音轨。
graphql
query audioPlaylistItems($id: ID!, $query: String!, $offset: Int!, $limit: Int!) {
audioPlaylistItems(id: $id, query: $query, offset: $offset, limit: $limit) { mediaId title artist path durationMs }
}query
audioPlaylistItemCount
统计播放列表中符合查询条件的音轨数。
graphql
query audioPlaylistItemCount($id: ID!, $query: String!) {
audioPlaylistItemCount(id: $id, query: $query)
}mutation
createAudioPlaylist
创建带名称的音频播放列表。
graphql
mutation createAudioPlaylist($name: String!) {
createAudioPlaylist(name: $name) { id name itemCount createdAt updatedAt }
}mutation
updateAudioPlaylist
重命名已有的音频播放列表。
graphql
mutation updateAudioPlaylist($id: ID!, $name: String!) {
updateAudioPlaylist(id: $id, name: $name) { id name itemCount createdAt updatedAt }
}mutation
addAudioPlaylistItems
将符合查询条件的音轨加入指定播放列表。
graphql
mutation addAudioPlaylistItems($id: ID!, $query: String!) {
addAudioPlaylistItems(id: $id, query: $query)
}mutation
removeAudioPlaylistItems
移除播放列表中符合查询条件的条目,并返回受影响数量。
graphql
mutation removeAudioPlaylistItems($id: ID!, $query: String!) {
removeAudioPlaylistItems(id: $id, query: $query) { affectedCount }
}mutation
deleteAudioPlaylist
删除指定播放列表及其成员关系记录。
graphql
mutation deleteAudioPlaylist($id: ID!) {
deleteAudioPlaylist(id: $id)
}