Collaboration diagram for CameraDeviceServerContext:

[legend]

Data Fields
HANDLE	vcm

void *	userdata

char *	virtualChannelName

BYTE	protocolVersion

psCameraDeviceServerInitialize	Initialize

psCameraDeviceServerOpen	Open

psCameraDeviceServerClose	Close

psCameraDeviceServerPoll	Poll

psCameraDeviceServerChannelHandle	ChannelHandle

psCameraDeviceServerActivateDeviceRequest	ActivateDeviceRequest

psCameraDeviceServerDeactivateDeviceRequest	DeactivateDeviceRequest

psCameraDeviceServerStreamListRequest	StreamListRequest

psCameraDeviceServerMediaTypeListRequest	MediaTypeListRequest

psCameraDeviceServerCurrentMediaTypeRequest	CurrentMediaTypeRequest

psCameraDeviceServerStartStreamsRequest	StartStreamsRequest

psCameraDeviceServerStopStreamsRequest	StopStreamsRequest

psCameraDeviceServerSampleRequest	SampleRequest

psCameraDeviceServerPropertyListRequest	PropertyListRequest

psCameraDeviceServerPropertyValueRequest	PropertyValueRequest

psCameraDeviceServerSetPropertyValueRequest	SetPropertyValueRequest

psCameraDeviceServerChannelIdAssigned	ChannelIdAssigned

psCameraDeviceServerSuccessResponse	SuccessResponse

psCameraDeviceServerErrorResponse	ErrorResponse

psCameraDeviceServerStreamListResponse	StreamListResponse

psCameraDeviceServerMediaTypeListResponse	MediaTypeListResponse

psCameraDeviceServerCurrentMediaTypeResponse	CurrentMediaTypeResponse

psCameraDeviceServerSampleResponse	SampleResponse

psCameraDeviceServerSampleErrorResponse	SampleErrorResponse

psCameraDeviceServerPropertyListResponse	PropertyListResponse

psCameraDeviceServerPropertyValueResponse	PropertyValueResponse

rdpContext *	rdpcontext

Detailed Description

FreeRDP: A Remote Desktop Protocol Implementation Video Capture Virtual Channel Extension

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 103 of file server/rdpecam.h.

Field Documentation

◆ ActivateDeviceRequest

psCameraDeviceServerActivateDeviceRequest CameraDeviceServerContext::ActivateDeviceRequest

For the following server to client PDUs, the message header does not have to be set. Send a Activate Device Request PDU.

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

◆ ChannelHandle

psCameraDeviceServerChannelHandle CameraDeviceServerContext::ChannelHandle

Retrieve the channel handle for use in conjunction with Poll(). If externalThread=FALSE do not call.

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

◆ ChannelIdAssigned

psCameraDeviceServerChannelIdAssigned CameraDeviceServerContext::ChannelIdAssigned

Callback, when the channel got its id assigned.

Definition at line 225 of file server/rdpecam.h.

◆ Close

psCameraDeviceServerClose CameraDeviceServerContext::Close

Close the camera device channel.

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

◆ CurrentMediaTypeRequest

psCameraDeviceServerCurrentMediaTypeRequest CameraDeviceServerContext::CurrentMediaTypeRequest

Send a Current Media Type Request PDU.

Definition at line 188 of file server/rdpecam.h.

◆ CurrentMediaTypeResponse

psCameraDeviceServerCurrentMediaTypeResponse CameraDeviceServerContext::CurrentMediaTypeResponse

Callback for the Current Media Type Response PDU.

Definition at line 250 of file server/rdpecam.h.

◆ DeactivateDeviceRequest

psCameraDeviceServerDeactivateDeviceRequest CameraDeviceServerContext::DeactivateDeviceRequest

Send a Deactivate Device Request PDU.

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

◆ ErrorResponse

psCameraDeviceServerErrorResponse CameraDeviceServerContext::ErrorResponse

Callback for the Error Response PDU.

Definition at line 235 of file server/rdpecam.h.

◆ Initialize

psCameraDeviceServerInitialize CameraDeviceServerContext::Initialize

Optional: Set thread handling. When externalThread=TRUE, the application is responsible to call Poll() periodically to process channel events.

Defaults to externalThread=FALSE

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

◆ MediaTypeListRequest

psCameraDeviceServerMediaTypeListRequest CameraDeviceServerContext::MediaTypeListRequest

Send a Media Type List Request PDU.

Definition at line 183 of file server/rdpecam.h.

