Skip to main content

overwolf.streaming.StreamVideoOptions

Overwolf APIs / overwolf / overwolf / streaming / StreamVideoOptions

Stream video options.

Properties

PropertyTypeDescription
auto_calc_kbps?booleanDefines if to try to automatically calculate the kbps. If set to true, then the max_kbps field is ignored.
base_frame_size_source?eVideoBaseFrameSizeSource-
buffer_length?numberDefines the length of the buffer to be recorded in millisenconds (max 40 seconds)
capture_desktop?StreamDesktopCaptureOptionsDefines the desktop streaming options.
disable_auto_shutdown_on_game_exit?booleanDisables automatic shutdown of the streaming API once the targeted game session ended.
disable_when_sht_not_supported?booleanDo not start video replay service in case shared texture is not supported.
enable_on_demand_split?boolean-
encoder?StreamingVideoEncoderSettingsDefines the video encoder settings to use.
fps?numberDefines the Frames Per Second for the stream.
frame_size_method?eVideoFrameSizeCalcMethod-
game_window_capture?GameWindowCapture-
height?numberDefines the stream height in pixels.
include_full_size_video?booleanIn case max_file_size_bytes is on, full video will be recorded to disk, parallel to splits videos.
indication_position?IndicationPositionPosition of the recorder indicator. Available for video capture only.
indication_type?IndicationTypeType of the recorder indicator. Available for video capture only.
keep_game_capture_on_lost_focus?booleanKeep capturing the game when the game loses focus (i.e do not show "Be Right Back"). Note: if game is minimized, BRB will be shown.
max_file_size_bytes?numberDefines file maximum size. when video reach max_file_size_bytes, the recorder will flash the video file and stat a new video file. onFileSpilt event will be fired.
max_kbps?numberDefines the maximum KB per second of the stream.
notify_dropped_frames_ratio?numberThe ratio of dropped to non-dropped frames for which to issue a notification.
override_overwolf_setting?booleanDo not use Overwolf capture setting. In case True you must provider all video setting (encoder..)
sources?VideoSource[]Add sources to video (currently only webcam is supported)
sub_folder_name?stringDefines 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>
test_drop_frames_interval?numberThe interval, in milliseconds, in which to test for dropped frames.
use_app_display_name?booleanuse the app "short name" as the folder name, instead of using the app name from the manifest.
width?numberDefines the stream width in pixels.