clientData

  • Article

banner art

Previous Next

clientData

You can use the clientData element to define name/value pairs that describe the content being sent to the client.

  • Note   This element is supported only by Windows Media Player 9 Series and later.

Attributes

The following table identifies the attributes supported by Windows Media Services for the clientData element.

Attribute Description
id Defines an ID reference value for the element. This value must begin with a letter.
album Identifies the album name for the content.
artist Identifies the artist who created the content.
author Identifies the author of the playlist or media file.
bannerAbstract Defines the text displayed as a ToolTip for the banner graphic identified by the bannerURL attribute. The banner graphic is displayed in Windows Media Player.
bannerInfoURL Defines the URL of a Web page that a user can access by clicking the banner graphic identified by the bannerURL attribute. The banner graphic is displayed in Windows Media Player.
bannerURL Defines the URL of a graphic file that is displayed in Windows Media Player.
copyright Identifies copyright information for a playlist or media file.
genre Identifies category information for the content.
logURL Identifies a URL that can be used to post logging statistics to a server.
title Identifies the name of a playlist or media file.

The server sends the client an attribute defined by the clientData element. However, to be useful, that attribute must be recognized by the client. The attributes in the preceding table are guaranteed to be recognized by Windows Media Player. If you are building a custom player application by using the Windows Media Format SDK, you can retrieve a custom attribute by using the IWMHeaderInfo interface.

Remarks

The WMS SMIL Playlist Parser plug-in enforces case sensitivity on the clientData element.

You can use the clientData element to send descriptive information such as copyright and artist name to the client.

  • **Note   **When multicasting, clientData metadata cannot be sent to the client in a server-side playlist. Instead, that information must be stored in the multicast announcement file.

If a parent element contains the same attribute as a child element, only the attribute for the parent is sent. In the following example, only Title_A is sent to the client.

    <?wsx version="1.0"?>
    <smil>
        <clientData Title="Title_A" />
        <media src="c:\wmpub\wmroot\movie_1.wmv" >
            <clientData Title="Title_B" />
        </media>
    </smil>

The clientData element is a valid child of any element recognized by a Windows Media server.

Example Code

The following example illustrates how to use the clientData element to send descriptive information to a client.

<?wsx version="1.0"?>
<smil>
    <media id=" m1" role="m1" src="c:\wmpub\wmroot\movie1.wmv">
        <clientData album="album_name_1" artist="artist_name_1" 
         author="author_name_1" CopyRight="copyright_info_1" 
         Genre="genre_info_1" Title="title_1" />
    </media>
</smil>

See Also

Previous Next