Sync

Any client can report that it supports sync with two additions to their ClientCapabilities:

• Specify SupportsSync = true
• Specify DeviceProfile object

A DeviceProfile is the same structure that is used by Dlna Profiles. The default profile can be found here:

https://github.com/MediaBrowser/MediaBrowser/blob/master/MediaBrowser.Model/Dlna/Profiles/DefaultProfile.cs

For brevity, all Dlna-specific properties such as ProtocolInfo, Manufacturer/Model, etc. can be omitted.

Determining user sync privileges

Coming soon.

Sync UI

Clients should make sync available from as many contexts as possible. This includes, but is not limited to:

• Detail screens
• List screens (single selection)
• List screens (multi-selection)
• Home screen (single selection)
• Home screen (category selection, e.g. Next Up, Latest Movies, etc).

All library items are eligible for sync and clients should not artificially filter them. Instead, simply check the SupportsSync property to determine if an item supports syncing. You will need to include SyncInfo as part of your requested fields in order to make this property available.

Creating Sync Jobs

In order to create the sync job, send a Post to /Sync/Jobs. A complete example is available in our ApiClient libraries. See CreateSyncJob.

Running sync jobs

All of the client-side code needed to run sync jobs is provided in our Api libraries. The MultiServerSync operation will handle both sync and camera upload for all authenticated servers. It is available in both .NET and Java:

https://github.com/MediaBrowser/MediaBrowser.ApiClient https://github.com/MediaBrowser/MediaBrowser.ApiClient.Java

If using another language it will need to be ported.

Client-side sync management

Coming soon.

Online access

Coming soon.

Offline access

Coming soon.