◆ MediaTypeListResponse

psCameraDeviceServerMediaTypeListResponse CameraDeviceServerContext::MediaTypeListResponse

Callback for the Media Type List Response PDU.

Definition at line 245 of file server/rdpecam.h.

◆ Open

psCameraDeviceServerOpen CameraDeviceServerContext::Open

Open the camera device channel.

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

◆ Poll

psCameraDeviceServerPoll CameraDeviceServerContext::Poll

Poll When externalThread=TRUE, call Poll() periodically from your main loop. If externalThread=FALSE do not call.

Definition at line 152 of file server/rdpecam.h.

◆ PropertyListRequest

psCameraDeviceServerPropertyListRequest CameraDeviceServerContext::PropertyListRequest

Send a Property List Request PDU.

Definition at line 208 of file server/rdpecam.h.

◆ PropertyListResponse

psCameraDeviceServerPropertyListResponse CameraDeviceServerContext::PropertyListResponse

Callback for the Property List Response PDU.

Definition at line 265 of file server/rdpecam.h.

◆ PropertyValueRequest

psCameraDeviceServerPropertyValueRequest CameraDeviceServerContext::PropertyValueRequest

Send a Property Value Request PDU.

Definition at line 213 of file server/rdpecam.h.

◆ PropertyValueResponse

psCameraDeviceServerPropertyValueResponse CameraDeviceServerContext::PropertyValueResponse

Callback for the Property Value Response PDU.

Definition at line 270 of file server/rdpecam.h.

◆ protocolVersion

BYTE CameraDeviceServerContext::protocolVersion

Protocol version to be used. Every sent server to client PDU has the version value in the Header set to the following value.

Definition at line 124 of file server/rdpecam.h.

◆ rdpcontext

rdpContext* CameraDeviceServerContext::rdpcontext

Definition at line 272 of file server/rdpecam.h.

◆ SampleErrorResponse

psCameraDeviceServerSampleErrorResponse CameraDeviceServerContext::SampleErrorResponse

Callback for the Sample Error Response PDU.

Definition at line 260 of file server/rdpecam.h.

◆ SampleRequest

psCameraDeviceServerSampleRequest CameraDeviceServerContext::SampleRequest

Send a Sample Request PDU.

Definition at line 203 of file server/rdpecam.h.

◆ SampleResponse

psCameraDeviceServerSampleResponse CameraDeviceServerContext::SampleResponse

Callback for the Sample Response PDU.

Definition at line 255 of file server/rdpecam.h.

◆ SetPropertyValueRequest

psCameraDeviceServerSetPropertyValueRequest CameraDeviceServerContext::SetPropertyValueRequest

Send a Set Property Value Request PDU.

Definition at line 218 of file server/rdpecam.h.

◆ StartStreamsRequest

psCameraDeviceServerStartStreamsRequest CameraDeviceServerContext::StartStreamsRequest

Send a Start Streams Request PDU.

Definition at line 193 of file server/rdpecam.h.

◆ StopStreamsRequest

psCameraDeviceServerStopStreamsRequest CameraDeviceServerContext::StopStreamsRequest

Send a Stop Streams Request PDU.

Definition at line 198 of file server/rdpecam.h.

◆ StreamListRequest

psCameraDeviceServerStreamListRequest CameraDeviceServerContext::StreamListRequest

Send a Stream List Request PDU.

Definition at line 178 of file server/rdpecam.h.

◆ StreamListResponse

psCameraDeviceServerStreamListResponse CameraDeviceServerContext::StreamListResponse

Callback for the Stream List Response PDU.

Definition at line 240 of file server/rdpecam.h.

◆ SuccessResponse

psCameraDeviceServerSuccessResponse CameraDeviceServerContext::SuccessResponse

Callback for the Success Response PDU.

Definition at line 230 of file server/rdpecam.h.

◆ userdata

void* CameraDeviceServerContext::userdata

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

◆ vcm

HANDLE CameraDeviceServerContext::vcm

Definition at line 105 of file server/rdpecam.h.

◆ virtualChannelName

char* CameraDeviceServerContext::virtualChannelName

Name of the virtual channel. Pointer owned by the CameraDeviceServerContext, meaning camera_device_server_context_free() takes care of freeing the pointer.

Server implementations should sanitize the virtual channel name for invalid names, like names for other known channels ("ECHO", "AUDIO_PLAYBACK_DVC", etc.)

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

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

server/rdpecam.h

Data Fields