OBS Plugin & Dockable Controller

User Manual – English

Chapter 1 System Requirements

1.1 System Requirements
  • Windows 7 / 10
  • Mac 10.13 or above
1.2 Software Requirements
  • OSB-Studio 25.08 or above
Chapter 2 Install OBS Plugin & Dockable Controller

2.1 Install with Windows 7 / 10
  1. Please download OBS-Studio software and install it on your computer.
    ➢ Please download OBS Plugin & Dockable Controller software from the Lumens website.
  2. Extract the file downloaded and then click [ OBS Plugin and Dockable Controller.exe ] to install.
    ➢ The installation wizard will guide you through the process. Please follow the on-screen instructions for the next step.
    Lumens OBS Plugin and Dockable Controller - 1 Lumens OBS Plugin and Dockable Controller - 2
    ➢ When the installation is completed, press [ Finish ] to end the installation.
    Lumens OBS Plugin and Dockable Controller - 3 Lumens OBS Plugin and Dockable Controller - 4
2.2 Install with Mac
  1. Please download OBS-Studio software and install it on your Mac.
  2. Please download OBS Plugin & Dockable Controller software from the Lumens website.
  3. Click [ OBS Plugin and Dockable Controller.pkg ] to install.
Chapter 3 Start Using

3.1 Confirm Network Setting

To confirm the computer is on the same network segment as the camera.

Lumens OBS Plugin and Dockable Controller - 5

  1. Camera
  2. Switch or Router
  3. Ethernet Cable
  4. Computer
3.2 Set video source from OBS-Studio

1. Click [ OBS Studio ] icon to open the software.

Lumens OBS Plugin and Dockable Controller - 6

2. Click “+” to add a video source.

Lumens OBS Plugin and Dockable Controller - 7

3. Select [VLC Video Source].

Lumens OBS Plugin and Dockable Controller - 8

4. Give a name to the video source and click [ OK ].

Lumens OBS Plugin and Dockable Controller - 9

5. In Properties page, select “+” then select [ Add Path/URL ].

Lumens OBS Plugin and Dockable Controller - 10

6. Key in the RTSP stream URL then click [ OK ].

Lumens OBS Plugin and Dockable Controller - 11

RTSP connection address formats are as follows:

  • RTSP Main Streaming (4K@H.265)=> rtsp://camera IP:8554/hevc
  • RTSP Sub1 Streaming (1080P@H.264)=> rtsp://camera IP:8557/h264
  • RTSP Sub2 Streaming (720P@H.264)=> rtsp://camera IP:8556/h264

7. Select RTSP URL on the Playlist then click [ OK ].

Lumens OBS Plugin and Dockable Controller - 12

8. The stream will be displayed on the OBS-Studio.

Lumens OBS Plugin and Dockable Controller - 13

3.3 How to use Lumens OBS Plugin to control camera

< Please note that the OBS plugin and Dockable cannot be used simultaneously, as doing so may cause instability >

1. Select [ Tools ] => [ Lumens OBS Plugin ]

Lumens OBS Plugin and Dockable Controller - 14

2. Lumens OBS Plugin window will be displayed.

Lumens OBS Plugin and Dockable Controller - 15

3. Select [ Settings ] => [ Camera Assign]

Lumens OBS Plugin and Dockable Controller - 16

➢ ① Press [ Search ] to find IP cameras from the same network.
➢ ② Select a Camera you would like to control from IP Camera List.
➢ ③ Select the Camera No.
➢ ④ You can change the Camera name.
➢ ⑤ Click [ Apply ] and close Camera Assign window.

Lumens OBS Plugin and Dockable Controller - 17

4. Select set Camera from Select Camera tab, Camera Control setting will be enable. Now you can control the camera via Lumens OBS plugin.

Lumens OBS Plugin and Dockable Controller - 18

3.4 How to use Lumens OBS Dockable to control camera

< Please note that the OBS plugin and Dockable cannot be used simultaneously, as doing so may cause instability >

1. Select [ View ] => [ Docks ] => [ Custom Browser Docks… ]

Lumens OBS Plugin and Dockable Controller - 19

2. Custom Browser Docks window will be displayed.

Lumens OBS Plugin and Dockable Controller - 20

