IDirectMusicPort8::GetLatencyClock

The GetLatencyClock method retrieves an IReferenceClock interface pointer to the port's latency clock. The latency clock specifies the nearest time in the future at which a message can be played on time. The latency clock is based on the DirectMusic master clock, which is set by using the IDirectMusic8::SetMasterClock method.

Syntax

HRESULT GetLatencyClock(
  IReferenceClock** ppClock
);

Parameters

ppClock

Address of a variable that receives the latency clock's IReferenceClock interface pointer.

Return Values

If the method succeeds, the return value is S_OK.

If it fails, the method can return E_POINTER.

Remarks

In accordance with COM rules, GetLatencyClock increments the reference count of the returned interface. Therefore, the application must call Release on the IReferenceClock interface at some point.

Requirements

**  Header:** Dmusicc.h

See Also

© 2004 Microsoft Corporation. All rights reserved.