cuda.bindings.nvml.vgpu_instance_get_encoder_sessions#

cuda.bindings.nvml.vgpu_instance_get_encoder_sessions(unsigned int vgpu_instance)#

Retrieves information about all active encoder sessions on a vGPU Instance.

An array of active encoder sessions is returned in the caller-supplied buffer pointed at by session_info. The array element count is passed in session_count, and session_count is used to return the number of sessions written to the buffer. If the supplied buffer is not large enough to accommodate the active session array, the function returns NVML_ERROR_INSUFFICIENT_SIZE, with the element count of nvmlEncoderSessionInfo_t array required in session_count. To query the number of active encoder sessions, call this function with *session_count = 0. The code will return NVML_SUCCESS with number of active encoder sessions updated in *session_count. For Maxwell ™️ or newer fully supported devices.

Parameters:

vgpu_instance (unsigned int) – Identifier of the target vGPU instance.

Returns:

Reference to caller supplied array in: which the list of session information us returned.

Return type:

nvmlEncoderSessionInfo_t