PlainApp
API 參考

跨類型媒體

透過 app.capabilities 判斷功能支援,透過 app.access 和主機權限判斷存取授權。範例使用合成值;呼叫前請替換路徑、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)的全部媒體儲存分組,用於構建圖庫的資料夾視圖。

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