Windows Media Format SDK banner art
PreviousNext

IMDSPObjectInfo::GetPlayOffset

The GetPlayOffset method returns the play offset of the object, in units pertinent to the object. This is the starting point for the next invocation of Play.

Syntax

HRESULT GetPlayOffset(
  DWORD*  pdwOffset
);

Parameters

  pdwOffset

[out]  Pointer to a double word containing the play offset of the object, in units pertinent to the object.

Return Values

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

Return code Description
E_INVALIDTYPE The object that this interface is associated with is not a valid playable file or a folder or file system containing playable files.
WMDM_E_NOTSUPPORTED This object cannot report the play offset.
E_FAIL An unspecified error occurred.

Remarks

The value is either zero (if the SetPlayOffset method has not been called) or the value set by SetPlayOffset clipped to be no greater than the total play length of the object minus one unit.

For playable files, the value returned is specified in milliseconds. The play offset position value does not change when the user presses Play on the media device or when an application invokes the IMDSPDeviceControl::Play method.

For folders or file systems containing playable files, the value returned indicates the first track that is played when an application invokes the IMDSPDeviceControl::Play method.

See Also

PreviousNext


© 1999 Microsoft Corporation. All rights reserved.