Audio

API 參考

瀏覽音訊檔案並在裝置上控制播放。手機充當媒體播放器。

型別定義

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
}

操作

query

audios

搜尋音訊檔案。查詢留空可列出全部。

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

計算符合查詢的音訊檔案數量。

bash

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

mutation

playAudio

在裝置上開始播放音訊檔案。如果尚未在播放清單中，則會新增。

bash

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

mutation

updateAudioPlayMode

設定播放模式。

bash

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

mutation

clearAudioPlaylist

清空目前播放清單並停止播放。

bash

mutation ClearAudioPlaylist {
  clearAudioPlaylist
}

mutation

deletePlaylistAudio

依檔案路徑從播放清單中移除一條音軌。

bash

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

mutation

addPlaylistAudios

向目前播放清單新增最多 1,000 個符合的音訊檔案。

bash

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

mutation

reorderPlaylistAudios

透過提供排序後的檔案路徑清單來重新排列播放清單。

bash

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