fvLIBRARY API

This document is written about fvLIBRARY API (called “API”).
API is mainly consisted by 3 types of below.
  1. Media registration API
  2. fv creation request API
  3. Media management API

Each types are delivered as REST API of WEB.

Definition

Video
the data before upload/registration.
Media
the data including meta-data after upload/registration.
Tile
the divided media into some part after upload/registration.
fabric video (fv)
the combined data (H.264/AVC) by some tiles.

Basic Limitation of API

Creation of Tile Tile Creation API creates tiles specified by integer seconds(1-900 seconds) when registering a video.
Media Data Gnzo holds the created tiles and the meta-data of media only.
Maximum size of fabric video If tile type is same, tile can be combined each other, which creates fabric video (called fv), but the number of tiles to be combined are limited, described as below table.
About API authentication The API server authenticates client which calls API.
File Format for Media Registration File format for media input are described.

API List

Media registration API

Resource Description
POST /api/1/videos It register a media.

fv creation request API

Resource Description
GET /api/1/videos/fv It gets a specified order based fv.
GET /api/1/videos/fv/timeline It gets a timeline order based fv.
GET /api/1/videos/fv/random It gets a random order based fv.
GET /api/1/videos/fv/search It gets keyword search based fv.
GET /api/1/admin/fv It gets a specified order based fv for admin.

Media management API

Resource Description
GET /api/1/videos/audiotag It gets audio tags information.
GET /api/1/videos/media It gets a list of media information.
GET /api/1/videos/{media_id}/info It gets a media’s meta data. (Deprecated API)
GET /api/1/videos/info It gets multiple media’s meta data.
POST /api/1/videos/{media_id}/info It updates a media’s meta data.
POST /api/1/videos/{media_id}/activate It activates a media. (Deprecated API)
POST /api/1/videos/activate It activates multiple medias.
POST /api/1/videos/{media_id}/deactivate It deactivates a media. (Deprecated API)
POST /api/1/videos/deactivate It deactivates multiple medias.
DELETE /api/1/videos/{media_id} It deletes a media. (Deprecated API)
POST /api/1/videos/delete It delete multiple medias.
GET /api/1/videos/{media_id}/tile-status It obtains a tile creation status.
GET /api/1/videos/tile It gets a list of tile information.
GET /api/1/videos/search It gets a search result.
GET /api/1/admin/bill_plan It gets the contract information.
POST /api/1/videos/{media_id}/cancel It cancels a tile creation process.
These contents are a thing of July 31, 2017.
These contents may be changed in the future to improve our service.