Referência da API

Áudio

Navegue por arquivos de áudio e controle a reprodução no dispositivo. O telefone atua como o reprodutor de mídia.

Definições de Tipo

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
}

Operações

query

audios

Pesquise arquivos de áudio. Deixe a consulta vazia para listar todos.

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

Conte arquivos de áudio correspondentes a uma consulta.

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

playAudio

Comece a reproduzir um arquivo de áudio no dispositivo. Adiciona à playlist se ainda não estiver presente.

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

updateAudioPlayMode

Defina o modo de reprodução.

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

clearAudioPlaylist

Limpe a playlist atual e pare a reprodução.

bash
mutation ClearAudioPlaylist {
  clearAudioPlaylist
}
mutation

deletePlaylistAudio

Remova uma faixa da playlist pelo caminho do arquivo.

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

addPlaylistAudios

Adicione até 1.000 arquivos de áudio correspondentes à playlist atual.

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

reorderPlaylistAudios

Reordene a playlist fornecendo uma lista ordenada de caminhos de arquivo.

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