PrlDevAudio_GetOutputEncoding Function

Gets current audio output encoding of specified Vm.

Syntax

PRL_RESULT PrlDevAudio_GetOutputEncoding(
    PRL_HANDLE hVm, 
    PRL_UINT32_PTR pInOutSz, 
    PRL_IO_AUDIO_ENCODING_PTR pOutEnc
);

PrlApiDeprecated.h

hVm

A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.

pInOutSz

In context - size of allocated memory for audio encoding; Out context - real size of audio encoding structure

pOutEnc

Encoding description as out parameter.

PRL_RESULT. Possible values:

PRL_ERR_SUCCESS - out parameter has been filled with current audio output encoding.

PRL_ERR_AUDIO_ENCODINGS_NOT_SUPPORTED - audio encodings are not supported on server, connection is local or remote connection does not exist anymore.

PRL_ERR_INVALID_ARG - pInOutSz pointer is wrong, hVm does not exist or pInOutSz value is too small.

Pass pOutEnc as NULL to receive audio output encoding structure size in pInOutSz param.