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

Classes

class  Accelerator
 An accelerator which provides efficient GPU-based video decoding and image processing. More...
 
class  Adapter
 An adapter represents a single graphics card / GPU / PCI adapter which is available for graphics and video decoding acceleration. Use this class to get the list of all available adapter, then select an adapter from this list and use it to create an accelerator instance. More...
 
class  AesCryptor
 
class  AGLImage
 
class  AMMediaType
 
struct  BitmapInfoHeader
 
class  Camera
 Camera is an abstract base class which represents a camera device and its properties. There are concrete subclasses for specific types of cameras: USB cameras, IP cameras and ONVIF cameras. More...
 
class  CameraConfiguration
 The persistent configuration of a camera. More...
 
class  CameraConnectResult
 
struct  CameraCredentials
 Credentials to authenticate a (ONVIF) camera. More...
 
class  CameraDiscovery
 
struct  CameraIdentifier
 A globally unique camera identifier. More...
 
class  CameraManager
 The camera manager is responsible for the discovery of cameras and it allows you easy access to the default camera for a camera position. More...
 
class  CameraStore
 
class  CancelledCameraConnectResult
 
class  CapDevice
 
class  CapFilterInfo
 FilterInfo class
 
class  CapHelper
 Class that helps finding the pins for a specific filter
 
class  CaptureSession
 A video capture session is created by invoking the CreateCaptureSession() function on a camera object. It represents a video stream with a specific video resolution and frames-per-second setting. A capture session is created in paused state. Set its Capturing property to true to start the capture session and set it to false to pause or stop the capture session. More...
 
class  CaptureSessionException
 A capture session error. More...
 
class  CaptureSessionStatistics
 The capture session statistics More...
 
struct  ContrastEnhacenmentParameters
 Optional contrast enhancement parameters for a video frame. If present on a video frame then contrast enhancement is applied right before face detection. More...
 
class  ContrastEnhancer
 Applies a contrast enhancing algorithm to an image. More...
 
class  CustomJavaScriptSerializer
 
class  DepthImage
 Represents depth information for an image. Smaller depth values are closer to the camera than larger depth values. The origin of the coordinate system is in the top left corner. The width and height of the depth data may be significantly less than the width and height of the corresponding video image.
 
class  DeviceLossMonitor
 An object which monitors the DirectX device underlying an accelerator to detect hardware removal and resets.
 
class  DidChangeConfigurationEventArgs
 The event arguments for a configuration changed event. More...
 
class  DirectionOfTravelDescriptor
 The persistent configuration of a camera. More...
 
struct  EncryptedCameraCredentials
 Encrypted camera credentials.
 
class  ErrorDetectedEventArgs
 
class  ExportedCameraConfigurations
 
class  FailedCameraConnectResult
 
class  FPSEstimator
 This class knows how to efficiently estimate the current frames per second from a continuous stream of timestamps. A new FPS value is computed every second. More...
 
class  FrameAvailableEventArgs
 
class  Gdi32
 
class  GenetecCamera
 
class  GenetecCameraDiscovery
 
class  GenetecCaptureSession
 
struct  GenetecVideoProfile
 
interface  IAMStreamConfig
 
interface  IBaseFilter
 
interface  ICameraConfiguration
 Common configuration properties for all camera types. Individual camera types may define additional configuration properties that are specific to that camera type. More...
 
interface  ICreateDevEnum
 
interface  IDepthData
 Represents depth information for an image. Smaller depth values are closer to the camera than larger depth values. The origin of the coordinate system is in the top left corner. The width and height of the depth data may be significantly less than the width and height of the corresponding video image. More...
 
interface  IDepthProfile
 A depth data profile which defines the specific resolution, filter setting and accuracy of the depth data that should be captured. More...
 
interface  IEnumFilters
 
interface  IEnumPins
 
interface  IFilterGraph
 
interface  IFilterGraph2
 
interface  IGraphBuilder
 
interface  IKsPropertySet
 
class  Image
 
class  ImageCache
 An image cache maintains a cache of GPU-based and / or CPU-based images. This allows efficient reuse of images. More...
 
class  ImageCacheStatistics
 The image cache statistics More...
 
class  ImageMapper
 An image mapper allows you to efficiently gain read-only access to the pixels of an image. It works with bitmap and texture backed images. More...
 
struct  ImageMapping
 The image mapping structure describes the pixel buffer which holds the image pixels. It is filled in by the Map() function when it returns. More...
 
interface  IMediaControl
 
class  IntelRealsenseCamera
 An Intel Realsense camera. More...
 
class  IntelRealsenseCameraConfiguration
 The persistent configuration of a camera. More...
 
class  IntelRealsenseCameraDiscovery
 
class  IntelRealsenseCaptureSession
 
struct  IntelRealsenseDepthProfile
 A Ximea camera video profile.
 
struct  IntelRealsenseVideoProfile
 A Ximea camera video profile.
 
