Svrf API Docs

Media Endpoints

Request augmented reality and virtual reality content from Svrf using the Media API request methods.

SearchAsync()

The Search Endpoint brings the power of immersive search found on Svrf.com to your app or project. Our search engine enables your users to instantly find the immersive experience they're seeking. Content is sorted by the Svrf rating system, ensuring that the highest quality content and most relevant search results are returned first.

Syntax

using Svrf;
using Svrf.Models.Http;
SvrfClient svrf = new SvrfClient("your key");
MultipleMediaResponse response = await svrf.Media.SearchAsync(query [, options]);

Parameters

ParameterTypeDescription
querystringSearch query.
optionsMediaRequestParamsAn object for setting the HTTP request params.

Return Value

Returns a Task with a MultipleMediaResponse instance.

GetTrendingAsync()

The Trending Endpoint provides your app or project with the hottest immersive content - curated by real humans. The experiences returned mirror Svrf, from timely cultural content to trending pop-culture references. The trending experiences are updated regularly to ensure users always get fresh updates of immersive content.

Syntax

using Svrf;
using Svrf.Models.Http;
SvrfClient svrf = new SvrfClient("your key");
MultipleMediaResponse response = await svrf.Media.GetTrendingAsync([options]);

Parameters

ParameterTypeDescription
optionsMediaRequestParamsAn object for setting the HTTP request params.

Return Value

Returns a Task with a MultipleMediaResponse instance.

GetByIdAsync()

Fetch Svrf Media by its ID.

Syntax

using Svrf;
using Svrf.Models.Http;
SvrfClient svrf = new SvrfClient("your key");
SingleMediaResponse response = await svrf.Media.GetByIdAsync(id);

Parameters

ParameterTypeDescription
id`intstring`

Return Value

Returns a Task with a SingleMediaResponse instance.

MediaRequestParams

Namespace: Svrf.Models.Http

MediaRequestParams class represents criterias that you may want to provide when requesting multiple media.

Parameters

NameTypeDescription
CategoryCategory?Search only for Media with a particular category.
TypeIEnumerable<MediaType>The type(s) of Media to be returned.
StereoscopicTypeStereoscopicType?[Deprecated] Search only for Media with a particular stereoscopic type.
HasBlendShapesbool?Search only for Media that has blend shapes.
IsFaceFilterbool?Search only for face filters.
RequiresBlendShapesbool?Search only for Media that requires blend shapes.
MinimumWidthint?[Deprecated] The minimum width for video and photo Media, in pixels.
PageNumint?Pagination control to fetch the next page of results, if applicable.
Sizeint?The number of results to return per-page, from 1 to 100.