PrlDevAudio_SetSwitcherState Function

Set state of the audio switcher.

Syntax

PRL_RESULT PrlDevAudio_SetSwitcherState(
    PRL_HANDLE hVm, 
    PRL_BOOL bEnabled
);

PrlApiVm.h

hVm

A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.

bEnabled

new state of switcher as boolean. PRL_TRUE means enabled.

PRL_RESULT. Possible values:

PRL_ERR_SUCCESS - audio input stream start request has been sent.

PRL_ERR_FAILURE - send of input start request to Vm has been failed.

PRL_ERR_INVALID_ARG - Vm handle is incorrect or some pointer is invalid.

PRL_ERR_UNINITIALIZED - there is no any valid connection to Vm. #PrlDevDisplay_ConnectToVm wasn't called.

If client is not connected to vm with #PrlDevDisplay_ConnectToVm call error will be returned, otherwise start request will be sent, PRL_ERR_SUCCESS returned.