Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This method sets the current play mode for this AVTransport instance.

Syntax 

virtual DWORD SetPlayMode(
  LPCWSTR 
pszNewPlayMode
) = 0;

Parameters

pszNewPlayMode

[in] Play mode, like normal, shuffle, repeat all, and so on. Contains one of the PlayModeconstants. Corresponds to the CurrentPlayMode state variable.

Return Value

Custom implementations can return appropriate error codes. Should return SUCCESS_AV if the method succeeds. Otherwise, should return an error code defined in WinError.h or UPnP.h, or one of the UPnP AV-specific return values specified in UPnPAVError, especially the following errors documented for this action in the AVTransport DCP documentation:

  • ERROR_AV_UPNP_AVT_TRANSPORT_LOCKED

  • ERROR_AV_UPNP_AVT_UNSUPPORTED_PLAY_MODE

  • ERROR_AV_UPNP_AVT_INVALID_INSTANCE_ID

Remarks

This method corresponds to the AVTransport service's SetPlayMode action.

The AVTransport service does not require that this method be implemented. The IAVTransportImplclass therefore overrides this method to return ERROR_AV_UPNP_INVALID_ACTION.

For more information about the actions in the AVTransport service, see UPnP AV DCP Documentation.

Requirements

Header av_upnp.h
Library Av_upnp.lib
Windows Embedded CE Windows CE 5.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also