Svrf API Docs

Media Schema

Schema for Media from Svrf.

KeyTypeDescription
idstringThe unique ID of this Media.
titlestringThe title of the Media, suitable for displaying.
descriptionstringA description of the Media.
authors[string]The Media's authors. This should be displayed when possible.
sitestringThe site that this Media came from. This should be displayed when possible.
canonicalstringThe canonical page this Media can be found at via Svrf.
urlstringThe original page this Media is located at.
embedUrlstringA player that can be embedded using an <iframe> tag to play the Media.
embedHtmlstringAn <iframe> tag that embeds a player that plays the Media.
typestringThe type of the Media. This should influence the media controls displayed to the user.
adultbooleanWhether the Media is adult content.
widthintegerThe width, in pixels, of the Media's source.
heightintegerThe height, in pixels, of the Media's source.
durationintegerThe duration of the Media in seconds.
metadataobjectMetadata about the Media.
metadata.isFaceFilterbooleanFor 3D Media, denotes that this model can be applied as a face filter overlay on a video of a face.
metadata.hasBlendShapesbooleanFor 3D Media, denotes that this model contains blend shapes, but having to calculate and apply weights to them is not required. These are models like glasses, hats, and billboards that do not react to face movement.
metadata.requiresBlendShapesbooleanFor 3D Media, denotes that calculating and applying blend shape weights to this model is required for the correct experience. If your platform cannot detect and calculate blend shape weights you MUST NOT present these models to your users.
filesobjectVarious sizes of images and resolutions for the Media. They will never be larger than the Media source's original resolution.
files.imagesobjectResized jpeg stills of the Media. For video, these will be stills from 1/3 of the video's duration. Resolutions larger than the original size will not be included (the original is included as max). For stereoscopic content, this will be a monoscopic version of the top or left channel.
files.videosobjectResized mp4 (H.264) videos of the Media. Only included if the Media is video. Resolutions larger than the original size will not be included (the original is included as max). For stereoscopic content, this will be a monoscopic version of the top or left channel.
files.stereoobjectResized versions of the Media, matching the Media's type, in stereo. Only included if the Media is stereoscopic. Resolutions larger than the original size will not be included (the original is included as max).
files.gltfobjectA map of file names to urls where those files are hosted. The file names are relative and their name heirarchy should be respected when saving them locally.
files.glbstringThis is the binary glTF format that should be used by clients if the Media is a 3D object. This is the preferred format to use on end-user devices.
files.glb-dracostringThis is the binary glTF format, with additional DRACO compression, that should be used by clients if the Media is a 3D object. Your renderer must support the KHR_draco_mesh_compression extension to use this model.