Media (Cross-Type)
Check app.capabilities for feature support and app.access plus host permissions for authorization. Examples use synthetic values; replace paths, IDs, inputs and filters before calling.
Type Definitions
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
}Operations
mediaUpdated
Receive media-library change information for refreshing affected lists.
subscription mediaUpdated {
mediaUpdated { types }
}deleteMediaItems
Permanently delete matching media items and report the affected count; an explicit narrowing query is required.
# 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 }
}moveMediaItems
Move matching media items into the destination directory and report the affected count.
mutation moveMediaItems($type: MediaDataType!, $query: String!, $destDir: String!) {
moveMediaItems(type: $type, query: $query, destDir: $destDir) { affectedCount }
}restoreMediaItems
Restore matching trashed media items and report the affected count.
mutation restoreMediaItems($type: MediaDataType!, $query: String!) {
restoreMediaItems(type: $type, query: $query) { affectedCount }
}trashMediaItems
Move matching media items to trash and report the affected count; an explicit narrowing query is required.
mutation trashMediaItems($type: MediaDataType!, $query: String!) {
trashMediaItems(type: $type, query: $query) { affectedCount }
}recordMediaPlay
Record a playback start and position for a catalog media item.
mutation recordMediaPlay($mediaId: ID!, $type: PlaybackType!, $positionMs: Long!) {
recordMediaPlay(mediaId: $mediaId, type: $type, positionMs: $positionMs)
}saveMediaPlayProgress
Save a media item's playback position without recording another playback start.
mutation saveMediaPlayProgress($mediaId: ID!, $type: PlaybackType!, $positionMs: Long!) {
saveMediaPlayProgress(mediaId: $mediaId, type: $type, positionMs: $positionMs)
}mediaBuckets
List all media-store buckets for a given data type (e.g. IMAGE, VIDEO). Used to build the "Folders" view in the gallery UI.
query mediaBuckets($type: MediaDataType!) {
mediaBuckets(type: $type) { size id name itemCount topItemPaths }
}mediaPlayHistory
Read a page of media playback-history records matching the query.
query mediaPlayHistory($query: String!, $offset: Int!, $limit: Int!) {
mediaPlayHistory(query: $query, offset: $offset, limit: $limit) { mediaId mediaType positionMs playCount playedAt }
}