Audio

API-Referenz

Audiodateien durchsuchen und die Wiedergabe auf dem Gerät steuern. Das Telefon fungiert als Mediaplayer.

Typdefinitionen

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
}

Operationen

query

audios

Audiodateien suchen. Abfrage leer lassen, um alle aufzulisten.

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

Anzahl der auf eine Abfrage passenden Audiodateien zählen.

bash

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

mutation

playAudio

Wiedergabe einer Audiodatei auf dem Gerät starten. Zur Playlist hinzufügen, falls noch nicht vorhanden.

bash

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

mutation

updateAudioPlayMode

Den Wiedergabemodus festlegen.

bash

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

mutation

clearAudioPlaylist

Die aktuelle Playlist leeren und die Wiedergabe stoppen.

bash

mutation ClearAudioPlaylist {
  clearAudioPlaylist
}

mutation

deletePlaylistAudio

Einen Titel anhand des Dateipfads aus der Playlist entfernen.

bash

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

mutation

addPlaylistAudios

Bis zu 1.000 passende Audiodateien zur aktuellen Playlist hinzufügen.

bash

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

mutation

reorderPlaylistAudios

Playlist neu anordnen durch eine geordnete Liste von Dateipfaden.

bash

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