API リファレンス
Media (クロスタイプ)
機能の対応状況は 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)のすべてのメディアストアバケットを一覧表示します。ギャラリー 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 }
}