FreeRDP
CameraDeviceServerContext Struct Reference

#include <rdpecam.h>

Collaboration diagram for CameraDeviceServerContext:

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

Copyright 2022 Pascal Nowack Pasca.nosp@m.l.No.nosp@m.wack@.nosp@m.gmx..nosp@m.de

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.

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.

◆ ChannelHandle

psCameraDeviceServerChannelHandle CameraDeviceServerContext::ChannelHandle

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

◆ ChannelIdAssigned

psCameraDeviceServerChannelIdAssigned CameraDeviceServerContext::ChannelIdAssigned

Callback, when the channel got its id assigned.

◆ Close

psCameraDeviceServerClose CameraDeviceServerContext::Close

Close the camera device channel.

◆ CurrentMediaTypeRequest

psCameraDeviceServerCurrentMediaTypeRequest CameraDeviceServerContext::CurrentMediaTypeRequest

Send a Current Media Type Request PDU.

◆ CurrentMediaTypeResponse

psCameraDeviceServerCurrentMediaTypeResponse CameraDeviceServerContext::CurrentMediaTypeResponse

Callback for the Current Media Type Response PDU.

◆ DeactivateDeviceRequest

psCameraDeviceServerDeactivateDeviceRequest CameraDeviceServerContext::DeactivateDeviceRequest

Send a Deactivate Device Request PDU.

◆ ErrorResponse

psCameraDeviceServerErrorResponse CameraDeviceServerContext::ErrorResponse

Callback for the Error Response PDU.

◆ 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

◆ MediaTypeListRequest

psCameraDeviceServerMediaTypeListRequest CameraDeviceServerContext::MediaTypeListRequest

Send a Media Type List Request PDU.

◆ MediaTypeListResponse

psCameraDeviceServerMediaTypeListResponse CameraDeviceServerContext::MediaTypeListResponse

Callback for the Media Type List Response PDU.

◆ Open

psCameraDeviceServerOpen CameraDeviceServerContext::Open

Open the camera device channel.

◆ Poll

psCameraDeviceServerPoll CameraDeviceServerContext::Poll

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

◆ PropertyListRequest

psCameraDeviceServerPropertyListRequest CameraDeviceServerContext::PropertyListRequest

Send a Property List Request PDU.

◆ PropertyListResponse

psCameraDeviceServerPropertyListResponse CameraDeviceServerContext::PropertyListResponse

Callback for the Property List Response PDU.

◆ PropertyValueRequest

psCameraDeviceServerPropertyValueRequest CameraDeviceServerContext::PropertyValueRequest

Send a Property Value Request PDU.

◆ PropertyValueResponse

psCameraDeviceServerPropertyValueResponse CameraDeviceServerContext::PropertyValueResponse

Callback for the Property Value Response PDU.

◆ 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.

◆ rdpcontext

rdpContext* CameraDeviceServerContext::rdpcontext

◆ SampleErrorResponse

psCameraDeviceServerSampleErrorResponse CameraDeviceServerContext::SampleErrorResponse

Callback for the Sample Error Response PDU.

◆ SampleRequest

psCameraDeviceServerSampleRequest CameraDeviceServerContext::SampleRequest

Send a Sample Request PDU.

◆ SampleResponse

psCameraDeviceServerSampleResponse CameraDeviceServerContext::SampleResponse

Callback for the Sample Response PDU.

◆ SetPropertyValueRequest

psCameraDeviceServerSetPropertyValueRequest CameraDeviceServerContext::SetPropertyValueRequest

Send a Set Property Value Request PDU.

◆ StartStreamsRequest

psCameraDeviceServerStartStreamsRequest CameraDeviceServerContext::StartStreamsRequest

Send a Start Streams Request PDU.

◆ StopStreamsRequest

psCameraDeviceServerStopStreamsRequest CameraDeviceServerContext::StopStreamsRequest

Send a Stop Streams Request PDU.

◆ StreamListRequest

psCameraDeviceServerStreamListRequest CameraDeviceServerContext::StreamListRequest

Send a Stream List Request PDU.

◆ StreamListResponse

psCameraDeviceServerStreamListResponse CameraDeviceServerContext::StreamListResponse

Callback for the Stream List Response PDU.

◆ SuccessResponse

psCameraDeviceServerSuccessResponse CameraDeviceServerContext::SuccessResponse

Callback for the Success Response PDU.

◆ userdata

void* CameraDeviceServerContext::userdata

◆ vcm

HANDLE CameraDeviceServerContext::vcm

◆ 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.)


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