IWMSPlaylist::get_NestedPlaylist

banner art

Previous Next

IWMSPlaylist::get_NestedPlaylist

The get_NestedPlaylist method retrieves a nested playlist object.

Syntax

  HRESULT get_NestedPlaylist(
  
  IXMLDOMElement*
  
  pPlaylistEntry
  ,
  
  IWMSPlaylist**
  
  ppPlaylist
  
  );

Parameters

pPlaylistEntry

[in] Pointer to a playlist entry object.

ppPlaylist

[out] Pointer to a pointer to a new IWMSPlaylist interface. This method calls AddRef internally. To avoid memory leaks, you must call Release when you are finished using the interface.

Return Values

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

Return code Number Meaning
E_FAIL 0x80004005 pPlaylistEntry is not a nested playlist.
E_INVALIDARG 0x80070057 pPlaylistEntry or ppPlaylist is a NULL pointer argument.

Remarks

This method gets a nested playlist. If the first parameter of the playlist is not a media element that references a playlist file, or if the media element is not cued or is not the current element, an error code is returned.

The IsStreamCued property can be used to determine whether the media element is cued.

Example Playlist File

In the following playlist, the src attribute for "media2" references another playlist.

  

The nested playlist (playlist.wsx) contains the following syntax.

  

A short time after the server starts streaming "media1" from the first playlist, it cues "nested_media1" in the nested playlist. At this point, the get_NestedPlaylist method can be used to retrieve an IWMSPlaylist interface for the nested playlist. After the server finishes streaming all of the items in the nested playlist, it returns to the parent playlist and starts streaming "media3". At this point "media2" is no longer cued, and you can no longer use the get_NestedPlaylist method to retrieve an IWMSPlaylist object for it. However, you can always use the CueStream method to re-cue the nested playlist.

Example Code

   entry.



 entry.

























Requirements

Header: wmsserver.h

Library: WMSServerTypeLib.dll

Platform: Windows Server 2003 family, Windows Server 2008 family.

See Also

Previous Next