iFrame integration

URL with Parameters

For the audience view, there are a couple of parameters you can use to modify the experience, e.g. skipping the Join screen and going straight to language selection:

https://stm.live/vFairsTest/fullscreen?embed=true

Or skip the Join screen and Language selection and forcing a language:

https://stm.live/vFairsTest/fullscreen?embed=true&language=fr-FR

Parameters

Parameter
Description

/fullscreen

let's you switch to the Conference View directly. Not compatible with Video room type.

embed=true

skips the join screen and offers language selection as a participant directly

language=language_code

skips the language selection screen and forces a language from the language list

hide-stt=true

hides speech-to-text button

bg-color=fff

sets background color to a HEX value. Supports transparent value

color=fff

sets font color to a HEX value. Supports transparent value

dark=true

toggles dark mode

logo-theme=dark

overrides automatic logo selection

font-size=16px

sets the font-size. Supports values such as 16px, 2em, 2rem, small, medium, large, x-large, xx-large, xxx-large

line-height=1

sets line height

lines=0

sets max number of lines

delay=0

Sets captions delay on client side. Useful when transcribing stream directly from source, which is then distributed via a platform or CDN, which induces lag. Delay is in milliseconds

outline=true

Adds a stroke to the text with 0.05em width for better legibility. Default = true

hide-actions-bar=true

hides top actions bar

speaker-name=Name

sets Speaker name

speaker-gender=male

sets Speaker gender for voice synthesis purposes. Supports male and female values

loading=true

shows loading on conference screen, if there is no message available

show-speakers=true

display and differentiate between speakers in our conference view. Turned off by default.

iFrame

You can wrap the final URL with parameters in a simple iframe to achieve a basic iframe integration:

Last updated