class  IPCameraDiscovery
 
interface  IPin
 
interface  IPropertyBag
 
interface  ISampleGrabber
 
interface  ISampleGrabberCB
 
interface  IVideoProfile
 A video profile which defines a specific video resolution and maximum frame rate at which a video stream should be captured. More...
 
interface  IVideoWindow
 
class  Json
 
class  JsonClassAttribute
 
class  JsonPropertyAttribute
 
class  LibAgl
 
class  MathExtensions
 
struct  Microseconds
 
class  MicrosecondsFormatter
 
class  MobotixSDKBridge
 
class  MobotixSDKCaptureSession
 A capture session that supports Mobotix Event Stream SDK protocol.
 
class  MulticastSocket
 
class  OnvifCamera
 An ONVIF camera object represents a camera which implements the ONVIF camera discovery and managed standard. More...
 
class  OnvifCameraConfiguration
 The persistent configuration of a camera. More...
 
class  PinInfo
 
class  Range
 Represents a inclusive range. More...
 
struct  RECT
 
class  SerializationExtensions
 
struct  SIZE
 
class  StringExtensions
 
class  SuccessCameraConnectResult
 
class  ThreadCaptureSession
 A capture session that supports Thread based frame retrieval. More...
 
struct  Timestamp
 A timestamp represents an absolute point in time on a (video stream) time line. A timestamp is based on a video frame presentation time stamp. It also stores the wall clock time that corresponds to the time when the video frame was decoded. More...
 
class  UnableToAuthenticateException
 Indicates that the camera requires authentication but either none or incorrect authentication information was provided. More...
 
class  UnableToConnectException
 Indicates an error while trying to connect to a camera. More...
 
class  USBCamera
 A USBCamera is a camera which is directly connected to the computer and discovered by the operating system. Examples of such cameras are cameras which are connected via USB. More...
 
class  USBCameraConfiguration
 The persistent configuration of a camera. More...
 
class  USBCameraDiscovery
 
class  USBCaptureSession
 A USB camera capture session More...
 
struct  USBVideoProfile
 A USB camera video profile.
 
struct  VideoFormat
 
class  VideoFrame
 A video frame. More...
 
struct  VideoInfoHeader
 
class  VideoPlayer
 A video player object which is able to play h.264 / h.265 video files and video streams. More...
 
class  VideoPlayerException
 
class  VideoPlayerStatistics
 The video player statistics More...
 
struct  VideoStreamConfigCaps
 
class  VideoView
 A video view displays the video frames from a capture session or video player on the screen. Note that the video view itself does not impose video timing. It immediately display a video frame when you set it on the view. The video timing is provided by the capture session or video player. More...
 
class  XimeaCamera
 A Ximea USB3 Vision camera. More...
 
class  XimeaCameraConfiguration
 The persistent configuration of a camera. More...
 
class  XimeaCameraDiscovery
 
class  XimeaCaptureSession
 
struct  XimeaVideoProfile
 A Ximea camera video profile.
 

Typedefs

using ExportedCameraCredentials = Dictionary< string, string >
 
using DictionaryRepresentation = Dictionary< string, object >
 

Enumerations

enum  CameraConnectResultType { CameraConnectResultType.Success, CameraConnectResultType.Failed, CameraConnectResultType.Cancelled }
 The result of a camera connect / authentication attempt. More...
 
enum  CameraType {
  CameraType.Usb, CameraType.Ip, CameraType.Onvif, CameraType.Genetec,
  CameraType.GenetecFR, CameraType.Digifort, CameraType.Milestone, CameraType.Ximea,
  CameraType.Avigilon, CameraType.IntelRealsense, CameraType.Geutebrueck, CameraType.VideoInsight,
  CameraType.Custom = 0xFF
}
 The type of the camera. More...
 
enum  CameraPosition { CameraPosition.Unspecified, CameraPosition.Front, CameraPosition.Back }
 The position of the camera hardware relative to the viewer. More...
 
enum  CaptureVideoOrientation { CaptureVideoOrientation.Portrait, CaptureVideoOrientation.PortraitUpsideDown, CaptureVideoOrientation.LandscapeRight, CaptureVideoOrientation.LandscapeLeft }
 The video orientation. More...
 
enum  CaptureVideoStabilizationMode { CaptureVideoStabilizationMode.Off, CaptureVideoStabilizationMode.Standard, CaptureVideoStabilizationMode.Cinematic, CaptureVideoStabilizationMode.Auto }
 Video stabilization mode. More...
 
enum  CaptureSessionErrorCode { CaptureSessionErrorCode.unableToConnect = -1, CaptureSessionErrorCode.unableToAuthenticate = -2, CaptureSessionErrorCode.other = -3 }
 The type of a capture session error. More...
 
enum  DepthType { DepthType.Depth16, DepthType.Depth888, DepthType.Disparity16, DepthType.Disparity32 }
 The type of depth data that will be delivered to the capture delegate. More...
 
