SAFR Windows SDK
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events
RealNetworks.CameraKit.XimeaCamera Class Reference

A Ximea USB3 Vision camera. More...

Inheritance diagram for RealNetworks.CameraKit.XimeaCamera:
RealNetworks.CameraKit.Camera

Public Member Functions

override CaptureSession CreateCaptureSession (IVideoProfile video, IDepthProfile depth=null, Accelerator accelerator=null)
 Create a new capture session with the given video profile. More...
 
override void Authenticate (CameraCredentials creds, CameraConnectCompletion completion)
 Authenticates the camera. This means that the camera will store the provided account and use it to get the current state of the physical camera which requires authentication to access it. E.g. it will fetch the available media profiles. More...
 
override List< IDepthProfileGetDepthProfiles (IVideoProfile vp)
 The depth profiles that are available for the given video profile. More...
 
- Public Member Functions inherited from RealNetworks.CameraKit.Camera
 Camera (CameraIdentifier identifier)
 
IVideoProfile GetProfile (string token)
 Returns the profile for the given token or nil if no such profile is known to the camera. More...
 
IDepthProfile GetBestDepthProfile (IVideoProfile vp)
 Returns the highest quality depth profile that is available for the given video profile. More...
 

Properties

override CameraConfiguration Configuration [get, set]
 Returns the camera configuration More...
 
override List< IVideoProfileProfiles [get, protected set]
 The available profiles More...
 
override IVideoProfile DefaultProfile [get]
 Returns the default profile. This is a profile that should be used for capturing if you don't have any specific profile selection criteria. Nil is returned if the camera has no suitable profiles available. More...
 
override string LocalizedName [get, set]
 
override CameraPosition Position [get]
 
override bool CanCaptureDepthData [get]
 Returns true if the camera is able to deliver depth data in addition to video data. More...
 
override bool CanAdjustGainExposure [get]
 Returns true if the camera supports adjusting gain and exposure. More...
 
override Range< float > GainRange [get]
 Returns the range of supported gain values. An empty range is returned if gain adjustment is not supported More...
 
override float Gain [get, set]
 The current camera sensor gain value. More...
 
override Range< float > ExposureRange [get]
 Returns the range of supported exposure values. Exposure is measured in milliseconds. An empty range is returned if exposure adjustments are not supported. More...
 
override float Exposure [get, set]
 The current exposure value in milliseconds. Exposure is typically half the frame rate. Exposure time is capped by the frame rate (it can not be longer than the time of a single frame). More...
 
override bool IsAutoGainExposureEnabled [get, set]
 Controls whether the camera itself should automatically adjust gain and exposure as needed. More...
 
float MaxFrameRate [get, set]
 
override? CameraCredentials Credentials [get]
 The credentials to use for authentication More...
 
override bool RequiresAuthentication [get]
 Returns true if the camera requires authentication in order to access its video profile information and to stream from it. More...
 
override bool IsAuthenticated [get]
 Returns true if the camera has been successfully authenticated; false otherwise More...
 
- Properties inherited from RealNetworks.CameraKit.Camera
CameraIdentifier Identifier [get]
 Returns the globally unique camera identifier. More...
 
CameraType CameraType [get]
 Returns the type of the camera. More...
 
abstract string LocalizedName [get, set]
 Returns the localized camera name. More...
 
abstract CameraPosition Position [get]
 Returns the position of the camera. More...
 
abstract bool CanCaptureDepthData [get]
 Returns true if the camera is able to deliver depth data in addition to video data. More...
 
virtual string?? UserSource [get, set]
 The user source override. The global default user source will be used if the camera doesn't have its own user source. More...
 
virtual bool MirroringEnabled [get, set]
 Returns true if the video frames are mirrored about the Y axis; false otherwise. More...
 
virtual int Rotation [get, set]
 Returns the value by which video frames are rotated clockwise after mirroring. More...
 
abstract bool CanAdjustGainExposure [get]
 Returns true if the camera supports adjusting gain and exposure. More...
 
abstract Range< float > GainRange [get]
 Returns the range of supported gain values. An empty range is returned if gain adjustment is not supported More...
 
abstract float Gain [get, set]
 The current camera sensor gain value. More...
 
abstract Range< float > ExposureRange [get]
 Returns the range of supported exposure values. Exposure is measured in milliseconds. An empty range is returned if exposure adjustments are not supported. More...
 
abstract float Exposure [get, set]
 The current exposure value in milliseconds. Exposure is typically half the frame rate. Exposure time is capped by the frame rate (it can not be longer than the time of a single frame). More...
 
abstract bool IsAutoGainExposureEnabled [get, set]
 Controls whether the camera itself should automatically adjust gain and exposure as needed. More...
 
bool CanCrop = true [get, protected set]
 Is cropping supported. More...
 
virtual bool CroppingEnabled [get, set]
 Is cropping enabled. More...
 
virtual ? RectangleF CropRectangle [get, set]
 The video crop rectangle in a normalized coordinate system from 0-1 with the origin in the top left corner. The video frame is cropped from the native resolution to this rectangle. If this is nil no cropping will occur. More...
 
float FrameRateReduction [get, set]
 Frame rate reduciton ratio (1.0 - no reduction). More...
 
abstract CameraConfiguration Configuration [get, set]
 Returns the camera configuration. More...
 
virtual bool ContrastEnhancementEnable [get, set]
 Enables / disables contrast enhancement. More...
 
virtual double LowLightThreshold [get, set]
 Contrast enhancement low light threshold. More...
 
virtual double ExposureBoost [get, set]
 Contrast enhanement exposure boost. More...
 
virtual bool DetectionOnlyContrastEnhancement [get, set]
 Enables / disables deferring of contrast enhancement from the camera side to the face detector side. More...
 
