IKeyFrameControl::PeriodicUpdatePicture method
[PeriodicUpdatePicture is not available for use in Windows Vista, Windows Server 2008, and subsequent versions of the operating system. The RTC Client API provides similar functionality.]
The PeriodicUpdatePicture method is called by an application to configure a timer in the stream that will ask for picture updates periodically. Picture updates cause high bandwidth usage, so this method will normally be used instead of UpdatePicture.
If the method is called when the stream is active, the timer will start immediately. If the stream is not active, the timer will be started when the stream enters the active state.
Syntax
HRESULT PeriodicUpdatePicture(
[in] BOOL fEnable,
[in] DWORD dwInterval
);
Parameters
-
fEnable [in]
-
TRUE enables the timer. FALSE disables it.
-
dwInterval [in]
-
The interval for the timer, in seconds.
Return value
This method can return one of these values.
| Return code | Description |
|---|---|
|
Method succeeded. |
|
Failed for unexpected reasons. |
Requirements
| Requirement | Value |
|---|---|
| TAPI version |
Requires TAPI 3.0 or later |
| Header |
|
| Library |
|
| DLL |
|