NVIDIA DRIVE OS Linux SDK API Reference

6.0.3 Release

Detailed Description

Provides version information for the NvMedia library.

Data Structures

struct  NvMediaVersion
 Holds NvMedia version information. More...
 

Enumerations

enum  NvMediaNvSciSyncClientType {
  NVMEDIA_SIGNALER,
  NVMEDIA_WAITER,
  NVMEDIA_SIGNALER_WAITER,
  NVMEDIA_SIGNALER,
  NVMEDIA_WAITER,
  NVMEDIA_SIGNALER_WAITER
}
 NvMedia NvSciSync Client Type. More...
 
enum  NvMediaNvSciSyncObjType {
  NVMEDIA_PRESYNCOBJ,
  NVMEDIA_EOFSYNCOBJ,
  NVMEDIA_SOFSYNCOBJ,
  NVMEDIA_EOF_PRESYNCOBJ,
  NVMEDIA_SOF_PRESYNCOBJ,
  NVMEDIA_PRESYNCOBJ,
  NVMEDIA_EOFSYNCOBJ,
  NVMEDIA_SOFSYNCOBJ,
  NVMEDIA_EOF_PRESYNCOBJ,
  NVMEDIA_SOF_PRESYNCOBJ
}
 Defines NvMedia NvSciSyncObj types. More...
 
enum  NvMediaAccessMode {
  NVMEDIA_ACCESS_MODE_READ,
  NVMEDIA_ACCESS_MODE_READ_WRITE,
  NVMEDIA_ACCESS_MODE_READ,
  NVMEDIA_ACCESS_MODE_READ_WRITE
}
 

Functions

NvMediaStatus NvMediaReleaseGetVersion (NvMediaVersion *version)
 Gets the release version information for the NvMedia library. More...
 
NvMediaStatus NvMediaCoreGetVersion (NvMediaVersion *version)
 Gets the core version information for the NvMedia library. More...
 

Enumeration Type Documentation

◆ NvMediaAccessMode

Enumerator
NVMEDIA_ACCESS_MODE_READ 

Specifies read-only access mode.

NVMEDIA_ACCESS_MODE_READ_WRITE 

Specifies read/write access mode.

NVMEDIA_ACCESS_MODE_READ 

Specifies read-only access mode.

NVMEDIA_ACCESS_MODE_READ_WRITE 

Specifies read/write access mode.

Definition at line 301 of file tvmr/include/nvmedia_core.h.

◆ NvMediaNvSciSyncClientType

NvMedia NvSciSync Client Type.

Enumerator
NVMEDIA_SIGNALER 

An NvMedia component acts as a signaler.

NVMEDIA_WAITER 

An NvMedia component acts as a waiter.

NVMEDIA_SIGNALER_WAITER 

An NvMedia component acts as a signaler and waiter also for the same NvSciSyncObj.

NVMEDIA_SIGNALER 

An NvMedia component acts as a signaler.

NVMEDIA_WAITER 

An NvMedia component acts as a waiter.

NVMEDIA_SIGNALER_WAITER 

An NvMedia component acts as a signaler and waiter also for the same NvSciSyncObj.

Definition at line 260 of file tvmr/include/nvmedia_core.h.

◆ NvMediaNvSciSyncObjType

Defines NvMedia NvSciSyncObj types.

Enumerator
NVMEDIA_PRESYNCOBJ 

Specifies an NvSciSyncObj type for which an NvMedia component acts as a waiter.

NVMEDIA_EOFSYNCOBJ 

Specifies an NvSciSyncObj type for which an NvMedia component acts as a signaler, signaling EOFFence.

NVMEDIA_SOFSYNCOBJ 

Specifies an NvSciSyncObj type for which an NvMedia component acts as a signaler, signaling SOFFence.

NVMEDIA_EOF_PRESYNCOBJ 

Specifies an NvSciSyncObj type for which an NvMedia component acts both as a signaler, signaling EOFFence, and as a waiter.

Use this type in use cases where a EOFfence from an NvMedia component handle in one iteration is used as a PREfence for the same handle in the next iteration.

NVMEDIA_SOF_PRESYNCOBJ 

Specifies an NvSciSyncObj type for which an NvMedia component acts as a signaler, signaling SOFFence, as a waiter.

Use this type in use cases where a SOFfence from an NvMedia component handle in one iteration is used as a PREfence for the same handle in the next iteration.

NVMEDIA_PRESYNCOBJ 

Specifies an NvSciSyncObj type for which an NvMedia component acts as a waiter.

NVMEDIA_EOFSYNCOBJ 

Specifies an NvSciSyncObj type for which an NvMedia component acts as a signaler, signaling EOFFence.

NVMEDIA_SOFSYNCOBJ 

Specifies an NvSciSyncObj type for which an NvMedia component acts as a signaler, signaling SOFFence.

NVMEDIA_EOF_PRESYNCOBJ 

Specifies an NvSciSyncObj type for which an NvMedia component acts both as a signaler, signaling EOFFence, and as a waiter.

Use this type in use cases where a EOFfence from an NvMedia component handle in one iteration is used as a PREfence for the same handle in the next iteration.

NVMEDIA_SOF_PRESYNCOBJ 

Specifies an NvSciSyncObj type for which an NvMedia component acts as a signaler, signaling SOFFence, as a waiter.

Use this type in use cases where a SOFfence from an NvMedia component handle in one iteration is used as a PREfence for the same handle in the next iteration.

Definition at line 273 of file tvmr/include/nvmedia_core.h.

Function Documentation

◆ NvMediaCoreGetVersion()

NvMediaStatus NvMediaCoreGetVersion ( NvMediaVersion version)

Gets the core version information for the NvMedia library.

Parameters
[in,out]versionA valid non-NULL pointer to a NvMediaVersion structure to be filled by the function.
Return values
NVMEDIA_STATUS_OKif the operation was successful
NVMEDIA_STATUS_BAD_PARAMETERif version was invalid.


Usage considerations

  • Allowed context for the API call
    • Thread-safe: Yes
  • API group
    • Init: Yes
    • Runtime: No
    • De-Init: No

◆ NvMediaReleaseGetVersion()

NvMediaStatus NvMediaReleaseGetVersion ( NvMediaVersion version)

Gets the release version information for the NvMedia library.

Parameters
[in,out]versionA valid non-NULL pointer to a NvMediaVersion structure to be filled by the function.
Return values
NVMEDIA_STATUS_OKif the operation was successful
NVMEDIA_STATUS_BAD_PARAMETERif version was invalid.


Usage considerations

  • Allowed context for the API call
    • Thread-safe: Yes
  • API group
    • Init: Yes
    • Runtime: No
    • De-Init: No