Ventrilo - Device - Overlay
The Ventrilo client program has built in support for Hardware Overlay. For information about enabling and configuration options please see the Setup-Overlay page.
The following documentation will explain the Overlay menu features and how to interact with specific pages in the Overlay.
Menu:
To activate the Overlay menu you must first bind a key in the Binding editor by creating a key combination for the Function "Overlay" with the "Toggle/Activate Overlay Menu" selected.
All menus use the following events to scroll the highlight bar.
Up / Down arrows:
Pressing once will move the selection bar up or down one item.
Mouse scroll wheel:
Use the mouse scroll wheel to move the highlight bar up and down.
Activate Overlay Menu (key bind):
Press your overlay menu activation key again to activate the selected menu item. You can also press the left mouse button or press the Return key to activate the current selection. These different methods are provided just in case you have a bind for these keys to activate in-game features.
The main menu options available at this time are:
Display page
This option will list all of the possible display pages. Note: This list can change in size when Private Chat windows are open.
Status
This is the initial display page when the program starts. It displays your current channel name, connected or disconnected states, recording state, ping and transmitting state or Microphone mute state. It also displays the list of people you are currently receiving a voice stream from. If more than 3 are being received then the rows where this info is displayed will be split into two columns in order to display a total of 6.
The bottom section will display a list of the most recent events.
Channel clients
This is a continuously rotating list of Users that are in the same channel as you.
Events
This is a continuously scrolling list of events that have taken place, such as people connecting or disconnecting, joining leaving your channel, Integration notifications, etc.
Commanding
This is a scrolling list of the most recent Commanding messages that you have received.
Global chat
This is a scrolling list of Global chat messages that you have received.
PrvChat: {from User name}
Similar to Global chat but a unique display for each currently open Private Chat window.
Switch channels
This option will display a list of channels that you can select from. When you press the OK button the client will make the selected item the new current channel in the main window and the status page.
Kick User
This option will display a list of all Users currently connected to the server. When you press the OK button the client will kick the selected User if you have either Channel Admin rights or Server Admin rights.
Ban User
This option will display a list of all Users currently connected to the server. When you press the OK button the client will ban the selected User if you have either Channel Admin rights or Server Admin rights.
Mute User
This option will display a list of all Users currently connected to the server. When you press the OK button the selected User will either be Muted or Unmuted. This mute is local to your client only and is the same thing as right clicking on the Users name in the main window, selecting User and then clicking the Mute option.
Mute microphone
This option will toggle the "Mute Microphone" option on the main window.
Mute sound
This option will toggle the "Mute Sound" option on the main window.
Hide / Show overlay
This option will force the overlay to remain displayed, if configured in Setup-Overlay to use Popup, or to be hidden if not in Popup mode.
Move overlay
This option will let you reposition the overlay while in game, or at the desktop. Simply move your mouse around until the overlay is at the desired location and press the left mouse button, the Menu activation bind or press Return.
Options
This option will open a list of state options that control how the Overlay display will function. The following list of sub-options will be displayed.
Disp background image
This will toggle the display of the background image on and off.
Note: You can override the background image with an external PNG file if you follow these requirements.
1) File name must be OVERLAY.PNG
2) The file must be placed in the folder: $(MyDocuments)\VentriloData\Icons (in Windows)
3) You must restart the program each time you change, add or delete the file for changes to take effect.Display User picture
When enabled this feature will display images of Users that you are receiving a data stream from if you have configured images for specific User names. For more information about configuring images for Users please read the User Options window help page.
Display Users in switch channels
When using the "Menu - Switch channels" feature this option will enable or disable the display of Users in their associated channels. This can be very useful to have when you are looking to see where everyone is currently located. However, if your server has lots of channels and lots of Users at the same time then the list could become a little overbearing to traverse. Thus with this option you can toggle the User list display on and off.
Note: If you select a User rather than a channel with the OK button you will still be switched to the channel that the User is currently in, just as if you had selected their channel name instead.
Time in the title bar
When set to (Yes) this option will display a 12 hour clock in the title bar of all pages.
Help
Brings up this help document.
The following items describe each of the possible display pages. You can switch to these pages by using the Binds – Overlay – Next Page / Previous page for the Overlay Function.
Status page:
At the current time this page does not process any special key binds.
Channel clients page:
This page will cycle through all of the User names that are in the same channel as you.
At the current time this page does not process any special key binds.
Events page:
Shift + Bind Next Page / Shift + Bind Previous Page:
Will scroll the list up and down by a single item.
Ctrl + Bind Next Page / Ctrl + Bind Previous Page:
Will scroll the list up and down by an entire page of items.
Commanding page:
Shift + Bind Next Page / Shift + Bind Previous Page:
Will scroll the list up and down by a single item.
Ctrl + Bind Next Page / Ctrl + Bind Previous Page:
Will scroll the list up and down by an entire page of items.
Global chat page:
Shift + Bind Next Page / Shift + Bind Previous Page:
Will scroll the list up and down by a single item.
Ctrl + Bind Next Page / Ctrl + Bind Previous Page:
Will scroll the list up and down by an entire page of items.
PrvChat page(s):
Shift + Bind Next Page / Shift + Bind Previous Page:
Will scroll the list up and down by a single item.
Ctrl + Bind Next Page / Ctrl + Bind Previous Page:
Will scroll the list up and down by an entire page of items.
Status indicators:
( Away )
This indicates that the User associated with the currently displayed Private Chat page is no longer viewing his Private Chat window as his main focus window.
( Xmit )
This will be displayed when you press and hold the OK button or when you click and hold the “Push to talk” button in the associated Private Chat window.
( VA )
This indicates that the program is currently configured to use Voice Activation and that you will not be permitted to use the OK button to transmit a private voice stream to the other User. You must click the Setup button in the main window and then enable the “Use Push to Talk hotkey” option in the Voice tab to remove this state.
( MuteMic )
This indicates that the “Mute Microphone” option on the main window is currently enabled. When the microphone is muted you cannot use the OK button to transmit a private voice stream to the other User.
( MuteSnd )
This indicates that the “Mute Sound” option on the main window is currently enabled and you will not hear any voice stream transmitted by the User on the other end of this private chat.
( Recv )
This indicates that you are receiving a private voice stream from the currently displayed private chat page.
( M-Recv )
This indicates that you are receiving a private voice stream from the currently displayed private chat page but you have locally muted the specified User. To unmute them right click on the Users name in the main Ventrilo window - Select User - Select Mute.