Référence de l'API

Audio

Vérifier app.capabilities pour la prise en charge des fonctionnalités et app.access ainsi que les permissions de l’hôte pour les autorisations. Les exemples utilisent des valeurs synthétiques ; remplacer les chemins, ID, entrées et filtres avant tout appel.

Définitions de types

graphql
type Query {
  audios(query: String!, offset: Int!, limit: Int!, sortBy: AudioSortBy!): [Audio!]!
  audioCount(query: String!): Int!
  audioByPath(path: String!): AudioItem!
  audioLyrics(mediaId: ID!): String
  audioLyricsByPath(path: String!): String
  audioArtists: [AudioArtist!]!
  audioPlayback: AudioPlayback!
  audioQueueItems(query: String!, offset: Int!, limit: Int!): [AudioItem!]!
  audioQueueItemCount(query: String!): Int!
  audioPlaylists: [AudioPlaylist!]!
  audioPlaylist(id: ID!): AudioPlaylist
  audioPlaylistItems(id: ID!, query: String!, offset: Int!, limit: Int!): [AudioItem!]!
  audioPlaylistItemCount(id: ID!, query: String!): Int!
}

type Mutation {
  selectAudio(mediaId: ID!): AudioItem!
  selectAudioByPath(path: String!): AudioItem!
  updateAudioPlayMode(mode: MediaPlayMode!): Boolean!
  addAudioToQueue(query: String!): Boolean!
  removeAudioFromQueue(mediaId: ID!): Boolean!
  reorderAudioQueue(mediaIds: [ID!]!): Boolean!
  replaceAudioQueue(query: String!, sortBy: AudioSortBy!, shuffle: Boolean!): AudioItem
  clearAudioQueue: Boolean!
  createAudioPlaylist(name: String!): AudioPlaylist!
  updateAudioPlaylist(id: ID!, name: String!): AudioPlaylist!
  addAudioPlaylistItems(id: ID!, query: String!): Boolean!
  removeAudioPlaylistItems(id: ID!, query: String!): ActionResult!
  deleteAudioPlaylist(id: ID!): Boolean!
}

type ActionResult {
	affectedCount: Int!
}

type Audio implements MediaItem {
	albumId: ID!
	id: ID!
	title: String!
	artist: String!
	path: String!
	durationMs: Long!
	size: Long!
	bucketId: ID!
	createdAt: Instant!
	updatedAt: Instant!
	isFavorite: Boolean!
	albumFileId: String!
	tags: [Tag!]!
}

type AudioAlbumCover {
	albumId: ID!
	trackCount: Int!
	candidatePaths: [String!]!
}

type AudioArtist {
	name: String!
	itemCount: Int!
	playCount: Long!
	samplePath: String!
}

type AudioItem {
	mediaId: ID
	title: String!
	artist: String!
	path: String!
	durationMs: Long!
}

type AudioPlayback {
	mediaId: ID
	path: String
}

type AudioPlaylist {
	id: ID!
	name: String!
	itemCount: Int!
	coverAlbums: [AudioAlbumCover!]!
	createdAt: Instant!
	updatedAt: Instant!
}

enum AudioSortBy {
	UPDATED_AT_ASC
	UPDATED_AT_DESC
	SIZE_ASC
	SIZE_DESC
	TITLE_ASC
	TITLE_DESC
}

enum DataType {
	DEFAULT
	AUDIO
	VIDEO
	IMAGE
	SMS
	CONTACT
	NOTE
	FEED_ENTRY
	CALL
	PACKAGE
	FILE
	APP_FILE
	DOC
}

scalar Instant

scalar Long

interface MediaItem {
	id: ID!
	title: String!
	path: String!
	size: Long!
	bucketId: ID!
	createdAt: Instant!
	updatedAt: Instant!
}

enum MediaPlayMode {
	REPEAT
	REPEAT_ONE
	SHUFFLE
}

type Tag {
	id: ID!
	name: String!
	type: DataType!
	count: Int!
}

Opérations

query

audios

Rechercher des fichiers audio. Laisser query vide pour tous les lister.

graphql
query audios($query: String!, $offset: Int!, $limit: Int!, $sortBy: AudioSortBy!) {
  audios(query: $query, offset: $offset, limit: $limit, sortBy: $sortBy) { albumId id title artist path durationMs size bucketId }
}
query

audioCount

Compter les fichiers audio correspondant à une requête.

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

audioByPath

Lire les métadonnées audio d’un chemin de fichier.

graphql
query audioByPath($path: String!) {
  audioByPath(path: $path) { mediaId title artist path durationMs }
}
query

audioLyrics

Lire les paroles associées à un ID de média audio du catalogue.

graphql
query audioLyrics($mediaId: ID!) {
  audioLyrics(mediaId: $mediaId)
}
query

audioLyricsByPath

Lire les paroles associées à un chemin de fichier audio.

graphql
query audioLyricsByPath($path: String!) {
  audioLyricsByPath(path: $path)
}
query

audioArtists

Liste les artistes audio de la médiathèque.

