FreeRDP
Loading...
Searching...
No Matches
Data Fields
ICamHal Struct Reference

interface to implement for the camera HAL More...

#include <camera.h>

Collaboration diagram for ICamHal:
Collaboration graph
[legend]

Data Fields

ICamHal * ihal
 
ICamHal ICamHalEnumCallback callback
 
ICamHal ICamHalEnumCallback CameraPlugin * ecam
 
ICamHal ICamHalEnumCallback CameraPlugin GENERIC_CHANNEL_CALLBACK * hchannel
 
BOOL(* Activate )(ICamHal *ihal, const char *deviceId, UINT32 *errorCode)
 
BOOL(* Deactivate )(ICamHal *ihal, const char *deviceId, UINT32 *errorCode)
 
ICamHal const char * deviceId
 
ICamHal const char int streamIndex
 
ICamHal const char int const CAM_MEDIA_FORMAT_INFO * supportedFormats
 
ICamHal const char int const CAM_MEDIA_FORMAT_INFO size_t nSupportedFormats
 
ICamHal const char int const CAM_MEDIA_FORMAT_INFO size_t CAM_MEDIA_TYPE_DESCRIPTION * mediaTypes
 
ICamHal const char int const CAM_MEDIA_FORMAT_INFO size_t CAM_MEDIA_TYPE_DESCRIPTION size_t * nMediaTypes
 
ICamHal CameraDevice * dev
 
ICamHal CameraDevice int streamIndex
 
ICamHal CameraDevice int const CAM_MEDIA_TYPE_DESCRIPTION * mediaType
 
ICamHal CameraDevice int const CAM_MEDIA_TYPE_DESCRIPTION ICamHalSampleCapturedCallback callback
 
UINT(* StopStream )(ICamHal *ihal, const char *deviceId, int streamIndex)
 
UINT(* Free )(ICamHal *ihal)
 

Detailed Description

interface to implement for the camera HAL

Definition at line 157 of file camera.h.

Field Documentation

◆ Activate

BOOL(* ICamHal::Activate) (ICamHal *ihal, const char *deviceId, UINT32 *errorCode)

callback to activate a given camera device

Parameters
ihalthe hal interface
deviceIdthe name of the device
errorCodea pointer to an error code set if the call failed
Returns
if the operation was successful
Since
3.18.0

Definition at line 179 of file camera.h.

◆ callback [1/2]

ICamHal ICamHalEnumCallback ICamHal::callback

Definition at line 168 of file camera.h.

◆ callback [2/2]

ICamHal CameraDevice int const CAM_MEDIA_TYPE_DESCRIPTION ICamHalSampleCapturedCallback ICamHal::callback

Definition at line 218 of file camera.h.

◆ Deactivate

BOOL(* ICamHal::Deactivate) (ICamHal *ihal, const char *deviceId, UINT32 *errorCode)

callback to deactivate a given camera device

Parameters
ihalthe hal interface
deviceIdthe name of the device
errorCodea pointer to an error code set if the call failed
Returns
if the operation was successful
Since
3.18.0

Definition at line 189 of file camera.h.

◆ dev

ICamHal CameraDevice* ICamHal::dev

Definition at line 217 of file camera.h.

◆ deviceId

ICamHal const char* ICamHal::deviceId

Definition at line 203 of file camera.h.

◆ ecam

ICamHal ICamHalEnumCallback CameraPlugin* ICamHal::ecam

Definition at line 168 of file camera.h.

◆ Free

UINT(* ICamHal::Free) (ICamHal *ihal)

callback to free the ICamHal

Parameters
halthe hal interface
Returns
0 on success, a CAM_Error otherwise

Definition at line 234 of file camera.h.

◆ hchannel

ICamHal ICamHalEnumCallback CameraPlugin GENERIC_CHANNEL_CALLBACK* ICamHal::hchannel

Definition at line 169 of file camera.h.

◆ ihal

ICamHal * ICamHal::ihal

callback to enumerate available camera calling callback for each found item

Parameters
ihalthe hal interface
callbackthe enum callback
ecamthe camera plugin
hchannelthe generic freerdp channel
Returns
the number of found cameras

callback that returns the list of compatible media types given a set of supported formats

Parameters
ihalthe hal interface
deviceIdthe name of the device
streamIndexstream index number
supportedFormatsa pointer to supported formats
nSupportedFormatsnumber of supported formats
mediaTypesresulting media type descriptors
nMediaTypesoutput number of media descriptors
Returns
number of matched supported formats

callback to start a stream

Parameters
ihalthe hal interface
dev
streamIndexstream index number
mediaType
callback
Returns
0 on success, a CAM_Error otherwise

Definition at line 168 of file camera.h.

◆ mediaType

ICamHal CameraDevice int const CAM_MEDIA_TYPE_DESCRIPTION* ICamHal::mediaType

Definition at line 217 of file camera.h.

◆ mediaTypes

ICamHal const char int const CAM_MEDIA_FORMAT_INFO size_t CAM_MEDIA_TYPE_DESCRIPTION* ICamHal::mediaTypes

Definition at line 205 of file camera.h.

◆ nMediaTypes

ICamHal const char int const CAM_MEDIA_FORMAT_INFO size_t CAM_MEDIA_TYPE_DESCRIPTION size_t* ICamHal::nMediaTypes

Definition at line 205 of file camera.h.

◆ nSupportedFormats

ICamHal const char int const CAM_MEDIA_FORMAT_INFO size_t ICamHal::nSupportedFormats

Definition at line 204 of file camera.h.

◆ StopStream

UINT(* ICamHal::StopStream) (ICamHal *ihal, const char *deviceId, int streamIndex)

callback to stop a stream

Parameters
ihalthe hal interface
deviceIdthe name of the device
streamIndexstream index number
Returns
0 on success, a CAM_Error otherwise

Definition at line 227 of file camera.h.

◆ streamIndex [1/2]

ICamHal const char int ICamHal::streamIndex

Definition at line 203 of file camera.h.

◆ streamIndex [2/2]

ICamHal CameraDevice int ICamHal::streamIndex

Definition at line 217 of file camera.h.

◆ supportedFormats

ICamHal const char int const CAM_MEDIA_FORMAT_INFO* ICamHal::supportedFormats

Definition at line 204 of file camera.h.

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