Ninja Docs
Search…
Misc options
Newly Added Parameters
&showlabels
Display labels as a video overlay.

Aliases

  • &showlabel
  • &sl

Details

This parameter will display the user's display name or label on screen, as a text overlay. The label can be set either via the URL using the &label parameter, or the room's director can set it dynamically via the "Add a label" option.
This parameter can be used on guest links, view links, or scene links. It will be sticky to the each individual video and not the browser window as a whole.
Underscores "_" used in label values will be replaced by spaces, allowing for word separation.
HTML5 Emojis 🎈 and some non-Latin characters are supported.

Preset styling options

There are some preset style options, which can be passed to the parameter as a value. You can also choose to just edit the label's style with CSS, as discussed lower on this page.
Value
Description
skype
Skype styled display names
ninjablue
VDO.Ninja styled display names
toprounded
Rounded display names
fire
Fire looking display names
teams
Microsoft Teams styled display names
zoom
Zoom styled display names
If no preset option is passed, a default generic style is used.

Font size customization

You can change the font-size without using CSS, using the &fontsize parameter. CSS is also supported though.
Font-size of labels will adjust slightly based on the window size.

Advanced Customization

CSS of the styles can be set via the OBS browser source stylesheet window. The CSS class name you can customize is called "video-label".
An example of how to set a custom CSS style for labels
You can copy the below code, modifying it as you desire, as a starting point. You'll still need to use &showlabels to trigger the labels to display though.
1
.video-label {
2
color: red;
3
bottom: 2vh;
4
left: 50%;
5
transform: translateX(-50%);
6
background: rgba(0, 0, 0, .8);
7
pointer-events:none;
8
border-radius: 5px;
9
font-size: 0.8em;
10
}
Copied!
Below is another example, this time we target the video tile class, creating a margin above the video elements. We can then move the display label into that space, creating a label that is not overlaying the video itself, but still attached.
We can paste the CSS code directly into the OBS browser source, or we can host the style in a file and access it via the &css parameter
1
.tile {
2
margin-top: 10vh !important;
3
max-height: 90vh!important;
4
}
5
6
.video-label {
7
bottom:unset;
8
top:0;
9
text-align:middle;
10
left:unset;
11
background:unset;
12
text-shadow : 0 0 10px #035;
13
font-size: 7vh!important;
14
}
Copied!
Last modified 1mo ago