Documentation
PDFOSC Companion Module
Introduction
This module integrates the PDFOSC viewer with Bitfocus Companion. </br> Enables bi-directional OSC communication for remote control and monitoring of PDF documents. </br> <b> To avoid confusion during live events, OSC feedbacks are restricted to Presentation Mode ON.</br> This prevents non-active machines from sending feedback that could be mistaken for the live source. </b></br>
Module Configuration
Configure the following settings for the module:
- Remote IP: Address of the PDFOSC machine (default: 127.0.0.1)
- Remote Port: Port PDFOSC listens for actions (default: 55550)
- Listen Port: Port Companion listens for feedbacks from PDFOSC (default: 55551)
Available Actions
This module provides the following actions to control your PDF documents:
| Action | Description |
|---|---|
| Next | Navigate to the next page |
| Previous | Navigate to the previous page |
| First Page | Jump to the first page of the document |
| Last Page | Jump to the last page of the document |
| Enter Presentation Mode | Switch PDFOSC into fullscreen presentation mode |
| Exit Presentation Mode | Exit from fullscreen presentation mode |
| Toggle Presentation Mode | Switch between normal and presentation modes |
Feedback Functions
These feedbacks indicate the state of your document:
| Feedback | Description |
|---|---|
| Current | Shows the current page number |
| Total | Shows the total pages number of the document |
| State | Shows the state of Presentation Mode |
| Test | Shows 99/99 and Green Background in Current/Total pages |
Variables
The module provides these variables for use in buttons and other modules:
| Variable | Description |
|---|---|
| Current | Current page number |
| Total | Total pages number |
| State | State of Presentation Mode (Normal, Presentation, Exited) |
| isPresentation | Indicates if presentation mode is active (Yes/No) |
Presets
Ready-to-use presets are included for common functions:
- Navigation Controls: Previous/Next page buttons, First/Last page buttons
- Page Counter: Displays current page and total pages
- Presentation Controls: Toggle button that changes function based on presentation mode state
Using with PDFOSC
This module requires the PDFOSC PDF viewer application to be installed and running on your target machine(s). Please ensure:
- PDFOSC is properly installed and running
- Network connectivity exists between Companion and the PDFOSC machine
- The ports configured in this module match those in PDFOSC
- Pressing Test button in PDFOSC Config Page, will send 99/99 and Green background to "Current/Total pages" button
- <b>OSC feedbacks will be enabled only when Presentation Mode is active, Action and Test functions are always enable.</b>
For information about installing and configuring the PDFOSC application, please visit: PDFOSC GitHub Repository
Troubleshooting
| Issue | Solution |
|---|---|
| Cannot connect to PDFOSC | Check IP address, ports and ensure PDFOSC is running |
| Cannot connect to PDFOSC | Check network connectivity and firewall settings |
| Actions not working | Confirm a PDF document is open in PDFOSC |
| Actions not working | Verify Remote IP and port settings match PDFOSC configuration |
| No feedback from PDFOSC | Verify listen port setting matches PDFOSC configuration |
| No feedback from PDFOSC | Is PDFOSC in Presentation Mode ? |
Support
For additional help with this module:
- Check the full documentation
- Report issues to the GitHub issues page
About
This Companion module is maintained by ChiliBytes