StreamVideoOptions

Stream video options.

Properties

auto_detect

Defines if to try to automatically detect the best settings for streaming.

Type: bool

auto_calc_kbps

Version added: 0.83

Defines if to try to automatically calculate the kbps. If set to true, then the max_kbps field is ignored.

Type: bool

fps

Version added: 0.78

Defines the Frames Per Second for the stream.

Type: int

width

Version added: 0.78

Defines the stream width in pixels.

Type: int

height

Version added: 0.78

Defines the stream height in pixels.

Type: int

max_kbps

Version added: 0.78

Defines the maximum KB per second of the stream.

Type: int

buffer_length

Version added: 0.78

Defines the length of the buffer to be recorded in millisenconds (max 40 seconds)

Type: int

encoder

Version added: 0.83

Defines the video encoder settings to use.

Type: StreamingVideoEncoderSettings

capture_desktop

Version added: 0.83

Defines the desktop streaming options.

Permissions required: DesktopStreaming

Type: StreamDesktopCaptureOptions

frame_interval

Interval between frames when creating gifs.

Type: int

test_drop_frames_interval

Version added: 0.92.100

The interval, in milliseconds, in which to test for dropped frames.

Type: uint

notify_dropped_frames_ratio

Version added: 0.92.100

The ratio of dropped to non-dropped frames for which to issue a notification.

Type: double

max_file_size_bytes

Version added: 0.103.200

Defines file maximum size. when video reach {max_file_size_bytes}, the recorder will flush the video file and stat a new video file. onFileSpilt event will be fired.

Type: uint

sub_folder_name

Version added: 0.103.200

Defines Sub folder for video file path destination (Optional)

OverwolfVideoFolder\\AppName\\|sub_folder_name\\|file_name|

In case |folder_name| is empty:
OverwolfVideoFolder\\AppName\\|sub_folder_name|

Type: string

override_overwolf_setting

Version added: 0.103.200

Do not use Overwolf capture setting. In case True you must provider all video setting (encoder..)

Type: bool

tobii

Version added: 0.97.200

Defines Tobii settings.

Type: TobiiLayerParams