Video Station API

The VideoStation API is an AuthenticatedAPI, that means the user needs to be authenticated before using this API. Fortunately, the AuthenticatedAPI is smart enough to automatically log the user.

The syno object uses the vs (or videoStation alias) property to interact with the VideoStation API.

SYNO.VideoStation.Info

Description

Provide Video Station information.

Methods

Method Name	Description	Required params
`getVideoStationInfo(callback)`	Provide Video Station information	-

SYNO.VideoStation.Video

TO DOCUMENT

SYNO.VideoStation.Movie

Description

Provide Video Station Movies methods.

Methods

Method Name	Description	Required params
`listMovies(params, callback)`	List movies	-
`searchMovie(params, callback)`	Search a movie	`title`
`getMovieInfo(params, callback)`	Get information about a movie	`id`

TODO: Missing Methods to implements

Method Name	Description	Required params
`editMovie(params, callback)`	Edit a movie	?

SYNO.VideoStation.TVShow

Description

Provide Video Station TV Shows methods.

Methods

Method Name	Description	Required params
`listTVShows(params, callback)`	List TV shows	-
`searchTVShow(params, callback)`	Search a TV Show	`title`
`getTVShowInfo(params, callback)`	Get information about a TV Show	`id`

TODO: Missing Methods to implements

Method Name	Description	Required params
`editTVShow(params, callback)`	Edit a TV Show	?

SYNO.VideoStation.TVShowEpisode

Description

Provide Video Station TV Show Episodes methods.

Methods

Method Name	Description	Required params
`listTVShowEpisodes(params, callback)`	List TV shows episodes	-
`searchTVShowEpisode(params, callback)`	Search a TV Show episode	`title`
`getTVShowEpisodeInfo(params, callback)`	Get information about a TV Show episode	`id`

TODO: Missing Methods to implements

Method Name	Description	Required params
`editTVShowEpisode(params, callback)`	Edit a TV Show episode	?
`editADVTVShowEpisode(params, callback)`	?	?

SYNO.VideoStation.HomeVideo

Description

Provide Video Station Home Video methods.

Methods

Method Name	Description	Required params
`listHomeVideos(params, callback)`	List Home videos	-
`searchHomeVideo(params, callback)`	Search a Home video	`title`
`getHomeVideoInfo(params, callback)`	Get information about a Home video	`id`

TODO: Missing Methods to implements

Method Name	Description	Required params
`editHomeVideo(params, callback)`	Edit a Home video	?

SYNO.VideoStation.TVRecording

Description

Provide Video Station TV Recordings methods.

Methods

Method Name	Description	Required params
`listTVRecordings(params, callback)`	List TV recordings	-
`searchTVRecording(params, callback)`	Search a TV recording	`title`
`getTVRecordingInfo(params, callback)`	Get information about a TV recording	`id`

TODO: Missing Methods to implements

Method Name	Description	Required params
`editTVRecording(params, callback)`	Edit a TV recording	?

SYNO.VideoStation.Collection

Description

Provide Video Station Collection methods.

Methods

Method Name	Description	Required params
`listCollections(params, callback)`	List collections	-
`searchCollection(params, callback)`	Search a collection	`title`
`getCollectionInfo(params, callback)`	Get information about a collection	`id`

TODO: Missing Methods to implements

Method Name	Description	Required params
`video_list(params, callback)`	?	?
`video_getinfo(params, callback)`	?	?
`create(params, callback)`	?	?
`delete(params, callback)`	?	?
`edit(params, callback)`	?	?
`addvideo(params, callback)`	?	?
`deletevideo(params, callback)`	?	?

SYNO.VideoStation.Metadata

Description

Provide Video Station Metadata methods.

Methods

Method Name	Description	Required params
`listMetadatas(params, callback)`	List metadatas	`id`

SYNO.VideoStation.Poster

Description

Provide Video Station Poster methods.

TODO: Missing Methods to implements

Method Name	Description	Required params
`getimage(params, callback)`	?	?
`setimage(params, callback)`	?	?

SYNO.VideoStation.Rating

Description

Provide Video Station Rating methods.

TODO: Missing Methods to implements

Method Name	Description	Required params
`getRatingInfo(params, callback)`	?	?
`updateRatingInfo(params, callback)`	?	?

SYNO.VideoStation.Streaming

Description

Provide Video Station Streaming methods.

TODO: Missing Methods to implements

Method Name	Description	Required params
`open(params, callback)`	?	-
`stream(params, callback)`	?	-
`close(params, callback)`	?	-

SYNO.VideoStation.PluginSearch

Description

Provide Video Station PluginSearch methods.

TODO: Missing Methods to implements

Method Name	Description	Required params
`start(params, callback)`	?	-
`stop(params, callback)`	?	-
`list(params, callback)`	?	-
`query(params, callback)`	?	-

SYNO.VideoStation.Subtitle

Description

Provide Video Station Subtitle methods.

Methods

Method Name	Description	Required params
`listSubtitles(params, callback)`	List subtitles	`id`

TODO: Missing Methods to implements

Method Name	Description	Required params
`get(params, callback)`	?	?

SYNO.VideoStation.AudioTrack

Description

Provide Video Station audio tracks methods.

Methods

Method Name	Description	Required params
`listAudioTracks(params, callback)`	List audio tracks of a media	`id`

SYNO.VideoStation.Folder

Description

Provide Video Station folders methods.

Methods

Method Name	Description	Required params
`listFolders(params, callback)`	List folders	-

SYNO.VideoStation.WatchStatus

Description

Provide Video Station watch status methods.

Methods

Method Name	Description	Required params
`getWatchStatusInfo(params, callback)`	Get watch status info of a media	`id`

TODO: Missing Methods to implements

Method Name	Description	Required params
`setinfo(params, callback)`	?	?

SYNO.VideoStation.Library

Description

Provide Video Station Libraries methods.

Methods

Method Name	Description	Required params
`listLibraries(params, callback)`	List Libraries	-

Video Station API