Tham chiếu API

Audio

Duyệt tệp âm thanh và điều khiển phát lại trên thiết bị. Điện thoại hoạt động như máy phát phương tiện.

Định nghĩa kiểu

bash
type Audio {
  id: ID!
  title: String!
  artist: String!
  path: String!
  duration: Int!         # milliseconds
  size: Int!             # bytes
  bucketId: String!
  albumFileId: String!   # use GET /fs?id=<albumFileId> for album art
  createdAt: String!
  updatedAt: String!
  tags: [Tag!]!
}

type PlaylistAudio {
  title: String!
  artist: String!
  path: String!
  duration: Int!         # milliseconds
}

enum MediaPlayMode {
  REPEAT_ALL
  REPEAT_ONE
  SHUFFLE
}

Thao tác

query

audios

Tìm kiếm tệp âm thanh. Để query trống để liệt kê tất cả.

bash
query GetAudios($offset: Int!, $limit: Int!, $query: String!, $sortBy: FileSortBy!) {
  audios(offset: $offset, limit: $limit, query: $query, sortBy: $sortBy) {
    id title artist path duration size bucketId albumFileId createdAt
    tags { id name }
  }
}
query

audioCount

Đếm tệp âm thanh khớp với một query.

bash
query GetAudioCount($query: String!) {
  audioCount(query: $query)
}
mutation

playAudio

Bắt đầu phát một tệp âm thanh trên thiết bị. Thêm vào danh sách phát nếu chưa có.

bash
mutation PlayAudio($path: String!) {
  playAudio(path: $path) { title artist path duration }
}
mutation

updateAudioPlayMode

Đặt chế độ phát lại.

bash
mutation UpdateAudioPlayMode($mode: MediaPlayMode!) {
  updateAudioPlayMode(mode: $mode)
}
mutation

clearAudioPlaylist

Xóa danh sách phát hiện tại và dừng phát lại.

bash
mutation ClearAudioPlaylist {
  clearAudioPlaylist
}
mutation

deletePlaylistAudio

Xóa một bản nhạc khỏi danh sách phát theo đường dẫn tệp.

bash
mutation DeletePlaylistAudio($path: String!) {
  deletePlaylistAudio(path: $path)
}
mutation

addPlaylistAudios

Thêm tối đa 1.000 tệp âm thanh khớp vào danh sách phát hiện tại.

bash
mutation AddPlaylistAudios($query: String!) {
  addPlaylistAudios(query: $query)
}
mutation

reorderPlaylistAudios

Sắp xếp lại danh sách phát bằng cách cung cấp một danh sách có thứ tự các đường dẫn tệp.

bash
mutation ReorderPlaylistAudios($paths: [String!]!) {
  reorderPlaylistAudios(paths: $paths)
}