STK Graphics PrimitivesSend comments on this topic.
StartRecordingVideo Method (IAgStkGraphicsCameraVideoRecording)
See Also
FileDirectory
The directory in which the video will be saved.
FilePrefix
Used to create the filename of the video. This file prefix should not contain a file extension. The correct file extension will be added based on the specified videoFormat.
VideoFormat
The file format for the video.
VideoBitRate
A higher value will create larger files with better visual quality than a lower value that will create smaller files with poorer visual quality. A value of 5000 is a good starting point to judge the file size to visual quality trade-off.
VideoFrameRate
The frame rate of the video in frames per second. A value of 30 is typical.
Windows





Windows & Linux

Description

Starts recording a video file at the specified bit and frame rate.

Syntax

[Visual Basic .NET]
Public Sub StartRecordingVideo( _
    ByVal FileDirectory As String, _
    ByVal FilePrefix As String, _
    ByVal VideoFormat As AgEStkGraphicsCameraVideoFormat, _
    ByVal VideoBitRate As Integer, _
    ByVal VideoFrameRate As Integer _
)
[C#]
public void StartRecordingVideo(
    string FileDirectory,
    string FilePrefix,
    AgEStkGraphicsCameraVideoFormat VideoFormat,
    int VideoBitRate,
    int VideoFrameRate
);
[Managed C++]
public: void StartRecordingVideo(
    String __gc ^ FileDirectory,
    String __gc ^ FilePrefix,
    AgEStkGraphicsCameraVideoFormat VideoFormat,
    int VideoBitRate,
    int VideoFrameRate
);
[Unmanaged C++]
public: HRESULT StartRecordingVideo(
    BSTR FileDirectory,
    BSTR FilePrefix,
    AgEStkGraphicsCameraVideoFormat VideoFormat,
    int VideoBitRate,
    int VideoFrameRate
);
[Java]
public void startRecordingVideo(
    String FileDirectory,
    String FilePrefix,
    AgEStkGraphicsCameraVideoFormat VideoFormat,
    Integer VideoBitRate,
    Integer VideoFrameRate
);
[Python - STK API ]
def StartRecordingVideo(self, FileDirectory:str, FilePrefix:str, VideoFormat:"AgEStkGraphicsCameraVideoFormat", VideoBitRate:int, VideoFrameRate:int) -> None:

Parameters

FileDirectory
The directory in which the video will be saved.
FilePrefix
Used to create the filename of the video. This file prefix should not contain a file extension. The correct file extension will be added based on the specified videoFormat.
VideoFormat
The file format for the video.
VideoBitRate
A higher value will create larger files with better visual quality than a lower value that will create smaller files with poorer visual quality. A value of 5000 is a good starting point to judge the file size to visual quality trade-off.
VideoFrameRate
The frame rate of the video in frames per second. A value of 30 is typical.

See Also

© 2025 Analytical Graphics, Inc. All Rights Reserved.