Collaboration diagram for rdpsnd_server_context:

Data Fields
HANDLE	vcm

psRdpsndStart	Start

psRdpsndStop	Stop

RdpsndServerPrivate *	priv

void *	data

BOOL	use_dynamic_virtual_channel

AUDIO_FORMAT *	server_formats

size_t	num_server_formats

AUDIO_FORMAT *	src_format

UINT32	latency

AUDIO_FORMAT *	client_formats

UINT16	num_client_formats

UINT16	selected_client_format

UINT8	block_no

psRdpsndServerInitialize	Initialize

psRdpsndServerSelectFormat	SelectFormat

psRdpsndServerSendSamples	SendSamples

psRdpsndServerConfirmBlock	ConfirmBlock

psRdpsndServerSetVolume	SetVolume

psRdpsndServerClose	Close

psRdpsndServerActivated	Activated

UINT16	clientVersion

rdpContext *	rdpcontext

UINT32	capsFlags

UINT32	initialVolume

UINT32	initialPitch

UINT16	qualityMode

psRdpsndServerSendFormats	SendFormats

psRdpsndServerTraining	Training

psRdpsndServerSendSamples2	SendSamples2

psRdpsndServerTrainingConfirm	TrainingConfirm

psRdpsndChannelIdAssigned	ChannelIdAssigned

Detailed Description

FreeRDP: A Remote Desktop Protocol Implementation Server Audio Virtual Channel

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Definition at line 63 of file server/rdpsnd.h.

Field Documentation

◆ Activated

psRdpsndServerActivated rdpsnd_server_context::Activated

The channel has been activated. The server maybe choose audio format and start audio stream from this point. Note that this callback is called from a different thread context so the server must be careful of thread synchronization.

Definition at line 135 of file server/rdpsnd.h.

◆ block_no

UINT8 rdpsnd_server_context::block_no

Definition at line 94 of file server/rdpsnd.h.

◆ capsFlags

UINT32 rdpsnd_server_context::capsFlags

Definition at line 145 of file server/rdpsnd.h.

◆ ChannelIdAssigned

psRdpsndChannelIdAssigned rdpsnd_server_context::ChannelIdAssigned

Callback, when the channel got its id assigned. Only called, when use_dynamic_virtual_channel=TRUE.

Definition at line 179 of file server/rdpsnd.h.

◆ client_formats

AUDIO_FORMAT* rdpsnd_server_context::client_formats

Definition at line 89 of file server/rdpsnd.h.

◆ clientVersion

UINT16 rdpsnd_server_context::clientVersion

MS-RDPEA channel version the client announces

Definition at line 140 of file server/rdpsnd.h.

◆ Close

psRdpsndServerClose rdpsnd_server_context::Close

Close the audio stream.

Definition at line 126 of file server/rdpsnd.h.

◆ ConfirmBlock

psRdpsndServerConfirmBlock rdpsnd_server_context::ConfirmBlock

Called when block confirm is received from the client

Definition at line 118 of file server/rdpsnd.h.

◆ data

void* rdpsnd_server_context::data

Definition at line 73 of file server/rdpsnd.h.

◆ Initialize

psRdpsndServerInitialize rdpsnd_server_context::Initialize

Initialize the channel. The caller should check the return value to see whether the initialization succeed. If not, the "Activated" callback will not be called and the server must not call any API on this context.

Definition at line 102 of file server/rdpsnd.h.

◆ initialPitch

UINT32 rdpsnd_server_context::initialPitch

Definition at line 149 of file server/rdpsnd.h.

◆ initialVolume

UINT32 rdpsnd_server_context::initialVolume

Definition at line 147 of file server/rdpsnd.h.

◆ latency

UINT32 rdpsnd_server_context::latency

Definition at line 86 of file server/rdpsnd.h.

◆ num_client_formats

UINT16 rdpsnd_server_context::num_client_formats

Definition at line 90 of file server/rdpsnd.h.

◆ num_server_formats

size_t rdpsnd_server_context::num_server_formats

Definition at line 80 of file server/rdpsnd.h.

◆ priv

RdpsndServerPrivate* rdpsnd_server_context::priv

Definition at line 70 of file server/rdpsnd.h.

◆ qualityMode

UINT16 rdpsnd_server_context::qualityMode

Definition at line 151 of file server/rdpsnd.h.

◆ rdpcontext

rdpContext* rdpsnd_server_context::rdpcontext

Definition at line 142 of file server/rdpsnd.h.

◆ selected_client_format

UINT16 rdpsnd_server_context::selected_client_format

Definition at line 91 of file server/rdpsnd.h.

◆ SelectFormat

psRdpsndServerSelectFormat rdpsnd_server_context::SelectFormat

Choose the audio format to be sent. The index argument is an index into the client_formats array and must be smaller than num_client_formats.

Definition at line 108 of file server/rdpsnd.h.

◆ SendFormats

psRdpsndServerSendFormats rdpsnd_server_context::SendFormats

Send server formats and version to the client. Automatically sent, when opening the channel. Also used to restart the protocol after sending the Close PDU.

Definition at line 158 of file server/rdpsnd.h.

◆ SendSamples

psRdpsndServerSendSamples rdpsnd_server_context::SendSamples

Send audio samples. Actually bytes in the buffer must be: nframes * src_format.nBitsPerSample * src_format.nChannels / 8

Definition at line 113 of file server/rdpsnd.h.

◆ SendSamples2

psRdpsndServerSendSamples2 rdpsnd_server_context::SendSamples2

Send encoded audio samples using a Wave2 PDU. When successful, the block_no member is incremented.

Definition at line 168 of file server/rdpsnd.h.

◆ server_formats

AUDIO_FORMAT* rdpsnd_server_context::server_formats

Definition at line 79 of file server/rdpsnd.h.

◆ SetVolume

psRdpsndServerSetVolume rdpsnd_server_context::SetVolume

Set the volume level of the client. Valid range is between 0 and 0xFFFF.

Definition at line 122 of file server/rdpsnd.h.

◆ src_format

AUDIO_FORMAT* rdpsnd_server_context::src_format

Definition at line 83 of file server/rdpsnd.h.

◆ Start

psRdpsndStart rdpsnd_server_context::Start

Definition at line 67 of file server/rdpsnd.h.

◆ Stop

psRdpsndStop rdpsnd_server_context::Stop

Definition at line 68 of file server/rdpsnd.h.

◆ Training

psRdpsndServerTraining rdpsnd_server_context::Training

Send Training PDU.

Definition at line 162 of file server/rdpsnd.h.

◆ TrainingConfirm

psRdpsndServerTrainingConfirm rdpsnd_server_context::TrainingConfirm

Called when a TrainingConfirm PDU is received from the client.

Definition at line 173 of file server/rdpsnd.h.

◆ use_dynamic_virtual_channel

BOOL rdpsnd_server_context::use_dynamic_virtual_channel

Definition at line 76 of file server/rdpsnd.h.

◆ vcm

HANDLE rdpsnd_server_context::vcm

Definition at line 65 of file server/rdpsnd.h.

The documentation for this struct was generated from the following file:

server/rdpsnd.h

Data Fields