Âm thanh
Kiểm tra app.capabilities để biết tính năng và app.access cùng quyền máy chủ để xác định quyền truy cập. Thay giá trị mẫu trước khi gọi.
Định nghĩa kiểu
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!
}Thao tác
audios
Tìm tệp âm thanh. Để query rỗng để liệt kê tất cả.
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 }
}audioCount
Đếm tệp âm thanh khớp truy vấn.
query audioCount($query: String!) {
audioCount(query: $query)
}audioByPath
Đọc siêu dữ liệu âm thanh theo đường dẫn tệp.
query audioByPath($path: String!) {
audioByPath(path: $path) { mediaId title artist path durationMs }
}audioLyrics
Đọc lời bài hát gắn với ID âm thanh trong danh mục.
query audioLyrics($mediaId: ID!) {
audioLyrics(mediaId: $mediaId)
}audioLyricsByPath
Đọc lời bài hát gắn với đường dẫn tệp âm thanh.
query audioLyricsByPath($path: String!) {
audioLyricsByPath(path: $path)
}audioArtists
Liệt kê nghệ sĩ âm thanh trong thư viện đa phương tiện.
query audioArtists {
audioArtists { name itemCount playCount samplePath }
}audioPlayback
Đọc ID và đường dẫn của âm thanh đã chọn.
query audioPlayback {
audioPlayback { mediaId path }
}selectAudio
Chọn và trả về bản nhạc theo mediaId mà không bắt đầu phát.
mutation selectAudio($mediaId: ID!) {
selectAudio(mediaId: $mediaId) { mediaId title artist path durationMs }
}selectAudioByPath
Chọn âm thanh theo đường dẫn tệp mà không bắt đầu phát.
mutation selectAudioByPath($path: String!) {
selectAudioByPath(path: $path) { mediaId title artist path durationMs }
}updateAudioPlayMode
Đặt chế độ phát.
mutation updateAudioPlayMode($mode: MediaPlayMode!) {
updateAudioPlayMode(mode: $mode)
}audioQueueItems
Đọc một trang bản âm thanh trong hàng đợi khớp truy vấn.
query audioQueueItems($query: String!, $offset: Int!, $limit: Int!) {
audioQueueItems(query: $query, offset: $offset, limit: $limit) { mediaId title artist path durationMs }
}audioQueueItemCount
Đếm mục trong hàng đợi phát âm thanh.
query audioQueueItemCount($query: String!) {
audioQueueItemCount(query: $query)
}addAudioToQueue
Nối các bản âm thanh khớp truy vấn vào hàng đợi phát.
mutation addAudioToQueue($query: String!) {
addAudioToQueue(query: $query)
}removeAudioFromQueue
Xóa một ID phương tiện khỏi hàng đợi phát.
mutation removeAudioFromQueue($mediaId: ID!) {
removeAudioFromQueue(mediaId: $mediaId)
}reorderAudioQueue
Sắp lại bản nhạc trong hàng đợi theo thứ tự ID phương tiện được cung cấp.
mutation reorderAudioQueue($mediaIds: [ID!]!) {
reorderAudioQueue(mediaIds: $mediaIds)
}replaceAudioQueue
Thay hàng đợi phát bằng kết quả tìm kiếm đã chọn và trả về bản nhạc được chọn nếu có.
mutation replaceAudioQueue($query: String!, $sortBy: AudioSortBy!, $shuffle: Boolean!) {
replaceAudioQueue(query: $query, sortBy: $sortBy, shuffle: $shuffle) { mediaId title artist path durationMs }
}clearAudioQueue
Xóa mọi mục khỏi hàng đợi phát âm thanh.
mutation clearAudioQueue {
clearAudioQueue
}audioPlaylists
Liệt kê danh sách phát âm thanh đã lưu.
query audioPlaylists {
audioPlaylists { id name itemCount createdAt updatedAt }
}audioPlaylist
Đọc một danh sách phát âm thanh theo ID.
query audioPlaylist($id: ID!) {
audioPlaylist(id: $id) { id name itemCount createdAt updatedAt }
}audioPlaylistItems
Đọc một trang bản nhạc khớp truy vấn trong danh sách phát.
query audioPlaylistItems($id: ID!, $query: String!, $offset: Int!, $limit: Int!) {
audioPlaylistItems(id: $id, query: $query, offset: $offset, limit: $limit) { mediaId title artist path durationMs }
}audioPlaylistItemCount
Đếm bản nhạc khớp truy vấn trong danh sách phát.
query audioPlaylistItemCount($id: ID!, $query: String!) {
audioPlaylistItemCount(id: $id, query: $query)
}createAudioPlaylist
Tạo danh sách phát âm thanh có tên.
mutation createAudioPlaylist($name: String!) {
createAudioPlaylist(name: $name) { id name itemCount createdAt updatedAt }
}updateAudioPlaylist
Đổi tên danh sách phát âm thanh hiện có.
mutation updateAudioPlaylist($id: ID!, $name: String!) {
updateAudioPlaylist(id: $id, name: $name) { id name itemCount createdAt updatedAt }
}addAudioPlaylistItems
Thêm các bản âm thanh khớp truy vấn vào danh sách phát đã chỉ định.
mutation addAudioPlaylistItems($id: ID!, $query: String!) {
addAudioPlaylistItems(id: $id, query: $query)
}removeAudioPlaylistItems
Xóa mục danh sách phát khớp truy vấn và báo số bị tác động.
mutation removeAudioPlaylistItems($id: ID!, $query: String!) {
removeAudioPlaylistItems(id: $id, query: $query) { affectedCount }
}deleteAudioPlaylist
Xóa danh sách phát đã chỉ định và các bản ghi thành phần của nó.
mutation deleteAudioPlaylist($id: ID!) {
deleteAudioPlaylist(id: $id)
}