graphql
query audioArtists {
  audioArtists { name itemCount playCount samplePath }
}
query

audioPlayback

Lit l’identifiant et le chemin de l’audio sélectionné.

graphql
query audioPlayback {
  audioPlayback { mediaId path }
}
mutation

selectAudio

Sélectionne et renvoie la piste audio par mediaId sans lancer la lecture.

graphql
mutation selectAudio($mediaId: ID!) {
  selectAudio(mediaId: $mediaId) { mediaId title artist path durationMs }
}
mutation

selectAudioByPath

Sélectionne un fichier audio par son chemin sans lancer la lecture.

graphql
mutation selectAudioByPath($path: String!) {
  selectAudioByPath(path: $path) { mediaId title artist path durationMs }
}
mutation

updateAudioPlayMode

Définir le mode de lecture.

graphql
mutation updateAudioPlayMode($mode: MediaPlayMode!) {
  updateAudioPlayMode(mode: $mode)
}
query

audioQueueItems

Lire une page de pistes audio en attente correspondant à la requête.

graphql
query audioQueueItems($query: String!, $offset: Int!, $limit: Int!) {
  audioQueueItems(query: $query, offset: $offset, limit: $limit) { mediaId title artist path durationMs }
}
query

audioQueueItemCount

Compter les éléments de la file de lecture audio.

graphql
query audioQueueItemCount($query: String!) {
  audioQueueItemCount(query: $query)
}
mutation

addAudioToQueue

Ajouter à la fin de la file de lecture les pistes audio correspondant à la requête.

graphql
mutation addAudioToQueue($query: String!) {
  addAudioToQueue(query: $query)
}
mutation

removeAudioFromQueue

Retirer un ID de média de la file de lecture.

graphql
mutation removeAudioFromQueue($mediaId: ID!) {
  removeAudioFromQueue(mediaId: $mediaId)
}
mutation

reorderAudioQueue

Réordonner les pistes en attente selon l’ordre d’ID de médias fourni.

graphql
mutation reorderAudioQueue($mediaIds: [ID!]!) {
  reorderAudioQueue(mediaIds: $mediaIds)
}
mutation

replaceAudioQueue

Remplacer la file de lecture par les résultats de recherche sélectionnés et renvoyer la piste sélectionnée, le cas échéant.

graphql
mutation replaceAudioQueue($query: String!, $sortBy: AudioSortBy!, $shuffle: Boolean!) {
  replaceAudioQueue(query: $query, sortBy: $sortBy, shuffle: $shuffle) { mediaId title artist path durationMs }
}
mutation

clearAudioQueue

Retirer tous les éléments de la file de lecture audio.

graphql
mutation clearAudioQueue {
  clearAudioQueue
}
query

audioPlaylists

Lister les listes de lecture audio enregistrées.

graphql
query audioPlaylists {
  audioPlaylists { id name itemCount createdAt updatedAt }
}
query

audioPlaylist

Lire une liste de lecture audio par son ID.

graphql
query audioPlaylist($id: ID!) {
  audioPlaylist(id: $id) { id name itemCount createdAt updatedAt }
}
query

audioPlaylistItems

Lire une page de pistes d’une liste de lecture correspondant à la requête.

graphql
query audioPlaylistItems($id: ID!, $query: String!, $offset: Int!, $limit: Int!) {
  audioPlaylistItems(id: $id, query: $query, offset: $offset, limit: $limit) { mediaId title artist path durationMs }
}
query

audioPlaylistItemCount

Compter les pistes d’une liste de lecture correspondant à la requête.

graphql
query audioPlaylistItemCount($id: ID!, $query: String!) {
  audioPlaylistItemCount(id: $id, query: $query)
}
mutation

createAudioPlaylist

Créer une liste de lecture audio nommée.

graphql
mutation createAudioPlaylist($name: String!) {
  createAudioPlaylist(name: $name) { id name itemCount createdAt updatedAt }
}
mutation

updateAudioPlaylist

Renommer une liste de lecture audio existante.

graphql
mutation updateAudioPlaylist($id: ID!, $name: String!) {
  updateAudioPlaylist(id: $id, name: $name) { id name itemCount createdAt updatedAt }
}
mutation

addAudioPlaylistItems

Ajouter les pistes audio correspondant à la requête à la liste de lecture indiquée.

graphql
mutation addAudioPlaylistItems($id: ID!, $query: String!) {
  addAudioPlaylistItems(id: $id, query: $query)
}
mutation

removeAudioPlaylistItems

Retirer les entrées de liste de lecture correspondant à la requête et indiquer le nombre d’éléments concernés.

graphql
mutation removeAudioPlaylistItems($id: ID!, $query: String!) {
  removeAudioPlaylistItems(id: $id, query: $query) { affectedCount }
}
mutation

deleteAudioPlaylist

Supprimer la liste de lecture indiquée et ses enregistrements d’appartenance.

graphql
mutation deleteAudioPlaylist($id: ID!) {
  deleteAudioPlaylist(id: $id)
}