DXVA_COPPStatusData structure (dxva.h)

Article
04/01/2021

The DXVA_COPPStatusData structure contains the status information returned from a query on a protected video session that is associated with a DirectX VA COPP device.

Syntax

typedef struct _DXVA_COPPStatusData {
  GUID  rApp;
  ULONG dwFlags;
  ULONG dwData;
  ULONG ExtendedInfoValidMask;
  ULONG ExtendedInfoData;
} DXVA_COPPStatusData;

Members

rApp

Specifies a 128-bit random number that is used once. This random number is generated by the requesting application and supplied to the display driver in the rApp member of the DXVA_COPPStatusInput structure.

dwFlags

Specifies additional status information that might be relevant to the calling application. The display driver should set dwFlags to the COPP_StatusNormal (0x00) value from the COPP_StatusFlags enumeration type or to a valid ORed combination of the following COPP_StatusFlags:

COPP_LinkLost (0x01)
COPP_RenegotiationRequired (0x02)

dwData

Specifies 32-bit status data that is returned from one of the following requests passed in the pInput parameter of the COPPQueryStatus function.

DXVA_COPPQueryProtectionType

Returns a valid ORed combination of the following values that indicate the available types of protection mechanisms on the physical connector associated with a COPP device:

COPP_ProtectionType_Unknown (0x80000000)
COPP_ProtectionType_None (0x00)
COPP_ProtectionType_HDCP (0x01)
COPP_ProtectionType_ACP (0x02)
COPP_ProtectionType_CGMSA (0x04)

DXVA_COPPQueryConnectorType

Returns one of the following values from the COPP_ConnectorType enumeration type that identifies the type of physical connector the video session uses:

COPP_ConnectorType_Unknown (-1)
COPP_ConnectorType_VGA (0)
COPP_ConnectorType_SVideo (1)
COPP_ConnectorType_CompositeVideo (2)
COPP_ConnectorType_ComponentVideo (3)
COPP_ConnectorType_DVI (4)
COPP_ConnectorType_HDMI (5)
COPP_ConnectorType_LVDS (6)
COPP_ConnectorType_TMDS (7)
COPP_ConnectorType_D_JPN (8)

The COPP_ConnectorType_Internal (0x80000000) value is only combined with one of the preceding connector-type values to indicate that the connection between the graphics adapter and display monitor is permanent and not accessible from the outside of a non-user-serviceable enclosure.

DXVA_COPPQueryLocalProtectionLevel

Returns the currently set protection level for the video session. The protection-level value depends on the protection type specified in the StatusData member of the DXVA_COPPStatusInput structure. For possible protection levels, see the ProtLevel member of the DXVA_COPPSetProtectionLevelCmdData structure.

DXVA_COPPQueryGlobalProtectionLevel

Returns the currently set protection level for the physical connector. The level value returned must reflect the protection level currently applied through the connector, regardless of how the driver was instructed to apply the protection level. For example, if ACP was enabled through the Win32 ChangeDisplaySettingsEx function and not through the IAMCertifiedOutputProtection interface, the global protection level that was returned through a call to the COPPQueryStatus function for the connector must indicate that ACP was enabled, even though ACP was not enabled through the IAMCertifiedOutputProtection interface.

The protection-level value depends on the protection type specified in the StatusData member of the DXVA_COPPStatusInput structure. For possible protection levels, see the ProtLevel member of the DXVA_COPPSetProtectionLevelCmdData structure.

DXVA_COPPQueryBusData

Returns one of the following values from the COPP_BusType enumeration type that identifies the type of bus used by the graphics hardware associated with a COPP device:

COPP_BusType_Unknown (0)
COPP_BusType_PCI (1)
COPP_BusType_PCIX (2)
COPP_BusType_PCIExpress (3)
COPP_BusType_AGP (4)

The COPP_BusType_Integrated (0x80000000) value can only be combined with one of the preceding bus-type values when none of the command and status interface signals between the graphics adapter and other subsystems are available on an expansion bus that uses a publicly available specification and standard connector type. Memory buses are excluded from this definition.

ExtendedInfoValidMask

Specifies a value that indicates the valid bitfields in the following ExtendedInfoData member.

ExtendedInfoData

Specifies additional 32-bit data for the status. Not currently used.

Remarks

The display driver returns status information through the pOutput parameter of COPPQueryStatus. The DXVA_COPPStatusOutput structure describes the returned status information. The display driver should cast the status information to a pointer to a DXVA_COPPStatusData structure and return the status information in the COPPStatus member of DXVA_COPPStatusOutput.

Requirements

Requirement	Value
Minimum supported client	This structure applies only to Windows Server 2003 with SP1 and later, and Windows XP with SP2 and later.
Header	dxva.h (include Dxva.h)