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

ファイルパスでプレイリストからトラックを 1 つ削除します。

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