PrlDevAudio_StartStream Function

Starts audio stream from client to Vm.

Syntax

PRL_RESULT PrlDevAudio_StartStream(
    PRL_HANDLE hVm, 
    PRL_AUDIO_STREAM_TYPE Type
);

File

PrlApiVm.h

Parameters

hVm

A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.

Type

Value from PRL_AUDIO_STREAM_TYPE enumeration selecting play or recording stream type

Returns

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.

PRL_ERR_AUDIO_ENCODINGS_NOT_SUPPORTED - audio encodings are not supported on the server.

Remarks

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 and event #PET_IO_AUDIO_STREAM_STARTED with operation status code should be handled.

Links

Audio Playback