오디오
기능 지원은 app.capabilities, 인가는 app.access와 호스트 권한으로 확인하세요. 예제는 합성 값을 사용합니다. 호출 전에 경로, ID, 입력, 필터를 바꾸세요.
타입 정의
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!
}작업
audios
오디오 파일을 검색합니다. 모두 나열하려면 query를 비워 두세요.
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 }
}audioCount
쿼리에 일치하는 오디오 파일 수를 셉니다.
query audioCount($query: String!) {
audioCount(query: $query)
}audioByPath
파일 경로에 해당하는 오디오 메타데이터를 읽습니다.
query audioByPath($path: String!) {
audioByPath(path: $path) { mediaId title artist path durationMs }
}audioLyrics
카탈로그 오디오 미디어 ID에 연결된 가사를 읽습니다.
query audioLyrics($mediaId: ID!) {
audioLyrics(mediaId: $mediaId)
}audioLyricsByPath
오디오 파일 경로에 연결된 가사를 읽습니다.
query audioLyricsByPath($path: String!) {
audioLyricsByPath(path: $path)
}audioArtists
미디어 라이브러리의 오디오 아티스트 목록을 반환합니다.
query audioArtists {
audioArtists { name itemCount playCount samplePath }
}audioPlayback
선택한 오디오의 ID와 경로를 읽습니다.
query audioPlayback {
audioPlayback { mediaId path }
}selectAudio
mediaId로 오디오 트랙을 선택해 반환합니다. 재생은 시작하지 않습니다.
mutation selectAudio($mediaId: ID!) {
selectAudio(mediaId: $mediaId) { mediaId title artist path durationMs }
}selectAudioByPath
파일 경로로 오디오를 선택합니다. 재생은 시작하지 않습니다.
mutation selectAudioByPath($path: String!) {
selectAudioByPath(path: $path) { mediaId title artist path durationMs }
}updateAudioPlayMode
재생 모드를 설정합니다.
mutation updateAudioPlayMode($mode: MediaPlayMode!) {
updateAudioPlayMode(mode: $mode)
}audioQueueItems
쿼리에 일치하는 대기열의 오디오 트랙을 페이지 단위로 읽습니다.
query audioQueueItems($query: String!, $offset: Int!, $limit: Int!) {
audioQueueItems(query: $query, offset: $offset, limit: $limit) { mediaId title artist path durationMs }
}audioQueueItemCount
오디오 재생 대기열의 항목 수를 셉니다.
query audioQueueItemCount($query: String!) {
audioQueueItemCount(query: $query)
}addAudioToQueue
쿼리에 일치하는 오디오 트랙을 재생 대기열 끝에 추가합니다.
mutation addAudioToQueue($query: String!) {
addAudioToQueue(query: $query)
}removeAudioFromQueue
재생 대기열에서 미디어 ID를 제거합니다.
mutation removeAudioFromQueue($mediaId: ID!) {
removeAudioFromQueue(mediaId: $mediaId)
}reorderAudioQueue
제공된 미디어 ID 순서로 대기열 트랙을 재정렬합니다.
mutation reorderAudioQueue($mediaIds: [ID!]!) {
reorderAudioQueue(mediaIds: $mediaIds)
}replaceAudioQueue
선택한 검색 결과로 재생 대기열을 대체하고 선택된 트랙이 있으면 반환합니다.
mutation replaceAudioQueue($query: String!, $sortBy: AudioSortBy!, $shuffle: Boolean!) {
replaceAudioQueue(query: $query, sortBy: $sortBy, shuffle: $shuffle) { mediaId title artist path durationMs }
}clearAudioQueue
오디오 재생 대기열에서 모든 항목을 제거합니다.
mutation clearAudioQueue {
clearAudioQueue
}audioPlaylists
저장된 오디오 재생 목록을 나열합니다.
query audioPlaylists {
audioPlaylists { id name itemCount createdAt updatedAt }
}audioPlaylist
ID로 오디오 재생목록 하나를 읽습니다.
query audioPlaylist($id: ID!) {
audioPlaylist(id: $id) { id name itemCount createdAt updatedAt }
}audioPlaylistItems
재생 목록에서 쿼리에 일치하는 트랙을 페이지 단위로 읽습니다.
query audioPlaylistItems($id: ID!, $query: String!, $offset: Int!, $limit: Int!) {
audioPlaylistItems(id: $id, query: $query, offset: $offset, limit: $limit) { mediaId title artist path durationMs }
}audioPlaylistItemCount
재생 목록에서 쿼리에 일치하는 트랙 수를 셉니다.
query audioPlaylistItemCount($id: ID!, $query: String!) {
audioPlaylistItemCount(id: $id, query: $query)
}createAudioPlaylist
이름 있는 오디오 재생 목록을 만듭니다.
mutation createAudioPlaylist($name: String!) {
createAudioPlaylist(name: $name) { id name itemCount createdAt updatedAt }
}updateAudioPlaylist
기존 오디오 재생 목록의 이름을 변경합니다.
mutation updateAudioPlaylist($id: ID!, $name: String!) {
updateAudioPlaylist(id: $id, name: $name) { id name itemCount createdAt updatedAt }
}addAudioPlaylistItems
쿼리에 일치하는 오디오 트랙을 지정한 재생 목록에 추가합니다.
mutation addAudioPlaylistItems($id: ID!, $query: String!) {
addAudioPlaylistItems(id: $id, query: $query)
}removeAudioPlaylistItems
쿼리에 일치하는 재생 목록 항목을 제거하고 영향받은 수를 보고합니다.
mutation removeAudioPlaylistItems($id: ID!, $query: String!) {
removeAudioPlaylistItems(id: $id, query: $query) { affectedCount }
}deleteAudioPlaylist
지정한 재생 목록과 해당 소속 레코드를 삭제합니다.
mutation deleteAudioPlaylist($id: ID!) {
deleteAudioPlaylist(id: $id)
}