Compartilhar via


MediaCollection.getMediaAtom method

[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 getMediaAtom method retrieves the index at which a specified attribute resides within the set of available attributes.

Syntax

retVal = MediaCollection.getMediaAtom(
  attribute
)

Parameters

attribute [in]

String containing the attribute name. For information about the attributes supported by Windows Media Player, see the Windows Media Player Attribute Reference.

Return value

This method returns a Number (long).

Remarks

The index number retrieved with this method can be passed to the Media.getItemInfoByAtom method to access attribute values. This technique is generally more efficient when working with large playlists than accessing an attribute value by name through Media.getItemInfo or Media.getItemInfoByType.

To use this method, read access to the library is required. For more information, see Library Access.

Requirements

Requirement Value
Version
Windows Media Player version 7.0 or later.
DLL
Wmp.dll

See also

Media.getItemInfo

Media.getItemInfoByAtom

Media.getItemInfoByType

MediaCollection Object

Settings.mediaAccessRights

Settings.requestMediaAccessRights