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