3. Enter the Dock Name & URL

  • Dock Name:Give a name to the customized dock.
  • URL: Copy the installed link dock sample and paste it to the field.
    ➢ For the URL information, please find the installed folder of Dockable Controller.
    ➢ Normally the folder would be following path:
    C:\Program Files\obs-studio\LumensOBSPlugin\Dockable Controller
    The part circled in the red box below is the dock samples.

Lumens OBS Plugin and Dockable Controller - 21

4. Open the dock sample by browser and copy the URL.

Lumens OBS Plugin and Dockable Controller - 22

5. Fill in the DockName, paste avove URL to custom browser docks window and then click [ Apply ].

Lumens OBS Plugin and Dockable Controller - 23

6. Customized dock window will be displayed and you can merge it with OBS-Studio software.

Lumens OBS Plugin and Dockable Controller - 24

7. Click [ PERFEREMCES ] to key in the IP address of the camera you would like to control and click [ Connect ].

Lumens OBS Plugin and Dockable Controller - 25 Lumens OBS Plugin and Dockable Controller - 26

8. After connecting, a pops windows will show the camera is connected.

Lumens OBS Plugin and Dockable Controller - 27

9. Now you can use Lumens dockable to control the IP camera.

Chapter 4 Operation Interface Description

4.1 OBS Plugin

4.1.1 Main

Lumens OBS Plugin and Dockable Controller - 28

No Item Function Descriptions
1 Settings Settings options:
  • Camera assign: Enter the camera setting. Please refer to 4.1.2 Settings-Camera Assign
  • Use HotKeys: When checked, prompt window will pop up: Need to set HotKeys in OBS.

You can click [File]=>[Setting]=>[HotKeys] on OBS-studio to set.

  • PanTilt limit: Enter PanTilt limit setting. Please refer to 4.1.3 Settings- PanTilt limit
  • Preset rename: Enter Preset rename setting. Please refer to 4.1.4 Settings- Preset rename
  • Close: Close Lumens OBS Plugin.
2 View View options:
  • Simple mode
  • Advance mode: please refer to 4.1.5 View- Advance mode
3 Help Show about us information.
4 Select Camera Select the camera number you want to control.
Need to set from [ Settings ] => [ Camera assign ] first.
If the connection fails, a message window will pop up.
5 Zoom ratio Adjust the zoom-in or zoom-out ratio via the slider bar.
6 Pan / Tilt setting Adjust the Pan/Tilt position of the camera screen.
7 Focus Select MF(manual) / AF(automatic) focus.
The focusing range is adjustable when the focus mode is set to “Manual”.
8 Preset setting Select the number first and then select [ STORE ] or [ CALL ].

4.1.2 Settings-Camera Assign

Lumens OBS Plugin and Dockable Controller - 29

No Item Function Descriptions
1 IP Address You can apply the IP of the IP Camera list or manually enter the IP.
2 Camera No. Select Camera 1~8
3 Camera Name Manually edit the camera name.
4 Apply Click to apply settings.
5 Search Click to search for Lumens PTZ Camera, click in the IP Camera list and IP will fill in the IP Address box.
6 IP Camera List List the searched Camera IP and Camera ID after click search button.

<Remark>Lumens OBS plug-in CANNOT auto-discover Lumens NDI cameras. Please manually add Lumens NDI models via IP address.

4.1.3 Settings- PanTilt limit

Lumens OBS Plugin and Dockable Controller - 30

No Item Function Descriptions
1 PanTilt limit Switch button to enable/disable PanTilt limit setting.
2 PanTilt limit setting Set PanTilt limit position.
3 PTZ Speed Comp Switch button to enable/disable the Pan/Tilt speed vary with the position of the Zoom.
<Caution> Don’t support VC-A50P and VC-BC series.

4.1.4 Settings- Preset rename

Lumens OBS Plugin and Dockable Controller - 31

Descriptions
You can edit the Preset name and click [ Apply ] to save settings.

4.1.5 View- Advance mode

Lumens OBS Plugin and Dockable Controller - 32

