Skip to content

Latest commit

 

History

History
87 lines (59 loc) · 3.73 KB

nf-portcls-iminiportwavecyclicstream-setnotificationfreq.md

File metadata and controls

87 lines (59 loc) · 3.73 KB
UID title description old-location tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NF:portcls.IMiniportWaveCyclicStream.SetNotificationFreq
IMiniportWaveCyclicStream::SetNotificationFreq (portcls.h)
The SetNotificationFreq method controls the frequency at which notification interrupts are generated by setting the interval between successive interrupts.
audio\iminiportwavecyclicstream_setnotificationfreq.htm
audio
05/08/2018
IMiniportWaveCyclicStream::SetNotificationFreq
IMiniportWaveCyclicStream interface [Audio Devices],SetNotificationFreq method, IMiniportWaveCyclicStream.SetNotificationFreq, IMiniportWaveCyclicStream::SetNotificationFreq, SetNotificationFreq, SetNotificationFreq method [Audio Devices], SetNotificationFreq method [Audio Devices],IMiniportWaveCyclicStream interface, audio.iminiportwavecyclicstream_setnotificationfreq, audmp-routines_9db148da-326d-4176-a852-83fa1e453246.xml, portcls/IMiniportWaveCyclicStream::SetNotificationFreq
portcls.h
Portcls.h
Universal
PASSIVE_LEVEL
Windows
IMiniportWaveCyclicStream::SetNotificationFreq
portcls/IMiniportWaveCyclicStream::SetNotificationFreq
APIRef
kbSyntax
COM
portcls.h
IMiniportWaveCyclicStream::SetNotificationFreq

IMiniportWaveCyclicStream::SetNotificationFreq

-description

The SetNotificationFreq method controls the frequency at which notification interrupts are generated by setting the interval between successive interrupts.

-parameters

-param Interval [in]

Specifies the interval between notification interrupts. This parameter value is expressed in milliseconds.

-param FrameSize [out]

Output pointer for the frame size. This parameter points to a caller-allocated variable into which the method writes the maximum number of bytes that can be transferred in Interval milliseconds. This byte count determines the size of the buffer that needs to be allocated for the input or output stream.

-returns

SetNotificationFreq returns the new notification interval expressed in milliseconds. In all current Windows releases, the port driver ignores this value.

-remarks

During each notification interrupt, the miniport driver's interrupt service routine calls the IPortWaveCyclic::Notify method with the stream's IServiceGroup object as the call parameter. This is the IServiceGroup object that the miniport driver previously output to the port driver during the IMiniportWaveCyclic::NewStream call.

In all current Windows releases, the WaveCyclic port driver specifies an Interval value of 10 milliseconds. This value might change in future releases.

-see-also

IMiniportWaveCyclic::NewStream

IMiniportWaveCyclicStream

IPortWaveCyclic::Notify

IServiceGroup