Riferimento API

Media (multi-tipo)

Verificare app.capabilities per il supporto delle funzionalità e app.access insieme alle autorizzazioni host per l’autorizzazione. Gli esempi usano valori sintetici; sostituire percorsi, ID, input e filtri prima della chiamata.

Definizioni di tipo

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
}

Operazioni

subscription

mediaUpdated

Ricevere informazioni sulle modifiche alla libreria multimediale per aggiornare gli elenchi interessati.

graphql
subscription mediaUpdated {
  mediaUpdated { types }
}
mutation

deleteMediaItems

Eliminare definitivamente gli elementi multimediali corrispondenti e indicare il numero interessato; è richiesta una query esplicita che restringa la selezione.

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

Spostare gli elementi multimediali corrispondenti nella directory di destinazione e indicare il numero interessato.

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

restoreMediaItems

Ripristinare gli elementi multimediali nel cestino corrispondenti e indicare il numero interessato.

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

trashMediaItems

Spostare nel cestino gli elementi multimediali corrispondenti e indicare il numero interessato; è richiesta una query esplicita che restringa la selezione.

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

recordMediaPlay

Registrare un avvio di riproduzione e una posizione per un elemento multimediale del catalogo.

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

saveMediaPlayProgress

Salvare la posizione di riproduzione di un elemento multimediale senza registrare un altro avvio di riproduzione.

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

mediaBuckets

Elencare tutti i contenitori dell’archivio multimediale per un tipo di dati (ad es. IMAGE, VIDEO). Serve a creare la vista delle cartelle della galleria.

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

mediaPlayHistory

Leggere una pagina di record della cronologia di riproduzione multimediale corrispondenti alla query.

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