zui docs v0.0.5
GitHub ↗
Multimedia and capture Container Native Qt

Capture Session

Capture Session is a native Zui container in the multimedia and capture catalog, with 7 component-specific properties.

Usage

Ruby example

Paste this complete Builder example inside the app surface from the Quickstart. Replace illustrative asset paths with files from your project.

Ruby
capture_session camera_active: true, video_output_enabled: true, width: 640, height: 360 do
  video_output width: 640, height: 360
end
API

Component properties

7 component-specific values, plus shared item and layout properties.

camera_activeCamera active configuration for Capture Session.property
audio_input_deviceAudio input device configuration for Capture Session.property
audio_output_deviceAudio output device configuration for Capture Session.property
video_output_enabledVideo output enabled configuration for Capture Session.property
widthWidth configuration for Capture Session.property
heightHeight configuration for Capture Session.property
visibleVisible configuration for Capture Session.property
Show 14 shared item properties
enabledopacityscalerotationzfill_widthfill_heightpreferred_widthpreferred_heightminimum_widthminimum_heightmaximum_widthmaximum_heightlayout_alignment
Interaction

Events

Subscribe with on widget, :event and keep behavior in Ruby.

readyNative event payload
errorNative event payload