Skip to content

Latest commit

 

History

History
76 lines (62 loc) · 3.12 KB

ns-ks-kspriority.md

File metadata and controls

76 lines (62 loc) · 3.12 KB
UID title description 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
NS:ks.KSPRIORITY
KSPRIORITY (ks.h)
The KSPRIORITY structure is used to specify priority and is used with the KSPROPERTY_CONNECTION_PRIORITY property.
stream
03/06/2023
KSPRIORITY structure
*PKSPRIORITY, KSPRIORITY, KSPRIORITY structure [Streaming Media Devices], PKSPRIORITY, PKSPRIORITY structure pointer [Streaming Media Devices], ks-struct_08294311-6f72-4888-bfb8-b4598e1fc9bd.xml, ks/KSPRIORITY, ks/PKSPRIORITY, stream.kspriority
ks.h
Ks.h
Windows
Windows
KSPRIORITY, *PKSPRIORITY
PKSPRIORITY
ks/PKSPRIORITY
KSPRIORITY
ks/KSPRIORITY
APIRef
kbSyntax
HeaderDef
ks.h
PKSPRIORITY
KSPRIORITY

-description

The KSPRIORITY structure is used to specify priority and is used with the KSPROPERTY_CONNECTION_PRIORITY property.

-struct-fields

-field PriorityClass

Specifies a number ranging from 1 to 0xFFFFFFFF, where 1 is least priority and 0xFFFFFFFF is the highest priority. Zero is reserved for future use. When setting a class value, 0xFFFFFFFF is used to indicate exclusive access to the resources consumed by the pin. Possible values are listed in the following table.

PriorityClass Description
KSPRIORITY_LOW Specifies the lowest priority.
KSPRIORITY_NORMAL Specifies normal priority.
KSPRIORITY_HIGH Specifies an elevated priority.
KSPRIORITY_EXCLUSIVE Specifies the highest priority, which implies exclusive access to resources.

-field PrioritySubClass

Specifies a number ranging from 1 to 0xFFFFFFFF, where 1 is the least priority within the class and 0xFFFFFFFF is the most priority. Zero is reserved for future use.

-remarks

The KSPRIORITY.PrioritySubClass member allows a client to set exclusive use of resources consumed by a pin and also to prioritize the use of those resources by the client's pins within that exclusive class. The initial priority of a pin is set by the connection request typically performed through KsCreatePin, and is usually KSPRIORITY_NORMAL, with a subclass priority of 1. A pin uses these priorities as parameters when allocating shared resources from any component managing resources. Resource allocation occurs when formats are set on pins.

If the removal of resources by a higher priority client causes the filter pin to fail, the client must be notified through the KSEVENT_CONNECTION_PRIORITY event (assuming that the client had registered for event notification of this type).

-see-also

KSPROPERTY_CONNECTION_PRIORITY

KsCreatePin