abstract List< IVideoProfileProfiles [get, protected set]
 The available profiles. More...
 
abstract IVideoProfile DefaultProfile [get]
 Returns the default profile. This is a profile that should be used for capturing if you don't have any specific profile selection criteria. Nil is returned if the camera has no suitable profiles available. More...
 
bool IsConnected [get]
 Returns true if the camera is connected and false if it got disconnected / removed. More...
 
abstract ? CameraCredentials Credentials [get]
 The credentials to use for authentication. More...
 
abstract bool RequiresAuthentication [get]
 Returns true if the camera requires authentication in order to access its video profile information and to stream from it. More...
 
abstract bool IsAuthenticated [get]
 Returns true if the camera has been successfully authenticated; false otherwise. More...
 
virtual int MetadataPort [get, set]
 The metadata ip port. More...
 
bool ShouldRestartCaptureSession = false [get, set]
 The metadata ip port. More...
 
DirectionOfTravelDescriptor DirectionOfTravelDescriptor [get, set]
 Unauthorized direction configuration. More...
 

Additional Inherited Members

- Protected Member Functions inherited from RealNetworks.CameraKit.Camera
void OnConfigurationDidChange (bool restartCaptureSession=false)
 Saves the current camera state and posts a didChange notification. Does nothing if the key paths array is empty. More...
 
- Events inherited from RealNetworks.CameraKit.Camera
EventHandler< DidChangeConfigurationEventArgsDidChangeConfiguration
 Configuration change event handler. More...
 

Detailed Description

A Ximea USB3 Vision camera.

Member Function Documentation

◆ Authenticate()

override void RealNetworks.CameraKit.XimeaCamera.Authenticate ( CameraCredentials  creds,
CameraConnectCompletion  completion 
)
virtual

Authenticates the camera. This means that the camera will store the provided account and use it to get the current state of the physical camera which requires authentication to access it. E.g. it will fetch the available media profiles.

Parameters
credsthe camera credentials
completionthe completion handler to invoke

Implements RealNetworks.CameraKit.Camera.

◆ CreateCaptureSession()

override CaptureSession RealNetworks.CameraKit.XimeaCamera.CreateCaptureSession ( IVideoProfile  video,
IDepthProfile  depth = null,
Accelerator  accelerator = null 
)
virtual

Create a new capture session with the given video profile.

Parameters
videothe desired video profile
depththe desired depth profile (optional)
acceleratorthe accelerator that should be used for video decoding. Null means use the primary display accelerator
Returns
the capture session

Implements RealNetworks.CameraKit.Camera.

◆ GetDepthProfiles()

override List<IDepthProfile> RealNetworks.CameraKit.XimeaCamera.GetDepthProfiles ( IVideoProfile  vp)
virtual

The depth profiles that are available for the given video profile.

Parameters
vpthe video profile
Returns
the available depth profiles

Implements RealNetworks.CameraKit.Camera.

Property Documentation

◆ CanAdjustGainExposure

override bool RealNetworks.CameraKit.XimeaCamera.CanAdjustGainExposure
get

Returns true if the camera supports adjusting gain and exposure.

◆ CanCaptureDepthData

override bool RealNetworks.CameraKit.XimeaCamera.CanCaptureDepthData
get

Returns true if the camera is able to deliver depth data in addition to video data.

◆ Configuration

override CameraConfiguration RealNetworks.CameraKit.XimeaCamera.Configuration
getset

Returns the camera configuration

◆ Credentials

override? CameraCredentials RealNetworks.CameraKit.XimeaCamera.Credentials
get

The credentials to use for authentication

◆ DefaultProfile

override IVideoProfile RealNetworks.CameraKit.XimeaCamera.DefaultProfile
get

Returns the default profile. This is a profile that should be used for capturing if you don't have any specific profile selection criteria. Nil is returned if the camera has no suitable profiles available.

◆ Exposure

override float RealNetworks.CameraKit.XimeaCamera.Exposure
getset

The current exposure value in milliseconds. Exposure is typically half the frame rate. Exposure time is capped by the frame rate (it can not be longer than the time of a single frame).

◆ ExposureRange

override Range<float> RealNetworks.CameraKit.XimeaCamera.ExposureRange
get

Returns the range of supported exposure values. Exposure is measured in milliseconds. An empty range is returned if exposure adjustments are not supported.

◆ Gain

override float RealNetworks.CameraKit.XimeaCamera.Gain
getset

The current camera sensor gain value.

◆ GainRange

override Range<float> RealNetworks.CameraKit.XimeaCamera.GainRange
get

Returns the range of supported gain values. An empty range is returned if gain adjustment is not supported

◆ IsAuthenticated

override bool RealNetworks.CameraKit.XimeaCamera.IsAuthenticated
get

Returns true if the camera has been successfully authenticated; false otherwise

◆ IsAutoGainExposureEnabled

override bool RealNetworks.CameraKit.XimeaCamera.IsAutoGainExposureEnabled
getset

Controls whether the camera itself should automatically adjust gain and exposure as needed.

◆ LocalizedName

override string RealNetworks.CameraKit.XimeaCamera.LocalizedName
getset

◆ MaxFrameRate

float RealNetworks.CameraKit.XimeaCamera.MaxFrameRate
getset

◆ Position

override CameraPosition RealNetworks.CameraKit.XimeaCamera.Position
get

◆ Profiles

override List<IVideoProfile> RealNetworks.CameraKit.XimeaCamera.Profiles
getprotected set

The available profiles

◆ RequiresAuthentication

override bool RealNetworks.CameraKit.XimeaCamera.RequiresAuthentication
get

Returns true if the camera requires authentication in order to access its video profile information and to stream from it.