PlainApp
API குறிப்பு

Audio

ஆடியோ கோப்புகளை உலாவு மற்றும் சாதனத்தில் பிளேபேக்கை கட்டுப்படுத்தவும். தொலைபேசி மீடியா பிளேயராக செயல்படுகிறது.

வகை வரையறைகள்

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
}

செயல்பாடுகள்

query

audios

ஆடியோ கோப்புகளைத் தேடவும். அனைத்தையும் பட்டியலிட query-யை வெற்றாக விடவும்.

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

ஒரு query-யுடன் பொருந்தும் ஆடியோ கோப்புகளை எண்ணவும்.

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

playAudio

சாதனத்தில் ஒரு ஆடியோ கோப்பை இயக்கத் தொடங்கவும். முன்பே இல்லையென்றால் பிளேலிஸ்ட்டில் சேர்க்கிறது.

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

updateAudioPlayMode

பிளேபேக் பயன்முறையை அமைக்கவும்.

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

clearAudioPlaylist

தற்போதைய பிளேலிஸ்ட்டை அழித்து பிளேபேக்கை நிறுத்தவும்.

bash
mutation ClearAudioPlaylist {
  clearAudioPlaylist
}
mutation

deletePlaylistAudio

கோப்பு பாதை மூலம் பிளேலிஸ்ட்டில் இருந்து ஒரு ட்ராக்கை அகற்றவும்.

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

addPlaylistAudios

தற்போதைய பிளேலிஸ்ட்டில் 1,000 வரை பொருந்தும் ஆடியோ கோப்புகளைச் சேர்க்கவும்.

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

reorderPlaylistAudios

கோப்பு பாதைகளின் வரிசைப்படுத்தப்பட்ட பட்டியலை வழங்கி பிளேலிஸ்ட்டை மறுவரிசைப்படுத்தவும்.

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