No Item Function Descriptions 
1 PTZF Speed Adjust the moving speed of Pan/Tilt/Zoom/Focus/Preset.
2 Exposure
  • Exposure Mode: Select exposure mode (Auto/Manual)
  • Shutter speed: The shutter speed is adjustable when the exposure mode is set to “Manual”.
  • Iris: The size of aperture is adjustable when the exposure mode is set to “Manual”.
  • Gain: The gain limit is adjustable when the exposure mode is set to “Manual”.
  • Scene Mode: Select Scene mode(Low Light/Indoor/Backlight/Motion)
Scene mode Lumens OBS Plugin and Dockable Controller - 33 Lumens OBS Plugin and Dockable Controller - 34 Lumens OBS Plugin and Dockable Controller - 35 Lumens OBS Plugin and Dockable Controller - 36
Shutter speed 1/30(1/25) 1/60(1/50) 1/120 1/180
Iris F2.0 F3.2 F4.5 F3.2
Gain 33dB 24dB 21dB 27dB
<Remark> VC-A50P does not support Gain
3 White Balance 
  • White Balance Mode: Select the White Balance mode.
    Auto (4000K~7000K)
    Indoor (3200K)
    Outdoor (5800K)
    One Push
    Manual (R Gain +/- ; B Gain +/- )
  • R/B Gain: Manually adjust blue/red gain value.
  • One Push: One push WB will be trigger when the white balance mode is set to “One Push”.
4 Image
  • Image Mode: Select the Image mode (Default/Custom)
    When the image mode is set to Custom, following items can be adjusted
  • Sharpness: Adjust the sharpness of the image.
  • Saturation: Saturation adjustment of the image.
  • Hue: Adjust the hue.
  • Gamma: Gamma Level adjustment.
  • Dig-Effect: Set the mode at which the image is turned.

(OFF/MIRROR/FLIP/MIRROR+FLIP)

4.2 OBS Dockable

4.2.1 Control window

Lumens OBS Plugin and Dockable Controller - 37

No Item Function Descriptions
1 Camera Name Show the camera name you are controlling.
2 ASSIGN PRESETS Move the camera into the position you want and click the preset button you want to assign.

Lumens OBS Plugin and Dockable Controller - 38

3 PREFERENCES Please refer to 4.2.2 PREFERENCES
4 Preset Controller Press the button to execute Preset Recall.
5 Zoom Adjust the zoom-in or zoom-out.
6 Focus Adjust the focus range.
7 Pan/Tilt/Home Adjust the Pan/Tilt/Home position of the camera screen. 

4.2.2 PERFERENCES

Lumens OBS Plugin and Dockable Controller - 39

No Item Function Descriptions
1 IP Address Enter the IP address the Camera and click [Connect] button.
2 Camera Name Modify the camera name. (Default: Camera01)
  • Camera names are limited to 1 – 12 characters.
  • Please use a camera name by mixing uppercase and lowercase letters or numbers. Do not use “/” and “space” or special symbols.
3 Setting buttons Press buttons to switch the mode.
  • Mirror– On/Off
  • Filp– On/Off
  • Motionless Preser– On/Off
  • Focus– Manual/Auto
4 Speed Adjust the moving speed of Pan/Tilt/Zoom/Focus.
5 Initial Position Select the initial position. ( Last MEM / 1st Preset)
Copyright Information

Copyrights © Lumens Digital Optics Inc. All rights reserved.

Lumens is a trademark that is currently being registered by Lumens Digital Optics Inc.

Copying, reproducing or transmitting this file is not allowed if a license is not provided by Lumens Digital Optics Inc. unless copying this file is for the purpose of backup after purchasing this product.

In order to keep improving the product, the information in this file is subject to change without prior notice.

To fully explain or describe how this product should be used, this manual may refer to names of other products or companies without any intention of infringement.

Disclaimer of warranties: Lumens Digital Optics Inc. is neither responsible for any possible technological, editorial errors or omissions, nor responsible for any incidental or related damages arising from providing this file, using, or operating this product.

Lumens logo


 

Documents / Resources

Lumens OBS Plugin and Dockable Controller [pdf] User Manual
OBS Plugin and Dockable Controller, Plugin and Dockable Controller, Dockable Controller, Controller

References

Leave a comment

Your email address will not be published. Required fields are marked *