mm_sync_control()

Send commands to a synchronization in progress

Synopsis:

#include <mmsync/mmsyncclient.h>

int mm_sync_control( mmsync_hdl_t *hdl, 
                     uint32_t op_id, 
                     strm_dict_t *extended_options, 
                     uint32_t flags )

Arguments:

hdl

The mm-sync connection handle pointer.

op_id

The operation ID of the synchronization being controlled.

extended_options

A set of key/value pairs containing synchronization control commands, formatted as follows:

key1=value1,key2=value2,key3=value3,...

Key	Value	Description
`action`	Currently, only one action is supported: priority_folder_set	The action to perform on the synchronization.
`folderid`	An integer storing the ID of a mediastore folder.	The folder the action is performed on. Either this field or `folder_path` must be defined for actions such as priority_folder_set that affect a particular folder.
`folder_path`	A string storing the path of a mediastore folder. The path is relative to the mediastore's filesystem (e.g., "/" refers to the mediastore's root folder).	The folder the action is performed on. Either this field or `folderid` must be defined for actions such as priority_folder_set that affect a particular folder.
`dynamic_folder`	enable \| disable	Enable or disable the dynamic setting for the folder referred to by `folderid` or `folder_path`. This option applies to the priority_folder_set action. When this setting is enabled, the `fids` for files in this folder will remain constant. The setting is nonrecursive, so the only files affected are those in the top-level folder in the synchronization path named in the operation `op_id`; files in subfolders aren't affected. For information on how this setting impacts synchronization, see "Maintaining constant IDs for updated files and playlists".

Action	Description
priority_folder_set	Initiates a priority folder synchronization. Requires one of the `folderid` and `folder_path` key/value pairs. You can also define the `dynamic_folder` key to enable or disable the dynamic folder setting.

flags

Reserved for future use, must be 0.

Library:

mmsyncclient

Description:

Send commands to a synchronization in progress. Currently, the only command supported is priority_folder_set, which initiates a priority folder synchronization.

Returns:

0 on success, -1 on failure.