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:ks.KsPinGetAvailableByteCount

KsPinGetAvailableByteCount function (ks.h)

The KsPinGetAvailableByteCount routine outputs the number of bytes of input data ahead of the leading edge and the number of bytes of output buffer ahead of the leading edge, both for the queue of a caller-specified pin.

stream\kspingetavailablebytecount.htm

stream

04/23/2018

KsPinGetAvailableByteCount function

KsPinGetAvailableByteCount, KsPinGetAvailableByteCount routine [Streaming Media Devices], avfunc_2ba6a7f8-59b4-45bf-989a-97f8a494b4bc.xml, ks/KsPinGetAvailableByteCount, stream.kspingetavailablebytecount

ks.h

Ks.h

Universal

Available in Microsoft Windows XP and later operating systems and DirectX 8.0 and later DirectX versions.

Ks.lib

Windows

KsPinGetAvailableByteCount

ks/KsPinGetAvailableByteCount

APIRef

kbSyntax

LibDef

Ks.lib

Ks.dll

KsPinGetAvailableByteCount

KsPinGetAvailableByteCount function

-description

The KsPinGetAvailableByteCount routine outputs the number of bytes of input data ahead of the leading edge and the number of bytes of output buffer ahead of the leading edge, both for the queue of a caller-specified pin.

-parameters

-param Pin [in]

A pointer to a KSPIN structure for which to calculate these queue parameters.

-param InputDataBytes [out, optional]

A pointer to a LONG value in which the routine returns the number of input data bytes ahead of the leading edge. Caller sets to NULL if this value is not requested.

-param OutputBufferBytes [out, optional]

A pointer to a LONG value in which the routine returns the number of output buffer bytes ahead of the leading edge. Caller sets to NULL if this value is not requested.

-returns

Returns STATUS_SUCCESS if the requested count(s) have been retrieved. An unsuccessful return status indicates that Pin does not have an associated queue.

-remarks

Noninplace pins should use InputDataBytes for input pins and OutputBufferBytes for output pins.

The results of this call are not guaranteed to be safe unless either the processing mutex is held at call-time, or the caller has privately synchronized before calling the routine. To private synchronize, ensure that the pin does not transition from Acquire to Stop while the routine is executing. See Processing Mutex in AVStream.