ஒலி
அம்ச ஆதரவிற்கு app.capabilities-ஐயும் அனுமதிக்கு app.access மற்றும் host அனுமதிகளையும் சரிபார்க்கவும். எடுத்துக்காட்டுகள் செயற்கை மதிப்புகளைப் பயன்படுத்துகின்றன; அழைப்பதற்கு முன் பாதைகள், 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)
}