Documentation
v0.1.0
iOSAndroidJavaScript

Classes

Account
Expand all / Collapse all

This class provides access to the account.

Class Properties

authCodeString
The developer token that is assigned to you by V.
appIDString
The application id that is assigned to you by V.
errorErr
This is the error that may have occured while trying to start a session. This is not null if accountState == ERROR
accountStateAccount.State
This represents current state of session - Disconnected, Connecting, Connected, or Error

Class Methods

void startSession
Starts the session. You could check on the state of session via accountState. Ensure authCode and appID are filled.
Arguments
listener

Callback *required

Callback to be used to notify accountState changes
void stopSession
Stops the session. You could check on the state of the session via accountState.
register
Register new listener to get accountState change notifications. Adding multiple listeners is supported.
unregister
Remove a registered listener to stop receive callbacks for accountState change events.

VideoStore
Expand all / Collapse all

This is a video store class that contains all your repository of videos. Use this class to query and delete videos.

Class Properties

hasCacheboolean
It is a flag for the VideoStore object to cache the playlist calls or not. Default value is false.
cacheLimitint
The limit to cache the items. It is by number of videos. Default is set to 0.

Class Methods

void getVideos()
Starts the session. You could check on the state of session via accountState. Ensure devToken and appID are filled.
Arguments
tags

String[] *required

This is a set of string tags to search for. Must not be null but could be empty.
metadata

String[] *required

This is a set of string metadata to search for. Must not be null but could be empty.
callback

Callback *required

This is the completion block to be called when the playlist is returned. If the call was successful then a VideoPlaylist is returned. Else null is returned with an error included.
unregister
Unregisters callback
Arguments
tags

Callback *required

Callback to unregister.

VideoPlaylist
Expand all / Collapse all

This class represents a playlist of videos.

Properties

tagsString[]
The tags that defines this playlist
metadataString[]
The metadata that defines this playlist.
countInt
The total number of videos that's in this playlist.

Methods

itemAt
Gets the video object at index
Arguments
index

Int *required

The index item to request.
listener

Callback *required

the completion block to be called when the call is returned. If item exists then item will not be null. Else item is null.

VideoObject
Expand all / Collapse all

This class represents a video in playlist.

Properties

tagsString[]
The tags that describes this video.
metadataMetadata
The metadata that describes this video.
shareUrlString
The shareable url of this video.
videoIdString
The unique ID identifying this video.
locationLocation
The geolocation to which this video was taken.
creationDatelong
The creation date of this video.
modifyDatelong
The modified date of this video.
titleString
The title of this video.
videoDescriptionString
The description of this video.
thumbnailImageUrlString
The thumbnail image URL for this video.
durationint
The length of this video in seconds.

Enums

Account.State
Expand all / Collapse all

Current account state.

Values

CONNECTED
The session has started.
CONNECTING
Connecting to server
DISCONNECTED
Session has stopped
ERROR
There was an error trying to connect to server. You should check Account.error to see the description of the error