Audio

Référence de l'API

Parcourez les fichiers audio et contrôlez la lecture sur l'appareil. Le téléphone fait office de lecteur multimédia.

Définitions de types

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
}

Opérations

query

audios

Recherche des fichiers audio. Laissez la requête vide pour tout lister.

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

Compte les fichiers audio correspondant à une requête.

bash

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

mutation

playAudio

Lance la lecture d'un fichier audio sur l'appareil. L'ajoute à la liste de lecture s'il n'est pas déjà présent.

bash

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

mutation

updateAudioPlayMode

Définit le mode de lecture.

bash

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

mutation

clearAudioPlaylist

Vide la liste de lecture actuelle et arrête la lecture.

bash

mutation ClearAudioPlaylist {
  clearAudioPlaylist
}

mutation

deletePlaylistAudio

Retire une piste de la liste de lecture par chemin de fichier.

bash

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

mutation

addPlaylistAudios

Ajoute jusqu'à 1 000 fichiers audio correspondants à la liste de lecture actuelle.

bash

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

mutation

reorderPlaylistAudios

Réordonne la liste de lecture en fournissant une liste ordonnée de chemins de fichiers.

bash

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