PlainApp
API குறிப்பு

ஊடகம் (பல வகைகள்)

அம்ச ஆதரவிற்கு app.capabilities-ஐயும் அனுமதிக்கு app.access மற்றும் host அனுமதிகளையும் சரிபார்க்கவும். எடுத்துக்காட்டுகள் செயற்கை மதிப்புகளைப் பயன்படுத்துகின்றன; அழைப்பதற்கு முன் பாதைகள், ID-கள், உள்ளீடுகள் மற்றும் வடிப்பான்களை மாற்றவும்.

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

graphql
type Subscription {
  mediaUpdated: MediaChange!
}

type Mutation {
  deleteMediaItems(type: MediaDataType!, query: String!): ActionResult!
  moveMediaItems(type: MediaDataType!, query: String!, destDir: String!): ActionResult!
  restoreMediaItems(type: MediaDataType!, query: String!): ActionResult!
  trashMediaItems(type: MediaDataType!, query: String!): ActionResult!
  recordMediaPlay(mediaId: ID!, type: PlaybackType!, positionMs: Long!): Boolean!
  saveMediaPlayProgress(mediaId: ID!, type: PlaybackType!, positionMs: Long!): Boolean!
}

type Query {
  mediaBuckets(type: MediaDataType!): [MediaBucket!]!
  mediaPlayHistory(query: String!, offset: Int!, limit: Int!): [MediaPlayHistory!]!
}

type ActionResult {
	affectedCount: Int!
}

scalar Instant

scalar Long

type MediaBucket {
	size: Long!
	id: ID!
	name: String!
	itemCount: Int!
	topItemPaths: [String!]!
}

type MediaChange {
	types: [MediaDataType!]!
}

enum MediaDataType {
	AUDIO
	VIDEO
	IMAGE
	DOC
}

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

type MediaPlayHistory {
	mediaId: ID!
	mediaType: PlaybackType!
	positionMs: Long!
	playCount: Long!
	playedAt: Instant!
	media: MediaItem!
}

enum PlaybackType {
	AUDIO
	VIDEO
}

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

subscription

mediaUpdated

பாதிக்கப்பட்ட பட்டியல்களைப் புதுப்பிக்க ஊடக நூலக மாற்றத் தகவலைப் பெறவும்.

graphql
subscription mediaUpdated {
  mediaUpdated { types }
}
mutation

deleteMediaItems

பொருந்தும் ஊடக உருப்படிகளை நிரந்தரமாக நீக்கி பாதிக்கப்பட்ட எண்ணிக்கையைத் தெரிவிக்கவும்; வரம்பை வெளிப்படையாகக் குறைக்கும் வினவல் தேவை.

graphql
# A blank query would match the whole library, and a bulk delete is
# not something a client should be able to aim at everything by
# accident — it is refused before the platform is asked.
mutation deleteMediaItems($type: MediaDataType!, $query: String!) {
  deleteMediaItems(type: $type, query: $query) { affectedCount }
}
mutation

moveMediaItems

பொருந்தும் ஊடக உருப்படிகளை இலக்கு அடைவிற்கு நகர்த்தி பாதிக்கப்பட்ட எண்ணிக்கையைத் தெரிவிக்கவும்.

graphql
mutation moveMediaItems($type: MediaDataType!, $query: String!, $destDir: String!) {
  moveMediaItems(type: $type, query: $query, destDir: $destDir) { affectedCount }
}
mutation

restoreMediaItems

பொருந்தும் குப்பை ஊடக உருப்படிகளை மீட்டெடுத்து பாதிக்கப்பட்ட எண்ணிக்கையைத் தெரிவிக்கவும்.

graphql
mutation restoreMediaItems($type: MediaDataType!, $query: String!) {
  restoreMediaItems(type: $type, query: $query) { affectedCount }
}
mutation

trashMediaItems

பொருந்தும் ஊடக உருப்படிகளைக் குப்பைக்கு நகர்த்தி பாதிக்கப்பட்ட எண்ணிக்கையைத் தெரிவிக்கவும்; வரம்பை வெளிப்படையாகக் குறைக்கும் வினவல் தேவை.

graphql
mutation trashMediaItems($type: MediaDataType!, $query: String!) {
  trashMediaItems(type: $type, query: $query) { affectedCount }
}
mutation

recordMediaPlay

பட்டியல் ஊடக உருப்படியின் இயக்கத் தொடக்கத்தையும் நிலையையும் பதிவுசெய்யவும்.

graphql
mutation recordMediaPlay($mediaId: ID!, $type: PlaybackType!, $positionMs: Long!) {
  recordMediaPlay(mediaId: $mediaId, type: $type, positionMs: $positionMs)
}
mutation

saveMediaPlayProgress

இயக்கத் தொடக்கத்தை மீண்டும் பதிவுசெய்யாமல் ஊடக உருப்படியின் இயக்க நிலையைச் சேமிக்கவும்.

graphql
mutation saveMediaPlayProgress($mediaId: ID!, $type: PlaybackType!, $positionMs: Long!) {
  saveMediaPlayProgress(mediaId: $mediaId, type: $type, positionMs: $positionMs)
}
query

mediaBuckets

கொடுக்கப்பட்ட தரவு வகைக்கான (எ.கா. IMAGE, VIDEO) அனைத்து ஊடகச் சேமிப்பு bucket-களையும் பட்டியலிடவும். கேலரி UI-இன் ‘கோப்புறைகள்’ காட்சியை உருவாக்கப் பயன்படுகிறது.

graphql
query mediaBuckets($type: MediaDataType!) {
  mediaBuckets(type: $type) { size id name itemCount topItemPaths }
}
query

mediaPlayHistory

வினவலுக்குப் பொருந்தும் ஊடக இயக்க வரலாற்றுப் பதிவுகளின் ஒரு பக்கத்தைப் படிக்கவும்.

graphql
query mediaPlayHistory($query: String!, $offset: Int!, $limit: Int!) {
  mediaPlayHistory(query: $query, offset: $offset, limit: $limit) { mediaId mediaType positionMs playCount playedAt }
}