enum  PixelFormat { PixelFormat.BGRA32, PixelFormat.RGBA32 }
 The image pixel format. More...
 
enum  ImageType { ImageType.Bitmap, ImageType.Texture }
 The image type. The image type controls how and where the image stores the pixel data. More...
 
enum  ImageAccess { ImageAccess.Read = 1, ImageAccess.Write = 2, ImageAccess.ReadWrite = 3 }
 The access mode for Map(). More...
 
enum  VideoSourceType { VideoSourceType.Live, VideoSourceType.Media }
 The type of the video source. More...
 
enum  VideoPlayerErrorCode {
  VideoPlayerErrorCode.DecoderNotFound, VideoPlayerErrorCode.DemuxerNotFound, VideoPlayerErrorCode.ProtocolNotFound, VideoPlayerErrorCode.InvalidData,
  VideoPlayerErrorCode.StreamNotFound, VideoPlayerErrorCode.FileNotFound, VideoPlayerErrorCode.AccessDenied, VideoPlayerErrorCode.Timeout,
  VideoPlayerErrorCode.Io, VideoPlayerErrorCode.HttpBadRequest, VideoPlayerErrorCode.HttpUnauthorized, VideoPlayerErrorCode.HttpForbidden,
  VideoPlayerErrorCode.HttpNotFound, VideoPlayerErrorCode.HttpOther4xx, VideoPlayerErrorCode.HttpServerError, VideoPlayerErrorCode.Unknown
}
 

Functions

delegate void CameraConnectCompletion (CameraConnectResult result)
 

Typedef Documentation

◆ DictionaryRepresentation

using RealNetworks.CameraKit.DictionaryRepresentation = typedef Dictionary<string, object>

◆ ExportedCameraCredentials

typedef Dictionary< string, string > RealNetworks.CameraKit.ExportedCameraCredentials

Enumeration Type Documentation

◆ CameraConnectResultType

The result of a camera connect / authentication attempt.

Enumerator
Success 
Failed 
Cancelled 

◆ CameraPosition

The position of the camera hardware relative to the viewer.

Enumerator
Unspecified 

The camera position is unknown.

Front 

The camera faces the viewer.

Back 

The camera faces the direction the viewer is looking.

◆ CameraType

The type of the camera.

Enumerator
Usb 

A USB or web camera.

Ip 

A camera which allows connection via a public URL

Onvif 

A camera which implements the ONVIF standard and which was automatically discovered via ONVIF

Genetec 
GenetecFR 
Digifort 
Milestone 
Ximea 
Avigilon 
IntelRealsense 
Geutebrueck 
VideoInsight 
Custom 

◆ CaptureSessionErrorCode

The type of a capture session error.

Enumerator
unableToConnect 

It is not possible to connect to the camera or the connection was lost.

unableToAuthenticate 

It is not possible to authenticate the camera. E.g. the ONVIF credentials are invalid.

other 

Some other kind of error.

◆ CaptureVideoOrientation

The video orientation.

Enumerator
Portrait 
PortraitUpsideDown 
LandscapeRight 
LandscapeLeft 

◆ CaptureVideoStabilizationMode

Video stabilization mode.

Enumerator
Off 
Standard 
Cinematic 
Auto 

◆ DepthType

The type of depth data that will be delivered to the capture delegate.

Enumerator
Depth16 

Distance of a point to the camera optics in terms of meters. Encoded as a 16bit linear value.

Depth888 

Distance of a point to the camera optics in terms of meters. Encoded as a 24bit-per-pixel image.

Disparity16 

Disparity describes normalized shift values when comparing two images. Units are 1/meters: ( pixelShift / (pixelFocalLength * baselineInMeters) ). Encoded as a 32bit floating-point value.

Disparity32 

Disparity describes normalized shift values when comparing two images. Units are 1/meters: ( pixelShift / (pixelFocalLength * baselineInMeters) ). Encoded as a 32bit floating-point value.

◆ ImageAccess

The access mode for Map().

Enumerator
Read 
Write 
ReadWrite 

◆ ImageType

The image type. The image type controls how and where the image stores the pixel data.

Enumerator
Bitmap 
Texture 

◆ PixelFormat

The image pixel format.

Enumerator
BGRA32 
RGBA32 

◆ VideoPlayerErrorCode

Enumerator
DecoderNotFound 
DemuxerNotFound 
ProtocolNotFound 
InvalidData 
StreamNotFound 
FileNotFound 
AccessDenied 
Timeout 
Io 
HttpBadRequest 
HttpUnauthorized 
HttpForbidden 
HttpNotFound 
HttpOther4xx 
HttpServerError 
Unknown 

◆ VideoSourceType

The type of the video source.

Enumerator
Live 
Media 

Function Documentation

◆ CameraConnectCompletion()

delegate void RealNetworks.CameraKit.CameraConnectCompletion ( CameraConnectResult  result)