Share via


SyncState Attribute

[The feature associated with this page, Windows Media Player SDK, is a legacy feature. It has been superseded by MediaPlayer. MediaPlayer has been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer instead of Windows Media Player SDK, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The SyncState attribute is a string representation of a 32-bit value that Windows Media Player uses when it synchronizes playlists with portable devices.

Applies To

Remarks

This attribute consists of sixteen 2-bit values, each of which specifies the synchronization state of a portable device. The most significant bit (MSB) of this 32-bit value corresponds to device 16. The least significant bit (LSB) corresponds to device 1.

The MSB of each 2-bit value indicates whether Windows Media Player synchronized the content with the corresponding device. A value of 1 indicates that it did. A value of 0 indicates that it did not.

If the MSB is 0, the LSB specifies why the synchronization failed. A value of 1 in the LSB indicates that there was not enough free space for the content. A value of 0 in the LSB indicates some other reason prevented synchronization.

To retrieve the synchronization state of a given device, you should do the following:

  1. Invoke IWMPSyncDevice::get_status to determine whether a given device is synchronized.
  2. If it is synchronized, invoke IWMPSyncDevice::get_partnershipIndex to retrieve the index of the device's bit pair in the SyncState attribute.
  3. Using this index, mask the corresponding bit pair of the SyncState attribute and examine the result to determine the synchronization state of the playlist with the device.

To determine whether you can change the value of this attribute, use the Media.isReadOnlyItem method.

Requirements

Requirement Value
Version
Windows Media Player 10 or later

See also

Attribute Reference

Determining Playlist Synchronization State

IWMPSyncDevice::get_partnershipIndex

IWMPSyncDevice::get_status