| View Functions | |
| View Specific Function Name | |
| Camera Post-Process Function Name | |
| Camera Sensor Function Name | |
| Camera Function Name | |
| Image and Video Capture Function Name | |
| Observer View Specific Function Name |
| View Specific Function Name | |
ChangeView(szName as String)Used to change the camera used by the main view. | |
OpenView(szName as String, szTitle as String)Used to open a new view. | |
CloseView(szName as String)Used to close a view. | |
DockView(szName as String)Used to dock a view. | |
UndockView(szName as String) Used to undock a view. |
| Camera Post-Process Function Name | |
AddPostProcess(szCameraName as String, szPostProcessName as String)Used to add a post process effect to the specified camera. | |
AddPostProcessMainCamera(szPostProcessName as String)Used to add a post process effect to the main camera. | |
RemovePostProcess(szCameraName as String, szPostProcessName as String) Used to change the sensor mode of a camera. | |
RemovePostProcessMainCamera(szPostProcessName as String)Used to change the sensor mode of the main camera. |
| Camera Sensor Function Name | |
RequestCameraSensorMode(szName as String, RequestID as [Enum])Used to request the current sensor mode of a given view. | |
RequestMainCameraSensorMode(RequestID as [Enum])Used to request the current sensor mode of the main view. | |
SetCameraSensorMode(szName as String, eSensorMode as SIMCONNECT_CAMERA_SENSOR_MODE)Used to change the sensor mode of a camera. | |
SetMainCameraSensorMode(eSensorMode as SIMCONNECT_CAMERA_SENSOR_MODE)Used to change the sensor mode of the main camera. |
| Camera Specific Function Name | |
CameraPanToView(szCameraName as String, szTargetName as String, fSmoothTime as Single)Used to smoothly transition the view of the specified camera to the view of the specified target camera. This function currently only works for Custom Cameras. | |
CameraSetRelative6DOF(fDeltaX as Single, fDeltaY as Single, fDeltaZ as Single, fPitchDeg as Single, fBankDeg as Single, fHeadingDeg as Single)Used to adjust the user's aircraft view camera. | |
CameraSetRelative6DofByName(szName as String, fDeltaX as Single, fDeltaY as Single, fDeltaZ as Single, fPitchDeg as Single, fBankDeg as Single, fHeadingDeg as Single)Used to adjust the specified view's camera. | |
CameraSmoothRelative6DOF(fDeltaX as Single, fDeltaY as Single, fDeltaZ as Single, fPitchDeg as Single, fBankDeg as Single, fHeadingDeg as Single, fSmoothTime as Single)Used to smoothly transition the view of the main camera to the specified location. | |
CameraSmoothRelative6DOFByName(szName as String, fDeltaX as Single, fDeltaY as Single, fDeltaZ as Single, fPitchDeg as Single, fBankDeg as Single, fHeadingDeg as Single, fSmoothTime as Single)Used to smoothly transition the view of the specified camera to the specified location. | |
CameraZoomIn(szName as String)Used to adjust the zoom of the camera. | |
CameraZoomOut(szName as String)Used to adjust the zoom of the camera. | |
CreateCameraDefinition(guidCamera as ValueType, ViewType as SIMCONNECT_CAMERA_TYPE, szTitle as String, xyzBias as SIMCONNECT_DATA_XYZ, pbhBias as SIMCONNECT_DATA_PBH)Used to create a new camera definition. | |
CreateCameraInstance(guidCamera as ValueType, szName as String, dwObjectID as UInteger, RequestID as [Enum])Used to create a new camera instance from a camera definition. | |
DeleteCameraInstance(guidCamera as ValueType, InstanceID as UInteger)Used to remove a camera instance from a camera definition. | |
MainCameraPanToView(szTargetName as String, fSmoothTime as Single) Used to smoothly transition the view of the main camera to the view of the specified target camera. This function currently only works for Custom Cameras. | |
MainCameraZoomIn()Used to adjust the zoom of the main camera | |
MainCameraZoomOut()Used to adjust the zoom of the main camera | |
RequestCameraFov(szName as String, RequestID as [Enum])Used to request the field-of-view of a given view (horizontal and vertical). See SIMCONNECT_RECV_CAMERA_FOV. | |
RequestCameraRelative6DOF(RequestID as [Enum])Used to request the XYZ delta offset from the eyepoint reference point, as well as the pitch, bank, and heading of the main view. | |
RequestCameraRelative6DofByName(szName as String, RequestID as [Enum])Used to request the XYZ delta offset from the eyepoint reference point, as well as the pitch, bank, and heading of a given view. | |
RequestCameraWindowPosition(szName as String, RequestID as [Enum])Used to request the current window position of a given view. | |
RequestCameraWindowSize(szName as String, RequestID as [Enum])Used to request the current window size of a given view. | |
RequestMainCameraFov(RequestID as [Enum])Used to request the field-of-view of the main view (horizontal and vertical). See SIMCONNECT_RECV_CAMERA_FOV. | |
SendCameraCommand(guidCamera as ValueType, eCommand as [Enum])Used to simulate user inputs to control camera movement and rotation. | |
SetCameraFov(szName as String, hFov as Single, vFov as Single)Used to change the FoV (Field of View) of a camera. | |
SetCameraHorizontalFov(szName as String, hFov as Single)Used to change the horizontal FoV (Field of View) of a camera. | |
SetCameraVerticalFov(szName as String, vFov as Single)Used to change the vertical FoV (Field of View) of a camera. | |
SetCameraWindowPosition(szName as String, uX as UInteger, uY as UInteger)Used to set the window position of the specified view. | |
SetCameraWindowSize(szName as String, uWidth as UInteger, uHeight as UInteger)Used to set the window size of the specified view. /span> | |
SetMainCameraFov(hFov as Single, vFov as Single)Used to change the FoV (Field of View) of the main camera. | |
SetMainCameraHorizontalFov(hFov as Single) Used to change the horizontal FoV (Field of View) of the main camera. | |
SetMainCameraVerticalFov(vFov as Single)Used to change the vertical FoV (Field of View) of the main camera. |
| Image and Video Capture Function Name | |
CaptureImage(szFileName as String, szFilePath as String, uImageFormat as UInteger, szViewName as String, bFileNameContainsExtension as Boolean)Used to capture an image of a view. | |
CaptureImageW(szFileName as String, szFilePath as String, uImageFormat as UInteger, szViewName as String, bFileNameContainsExtension as Boolean)Used to capture an image of a view. This version of the function supports unicode file paths, filenames, and view names. | |
BeginVideoStream(szViewName as String, StreamInfo as SIMCONNECT_DATA_VIDEO_STREAM_INFO)Used to begin a video stream of a view. | |
EndVideoStream(szViewName as String, StreamInfo as SIMCONNECT_DATA_VIDEO_STREAM_INFO)Used to end a video stream of a view. |
| Observer View Specific Function Name | |
CreateObserver(szName as String, ObserverData as SIMCONNECT_DATA_OBSERVER) Used to create an observer view. | |
RequestObserverData(RequestId as [Enum], szName as String)Used to request all data for a specific observer. | |
MoveObserver(szName as String, Translation as SIMCONNECT_DATA_XYZ)Used to move an observer using an xyz translation. | |
RotateObserver(szName as String, dwAxis as UInteger, dAngleDegrees as Double)Used to rotate an observer around a specified axis. | |
SetObserverPosition(szName as String, Position as SIMCONNECT_DATA_LATLONALT)Used to place an observer at a specific world position. | |
SetObserverRotation(szName as String, RotationAngles as SIMCONNECT_DATA_PBH)Used to set an observer's specific rotation. | |
SetObserverLookAt(szName as String, TargetPosition as SIMCONNECT_DATA_LATLONALT) Used to have an observer look at a world position. | |
SetObserverLookAtEx(szName as String, TargetPosition as SIMCONNECT_DATA_LATLONALT)Used to have an observer look at a world position round world corrected. | |
ObserverTrackLocationOn(szName as String, TargetPosition as SIMCONNECT_DATA_LATLONALT)Used to have an observer track a world position (round world corrected) using an above ground level altitude and accounting for changes in elevation. | |
ObserverTrackLocationOff(szName as String)Used to disable continuous tracking of the previously specified world position. | |
SetObserverFieldOfView(szName as String, fHorizontal as Single, fVertical as Single)Used to set an observer's field of view. | |
SetObserverStepSize(szName as String, fLinearStep as Single, fAngularStep as Single)Used to set an observer's linear and angular step size. | |
SetObserverFocalLength(szName as String, fFocalLength as Single)Used to set an observer's focal length (in meters). | |
SetObserverFocusFixed(szName as String, bFocusFixed as Boolean)Used to switch an observer's focus between local and world. | |
SetObserverRegime(szName as String, eRegime as UInteger)Used to switch an observer's regime (terrestrial, tellurian, or ghost). | |
SetObserverZoomLevels(szName, dwNumLevels as UInteger)Used to set an observer's zoom level. | |
ObserverTrackEntityOn(szName as String, dwObject as UInteger) Used to enable continuous tracking of the specified entity. | |
ObserverTrackEntityOff(szName as String)Used to disable continuous tracking of the previously specified entity. | |
ObserverAttachToEntityOn(szName as String, dwObject as UInteger, Offset as SIMCONNECT_DATA_XYZ)Used to attach an observer to the specified entity. | |
ObserverAttachToEntityOff(szName as String)Used to detach an observer from its attached entity. | |
SetObserverSceneryOrigin(szName as String, eOrigin as UInteger)Used to switch an observer's scenery origin mode (target or self). |