Справочник API

Аудио

Поддержку функций проверяйте через app.capabilities, доступ — через app.access и разрешения хоста. Замените тестовые значения перед вызовом.

Определения типов

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

Операции

query

audios

Ищет аудиофайлы. Пустой query перечисляет все файлы.

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

Подсчитывает аудиофайлы по запросу.

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

audioByPath

Прочитать метаданные аудио по пути к файлу.

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

audioLyrics

Читает текст песни, связанный с ID аудио в каталоге.

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

audioLyricsByPath

Читает текст песни, связанный с путём аудиофайла.

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

audioArtists

Возвращает список исполнителей из медиатеки.

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

audioPlayback

Читает ID и путь выбранной аудиозаписи.

graphql
query audioPlayback {
  audioPlayback { mediaId path }
}
mutation

selectAudio

Выбирает и возвращает аудиодорожку по mediaId без запуска воспроизведения.

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

selectAudioByPath

Выбирает аудио по пути к файлу без запуска воспроизведения.

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

updateAudioPlayMode

Устанавливает режим воспроизведения.

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

audioQueueItems

Читает страницу аудиотреков в очереди по запросу.

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

audioQueueItemCount

Подсчитывает элементы очереди воспроизведения аудио.

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

addAudioToQueue

Добавляет аудиотреки по запросу в очередь воспроизведения.

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

removeAudioFromQueue

Удаляет ID медиа из очереди воспроизведения.

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

reorderAudioQueue

Меняет порядок треков в очереди по заданному порядку ID медиа.

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

replaceAudioQueue

Заменяет очередь воспроизведения выбранными результатами поиска и возвращает выбранный трек, если он есть.

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

clearAudioQueue

Удаляет все элементы очереди воспроизведения аудио.

graphql
mutation clearAudioQueue {
  clearAudioQueue
}
query

audioPlaylists

Перечисляет сохранённые аудиоплейлисты.

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

audioPlaylist

Прочитать один аудиоплейлист по ID.

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

audioPlaylistItems

Читает страницу треков по запросу в плейлисте.

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

Подсчитывает треки по запросу в плейлисте.

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

createAudioPlaylist

Создаёт именованный аудиоплейлист.

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

updateAudioPlaylist

Переименовывает существующий аудиоплейлист.

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

addAudioPlaylistItems

Добавляет аудиотреки по запросу в указанный плейлист.

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

removeAudioPlaylistItems

Удаляет записи плейлиста по запросу и сообщает их количество.

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

deleteAudioPlaylist

Удаляет указанный плейлист и записи его состава.

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