Referencia de la API

Multimedia (multi-tipo)

Consultar app.capabilities para comprobar la compatibilidad de funciones y app.access junto con los permisos del anfitrión para la autorización. Los ejemplos usan valores sintéticos; sustituir las rutas, ID, entradas y filtros antes de llamar.

Definiciones de tipos

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
}

Operaciones

subscription

mediaUpdated

Recibir información de cambios en la biblioteca multimedia para actualizar las listas afectadas.

graphql
subscription mediaUpdated {
  mediaUpdated { types }
}
mutation

deleteMediaItems

Eliminar permanentemente los elementos multimedia coincidentes y devolver el número afectado; se exige una consulta explícita que limite la selección.

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

Mover los elementos multimedia coincidentes al directorio de destino y devolver el número afectado.

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

restoreMediaItems

Restaurar los elementos multimedia de la papelera coincidentes y devolver el número afectado.

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

trashMediaItems

Mover a la papelera los elementos multimedia coincidentes y devolver el número afectado; se exige una consulta explícita que limite la selección.

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

recordMediaPlay

Registrar el inicio de reproducción y la posición de un elemento multimedia del catálogo.

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

saveMediaPlayProgress

Guardar la posición de reproducción de un elemento multimedia sin registrar otro inicio de reproducción.

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

mediaBuckets

Listar todos los contenedores del almacén multimedia de un tipo de datos (p. ej., IMAGE, VIDEO). Sirve para crear la vista de carpetas de la galería.

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

mediaPlayHistory

Consultar una página de registros del historial de reproducción multimedia que coincidan con la consulta.

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