![]() |
NVAPI Reference Documentation
|
Release 396: April 5
|
#define MAX_NUM_COMPOSITE_RANGE 2 |
Maximum number of ranges per channel.
#define NV_VIO_TOPOLOGY_VER MAKE_NVAPI_VERSION(NV_VIO_TOPOLOGY,1) |
Macro for constructing the version field of NV_VIO_TOPOLOGY.
#define NVVIO_O_READ 0x00000000 |
Read access (not applicable for video output)
#define NVVIO_O_WRITE_EXCLUSIVE 0x00010001 |
Write exclusive access (not applicable for video input)
#define NVVIO_OWNERID_EXCLUSIVE 0x40000000 |
VIO_DATA.ulOwnerID next-bit is set only if device is currently in exclusive write access mode from NvAPI_VIO_Open()
#define NVVIO_OWNERID_INITIALIZED 0x80000000 |
VIO_DATA.ulOwnerID high-bit is set only if device has been initialized by VIOAPI examined at NvAPI_GetCapabilities|NvAPI_VIO_Open to determine if settings need to be applied from registry or POR state read
#define NVVIO_OWNERID_TYPEMASK 0x0FFFFFFF |
mask for NVVIOOWNERTYPE_xxx
VIO_DATA.ulOwnerID lower bits are: NVGVOOWNERTYPE_xxx enumerations indicating use context
#define NVVIO_VALID_ACCESSRIGHTS |
Unregistered ownerId.
#define NVVIOBUFFERFORMAT_R16FPG16FPB16FP 0x00000010 |
R16FP:G16FP:B16FP.
#define NVVIOBUFFERFORMAT_R16FPG16FPB16FPA16FP 0x00000040 |
R16FP:G16FP:B16FP:A16FP.
#define NVVIOBUFFERFORMAT_R16FPG16FPB16FPA16FPZ24 0x00000080 |
R16FP:G16FP:B16FP:A16FP:Z24.
#define NVVIOBUFFERFORMAT_R16FPG16FPB16FPZ24 0x00000020 |
R16FP:G16FP:B16FP:Z24.
#define NVVIOBUFFERFORMAT_R8G8B8 0x00000001 |
R8:G8:B8.
#define NVVIOBUFFERFORMAT_R8G8B8A8 0x00000004 |
R8:G8:B8:A8.
#define NVVIOBUFFERFORMAT_R8G8B8A8Z24 0x00000008 |
R8:G8:B8:A8:Z24.
#define NVVIOBUFFERFORMAT_R8G8B8Z24 0x00000002 |
R8:G8:B8:Z24.
#define NVVIOCAPS_AUDIO_BLANKING_SUPPORTED 0x00400000 |
Supports ANC audio blanking.
#define NVVIOCAPS_OUTPUTMODE_DESKTOP 0x00010000 |
Supports Desktop transparent mode.
#define NVVIOCAPS_OUTPUTMODE_OPENGL 0x00020000 |
Supports OpenGL application mode.
#define NVVIOCAPS_PACKED_ANC_SUPPORTED 0x00200000 |
Supports Packed ANC.
#define NVVIOCAPS_SYNC_GENLOCK 0x00000200 |
Supports Genlock timing source.
#define NVVIOCAPS_SYNC_INTERNAL 0x00000100 |
Supports Internal timing source.
#define NVVIOCAPS_SYNCSRC_COMP 0x00002000 |
Supports Composite synchronization input.
#define NVVIOCAPS_SYNCSRC_SDI 0x00001000 |
Supports Serial Digital Interface (SDI) synchronization input.
#define NVVIOCAPS_VER NVVIOCAPS_VER2 |
Supports Serial Digital Interface (SDI) output.
#define NVVIOCAPS_VER1 MAKE_NVAPI_VERSION(NVVIOCAPS,1) |
Macro for constructing the version field of NVVIOCAPS.
#define NVVIOCAPS_VER2 MAKE_NVAPI_VERSION(NVVIOCAPS,2) |
Supports Serial Digital Interface (SDI) output.
#define NVVIOCAPS_VIDIN_SDI 0x00100000 |
Supports Serial Digital Interface (SDI) input.
#define NVVIOCAPS_VIDOUT_SDI 0x00000001 |
Supports Serial Digital Interface (SDI) output.
#define NVVIOCLASS_SDI 0x00000001 |
SDI-class interface: SDI output with two genlock inputs.
#define NVVIOCOLORCONVERSION_VER MAKE_NVAPI_VERSION(NVVIOCOLORCONVERSION,1) |
macro for constructing the version field of _NVVIOCOLORCONVERSION.
#define NVVIOCONFIG_422FILTER 0x00000400 |
fields: bEnable422Filter
#define NVVIOCONFIG_ALLFIELDS |
Supports Serial Digital Interface (SDI) output.
#define NVVIOCONFIG_ALLOWSDIRUNNING_FIELDS |
Supports Serial Digital Interface (SDI) output.
#define NVVIOCONFIG_ALPHAKEYCOMPOSITE 0x00020000 |
fields: bEnableAlphaKeyComposite
#define NVVIOCONFIG_ANC_AUDIO_REPEAT 0x04000000 |
fields: enableAudioBlanking
#define NVVIOCONFIG_ANC_PARITY_COMPUTATION 0x02000000 |
fields: ancParityComputation
#define NVVIOCONFIG_ANCTIMECODEGENERATION 0x00008000 |
fields: bEnableANCTimeCodeGeneration
#define NVVIOCONFIG_COLORCONVERSION 0x00000010 |
fields: colorConversion
#define NVVIOCONFIG_COMPOSITE 0x00010000 |
fields: bEnableComposite
#define NVVIOCONFIG_COMPOSITE_CB 0x00100000 |
fields: compRange
#define NVVIOCONFIG_COMPOSITE_CR 0x00080000 |
fields: compRange
#define NVVIOCONFIG_COMPOSITE_Y 0x00040000 |
fields: compRange
#define NVVIOCONFIG_COMPOSITESYNCTYPE 0x00000100 |
fields: compositeSyncType
#define NVVIOCONFIG_COMPOSITETERMINATE 0x00000800 |
fields: bCompositeTerminate (Not supported on Quadro FX 4000 SDI)
#define NVVIOCONFIG_CSCOVERRIDE 0x00002000 |
fields: colorConversion override
#define NVVIOCONFIG_DATAFORMAT 0x00000002 |
fields: dataFormat
#define NVVIOCONFIG_DATAINTEGRITYCHECK 0x00001000 |
fields: bEnableDataIntegrityCheck (Not supported on Quadro FX 4000 SDI)
#define NVVIOCONFIG_DRIVERFIELDS |
Supports Serial Digital Interface (SDI) output.
#define NVVIOCONFIG_FLIPQUEUELENGTH 0x00004000 |
fields: flipqueuelength control
#define NVVIOCONFIG_FRAMELOCKENABLE 0x00000200 |
fields: EnableFramelock
#define NVVIOCONFIG_FULL_COLOR_RANGE 0x00200000 |
fields: bEnableFullColorRange
#define NVVIOCONFIG_GAMMACORRECTION 0x00000020 |
fields: gammaCorrection
#define NVVIOCONFIG_GAMMAFIELDS ( NVVIOCONFIG_GAMMACORRECTION ) |
Supports Serial Digital Interface (SDI) output.
#define NVVIOCONFIG_OUTPUTAREA 0x00000008 |
fields: outputArea
#define NVVIOCONFIG_OUTPUTREGION 0x00000004 |
fields: outputRegion
#define NVVIOCONFIG_RESERVED_SDIOUTPUTENABLE 0x00800000 |
fields: bEnableSDIOutput
#define NVVIOCONFIG_RGB_DATA 0x00400000 |
fields: bEnableRGBData
#define NVVIOCONFIG_RMCTRLFIELDS |
Supports Serial Digital Interface (SDI) output.
#define NVVIOCONFIG_RMMODESET_FIELDS |
Supports Serial Digital Interface (SDI) output.
#define NVVIOCONFIG_RMSKEWFIELDS ( NVVIOCONFIG_SYNCDELAY ) |
Supports Serial Digital Interface (SDI) output.
#define NVVIOCONFIG_SIGNALFORMAT 0x00000001 |
fields: signalFormat
#define NVVIOCONFIG_STREAMS 0x01000000 |
fields: streams
#define NVVIOCONFIG_SYNCDELAY 0x00000080 |
fields: syncDelay
#define NVVIOCONFIG_SYNCSOURCEENABLE 0x00000040 |
fields: syncSource and syncEnable
#define NVVIOCONFIG_VALIDFIELDS |
Supports Serial Digital Interface (SDI) output.
#define NVVIOCONFIG_VER NVVIOCONFIG_VER3 |
Supports Serial Digital Interface (SDI) output.
#define NVVIOCONFIG_VER1 MAKE_NVAPI_VERSION(NVVIOCONFIG_V1,1) |
Supports Serial Digital Interface (SDI) output.
#define NVVIOCONFIG_VER2 MAKE_NVAPI_VERSION(NVVIOCONFIG_V2,2) |
Supports Serial Digital Interface (SDI) output.
#define NVVIOCONFIG_VER3 MAKE_NVAPI_VERSION(NVVIOCONFIG_V3,3) |
Supports Serial Digital Interface (SDI) output.
#define NVVIOGAMMACORRECTION_VER MAKE_NVAPI_VERSION(NVVIOGAMMACORRECTION,1) |
Macro for constructing thevesion field of _NVVIOGAMMACORRECTION.
#define NVVIOOWNERID_NONE 0 |
Unregistered ownerId.
#define NVVIOSTATUS_VER MAKE_NVAPI_VERSION(NVVIOSTATUS,1) |
Macro for constructingthe version field of NVVIOSTATUS.
#define NVVIOSYNCDELAY_VER MAKE_NVAPI_VERSION(NVVIOSYNCDELAY,1) |
Macro for constructing the version field of NVVIOSYNCDELAY.
#define NVVIOTOPOLOGY_VER MAKE_NVAPI_VERSION(NVVIOTOPOLOGY,1) |
Macro for constructing the version field of NVVIOTOPOLOGY.
typedef struct _NV_VIO_TOPOLOGY NV_VIO_TOPOLOGY |
Supports Serial Digital Interface (SDI) output.
typedef struct _NVVIOCAPS NVVIOCAPS |
Device capabilities.
typedef struct _NVVIOCHANNELSTATUS NVVIOCHANNELSTATUS |
Input channel status.
typedef struct _NVVIOCOLORCONVERSION NVVIOCOLORCONVERSION |
Colorspace conversion.
typedef struct _NVVIOCOMPOSITERANGE NVVIOCOMPOSITERANGE |
Supports Serial Digital Interface (SDI) output.
typedef NVVIOCONFIG_V3 NVVIOCONFIG |
Supports Serial Digital Interface (SDI) output.
typedef struct _NVVIOCONFIG_V1 NVVIOCONFIG_V1 |
Supports Serial Digital Interface (SDI) output.
typedef struct _NVVIOCONFIG_V2 NVVIOCONFIG_V2 |
Supports Serial Digital Interface (SDI) output.
typedef struct _NVVIOCONFIG_V3 NVVIOCONFIG_V3 |
Supports Serial Digital Interface (SDI) output.
typedef struct _NVVIODATAFORMATDETAIL NVVIODATAFORMATDETAIL |
Data format details.
typedef struct _NVVIOGAMMACORRECTION NVVIOGAMMACORRECTION |
Gamma correction.
typedef struct _NVVIOGAMMARAMP10 NVVIOGAMMARAMP10 |
Gamma ramp (10-bit index)
typedef struct _NVVIOGAMMARAMP8 NVVIOGAMMARAMP8 |
Gamma ramp (8-bit index)
typedef struct _NVVIOINPUTCONFIG NVVIOINPUTCONFIG |
Input device configuration.
typedef struct _NVVIOINPUTSTATUS NVVIOINPUTSTATUS |
Input device status.
Supports Serial Digital Interface (SDI) output.
typedef struct _NVVIOOUTPUTCONFIG_V1 NVVIOOUTPUTCONFIG_V1 |
Output device configuration.
typedef struct _NVVIOOUTPUTCONFIG_V2 NVVIOOUTPUTCONFIG_V2 |
Supports Serial Digital Interface (SDI) output.
typedef struct _NVVIOOUTPUTCONFIG_V3 NVVIOOUTPUTCONFIG_V3 |
Supports Serial Digital Interface (SDI) output.
typedef struct _NVVIOOUTPUTREGION NVVIOOUTPUTREGION |
Output region.
typedef struct _NVVIOOUTPUTSTATUS NVVIOOUTPUTSTATUS |
Output device status.
typedef NvU32 NVVIOOWNERID |
Unique identifier for VIO owner (process identifier or NVVIOOWNERID_NONE)
typedef enum _NVVIOOWNERTYPE NVVIOOWNERTYPE |
Owner type for device.
typedef enum _NVVIOPCILINKRATE NVVIOPCILINKRATE |
typedef enum _NVVIOSIGNALFORMAT NVVIOSIGNALFORMAT |
Video signal format and resolution.
typedef struct _NVVIOSIGNALFORMATDETAIL NVVIOSIGNALFORMATDETAIL |
Signal format details.
typedef struct _NVVIOSTATUS NVVIOSTATUS |
Video device status.
typedef struct _NVVIOSTREAM NVVIOSTREAM |
Stream configuration.
typedef struct _NVVIOSYNCDELAY NVVIOSYNCDELAY |
Sync delay.
typedef struct _NV_VIO_TOPOLOGY NVVIOTOPOLOGY |
Supports Serial Digital Interface (SDI) output.
typedef struct _NVVIOVIDEOMODE NVVIOVIDEOMODE |
Video mode information.
enum _NVVIOOWNERTYPE |
enum _NVVIOPCILINKRATE |
enum _NVVIOSIGNALFORMAT |
Video signal format and resolution.
NVAPI_INTERFACE NvAPI_VIO_EnumDataFormats | ( | NvVioHandle | hVioHandle, |
NvU32 | enumIndex, | ||
NVVIODATAFORMATDETAIL * | pDataFormatDetail | ||
) |
Function: NvAPI_VIO_EnumDataFormats
Description: This API enumerates data formats supported by Video I/O.
SUPPORTED OS: Windows XP and higher
[in] | NvVioHandle | The caller provides the SDI device handle as input. |
[in] | enumIndex | Enumeration index |
[out] | pDataFormatDetail | Pointer to receive detail or NULL |
NVAPI_OK | Success |
NVAPI_END_ENUMERATION | No more data formats to enumerate |
NVAPI_NOT_SUPPORTED | Unsupported NVVIODATAFORMAT_ enumeration |
NVAPI_INTERFACE NvAPI_VIO_EnumDevices | ( | NvVioHandle | hVioHandle[NVAPI_MAX_VIO_DEVICES], |
NvU32 * | vioDeviceCount | ||
) |
Function: NvAPI_VIO_EnumDevices
Description: This API enumerate all VIO devices connected to the system.
SUPPORTED OS: Windows XP and higher
[out] | NvVioHandle | User passes the pointer of NvVioHandle[] array to get handles to all the connected video I/O devices. |
[out] | vioDeviceCount | User gets total number of VIO devices connected to the system. |
NVAPI_OK | Success |
NVAPI_API_NOT_INTIALIZED | NVAPI Not Initialized |
NVAPI_INVALID_ARGUMENT | Arguments passed to API are not valid |
NVAPI_ERROR | NVAPI Random errors |
NVAPI_NVIDIA_DEVICE_NOT_FOUND | No SDI Device found |
NVAPI_INTERFACE NvAPI_VIO_EnumSignalFormats | ( | NvVioHandle | hVioHandle, |
NvU32 | enumIndex, | ||
NVVIOSIGNALFORMATDETAIL * | pSignalFormatDetail | ||
) |
Function: NvAPI_VIO_EnumSignalFormats
Description: This API enumerates signal formats supported by Video I/O.
SUPPORTED OS: Windows XP and higher
[in] | NvVioHandle | The caller provides the SDI device handle as input. |
[in] | enumIndex | Enumeration index |
[out] | pSignalFormatDetail | Pointer to receive detail or NULL |
NVAPI_OK | Success |
NVAPI_API_NOT_INTIALIZED | NVAPI not initialized |
NVAPI_INVALID_ARGUMENT | Invalid argument passed |
NVAPI_END_ENUMERATION | No more signal formats to enumerate |
NVAPI_INTERFACE NvAPI_VIO_GetCapabilities | ( | NvVioHandle | hVioHandle, |
NVVIOCAPS * | pAdapterCaps | ||
) |
Function: NvAPI_VIO_GetCapabilities
Description: This API determine the graphics adapter video I/O capabilities.
SUPPORTED OS: Windows XP and higher
[in] | NvVioHandle | The caller provides the SDI device handle as input. |
[out] | pAdapterCaps | Pointer to receive capabilities |
NVAPI_OK | Success |
NVAPI_API_NOT_INTIALIZED | NVAPI Not Initialized |
NVAPI_INVALID_ARGUMENT | Arguments passed to API are not valid |
NVAPI_INCOMPATIBLE_STRUCT_VERSION | NVVIOCAPS struct version used by the app is not compatible |
NVAPI_NOT_SUPPORTED | Video I/O not supported |
NVAPI_ERROR | NVAPI Random errors |
NVAPI_INTERFACE NvAPI_VIO_GetPCIInfo | ( | __in NvVioHandle | hVioHandle, |
__inout NVVIOPCIINFO * | pVioPCIInfo | ||
) |
FUNCTION NAME: NvAPI_VIO_GetPCIInfo()
DESCRIPTION: This API gets PCI information of the attached SDI(input) capture card.
[in] | hVioHandle | Handle to SDI capture card. |
[out] | pVioPCIInfo | PCI information of the attached SDI capture card. |
SUPPORTED OS: Windows XP and higher
NVAPI_INTERFACE NvAPI_VIO_IsFrameLockModeCompatible | ( | NvVioHandle | hVioHandle, |
NvU32 | srcEnumIndex, | ||
NvU32 | destEnumIndex, | ||
NvU32 * | pbCompatible | ||
) |
Function: NvAPI_VIO_IsFrameLockModeCompatible
Description: This API checks whether modes are compatible in frame lock mode.
SUPPORTED OS: Windows XP and higher
[in] | NvVioHandle | The caller provides the SDI device handle as input. |
[in] | srcEnumIndex | Source Enumeration index |
[in] | destEnumIndex | Destination Enumeration index |
[out] | pbCompatible | Pointer to receive compatibility |
NVAPI_OK | Success |
NVAPI_API_NOT_INTIALIZED | NVAPI Not Initialized |
NVAPI_INVALID_ARGUMENT | Arguments passed to API are not valid |
NVAPI_NOT_SUPPORTED | Video I/O not supported |
NVAPI_ERROR | NVAPI Random errors |
NVAPI_INTERFACE NvAPI_VIO_IsRunning | ( | NvVioHandle | hVioHandle | ) |
Function: NvAPI_VIO_IsRunning
Description: This API determines if Video I/O is running.
SUPPORTED OS: Windows XP and higher
[in] | NvVioHandle[IN] | The caller provides the SDI device handle as input. |
NVAPI_DRIVER_RUNNING | Video I/O running |
NVAPI_DRIVER_NOTRUNNING | Video I/O not running |
NVAPI_INTERFACE NvAPI_VIO_QueryTopology | ( | NV_VIO_TOPOLOGY * | pNvVIOTopology | ) |
Function: NvAPI_VIO_QueryTopology
Description: This API queries the valid SDI topologies.
SUPPORTED OS: Windows XP and higher
[out] | pNvVIOTopology | User passes the pointer to NVVIOTOPOLOGY to fetch all valid SDI topologies. |
NVAPI_OK | Success |
NVAPI_API_NOT_INTIALIZED | NVAPI Not Initialized |
NVAPI_INVALID_ARGUMENT | Arguments passed to API are not valid |
NVAPI_INCOMPATIBLE_STRUCT_VERSION | Invalid structure version |
NVAPI_ERROR | NVAPI Random errors |
NVAPI_INTERFACE NvAPI_VIO_Start | ( | NvVioHandle | hVioHandle | ) |
Function: NvAPI_VIO_Start
Description: This API starts Video I/O. This API should be called for NVVIOOWNERTYPE_DESKTOP only and will not work for OGL applications.
SUPPORTED OS: Windows XP and higher
[in] | NvVioHandle[IN] | The caller provides the SDI device handle as input. |
NVAPI_OK | Success |
NVAPI_API_NOT_INTIALIZED | NVAPI Not Initialized |
NVAPI_INVALID_ARGUMENT | Arguments passed to API are not valid |
NVAPI_NOT_SUPPORTED | Video I/O not supported |
NVAPI_ERROR | NVAPI Random errors |
NVAPI_DEVICE_BUSY | Access denied for requested access |
NVAPI_INTERFACE NvAPI_VIO_Stop | ( | NvVioHandle | hVioHandle | ) |
Function: NvAPI_VIO_Stop
Description: This API stops Video I/O. This API should be called for NVVIOOWNERTYPE_DESKTOP only and will not work for OGL applications.
SUPPORTED OS: Windows XP and higher
[in] | NvVioHandle[IN] | The caller provides the SDI device handle as input. |
NVAPI_OK | Success |
NVAPI_API_NOT_INTIALIZED | NVAPI Not Initialized |
NVAPI_INVALID_ARGUMENT | Arguments passed to API are not valid |
NVAPI_NOT_SUPPORTED | Video I/O not supported |
NVAPI_ERROR | NVAPI Random errors |
NVAPI_DEVICE_BUSY | Access denied for requested access |