PrlDevAudio_StartOutputStream Function

Starts audio output stream from Vm to client.

Syntax

PRL_RESULT PrlDevAudio_StartOutputStream(
    PRL_HANDLE hVm, 
    const PRL_IO_AUDIO_ENCODING_PTR pEnc, 
    PRL_AUDIO_OUTPUT_DATA_HANDLER cb, 
    PRL_VOID_PTR cbCtx
);

File

PrlApi.h

Parameters

hVm

A handle of type PHT_VIRTUAL_MACHINE identifying the virtual machine.

pEnc

Audio encoding structure which should be filled correctly.

Audio data callback, which should handle audio data as quick as possible

cbCtx

Audio data callback context which will be passed to callback

Returns

PRL_RESULT . Possible values:

PRL_ERR_SUCCESS - audio output stream start request has been sent.

PRL_ERR_FAILURE - send of output 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

PrlApi.h , Audio Playback