TeamTalk VI User Manual

Introduction

Welcome to the TeamTalk VI user manual. This manual is intended to guide you through the operation of the TeamTalk VI software. The sections of this manual are organized by heading.

Recent Changes

Installation

Getting Started

Launching the Client

The Main Window

The main window is devided into six parts:

The event list

The event list is where all of the chat and system messages as well as the files on the server are displayed. Simply use the arrow keys to move up and down in the list. You can also use the home key to move directly to the top of the list and the end key to move to the bottom. Pressing "enter" or the applications key will bring an application menu pertaining to that entry.

The text input box

The text input box is where you can type in a chat message or a TeamTalk system command. When you press enter, either the command you've typed will be issued or the chat message you've typed will be displayed in the event list.

The Main Tree View

The main tree view lists any servers available within TeamTalk VI as well as any connected users on a server if TeamTalk VI is connected.

The output volume slider

This slider lets you adjust TeamTalk's output volume. You can turn the volume all the way up with the end key or all the way down with the home key. You can also increase or decrease the volume in smaller increments by using the arrow keys or the page up and page down keys.

The input volume slider

This slider lets you adjust TeamTalk's input volume. You can turn the volume all the way up with the end key or all the way down with the home key. You can also increase or decrease the volume in smaller increments by using the arrow keys or the page up and page down keys.

The voice activation threshold slider

This slider allows you to tell TeamTalk how much sound has to be coming through the microphone before it is allowed to transmit when in voice activation mode. You can turn the slider all the way up with the end key or all the way down with the home key. You can also increase or decrease the slider in smaller increments by using the arrow keys or the page up and page down keys.

Configuring Audio Settings

The Connect Dialog

The Host Manager

Adding a new TeamTalk server

If you wish to add a new TeamTalk server, you can do so via the server menu within the menu bar, via the applications menu in the tree view or by typing a command into the text box.

Connecting to a TeamTalk server

If you wish to connect to the current TeamTalk server, you can do so from the server context menu, from the server menu within the menu bar, by pressing "enter" on the currently selected server from within the tree view, by pressing f3 or by typing "/connect" followed by the server name in the text input box.

Disconnecting from a TeamTalk server

If you wish to disconnect from the current TeamTalk server, you can do so from the server context menu, from the server menu within the menu bar, by pressing f2 or by typing "/disconnect" from within the text input box.

Removing a TeamTalk server

If you wish to remove a server from your list of servers, you can do so by going into the server menu from within the menu bar, via the applications menu within the tree view, by pressing "delete" on the server you want to remove or by typing in a text command within the text input box.

The TeamTalk VI Menu Bar

The TeamTalk Menu

The TeamTalk menu contains the following options:

The Me Menu

The Me menu contains the following options:

The Users Menu

The Users menu contains the following options:

The Subscriptions Menu

The Subscriptions menu contains the following options:

The Advanced Menu

The Advanced menu contains the following options:

The Channels Menu

The Channels menu contains the following options:

The Server Menu

The Server menu contains the following options:

The Help Menu

The Help menu contains the following options:

TeamTalk VI Context Menus

Context menus function exactly the same in TeamTalk VI as they do in any other operating system. This section explains them in detail.

The Users Context Menu

The File Context Menu

The file context menu is only accessible through the event list. Simply right click on the appropriate entry to bring up this menu. The following options are available:

The Server Context Menu

The server context menu lets you perform various operations relating to servers within the main tree view. The menu contains the following options:

The TeamTalk VI Preferences Window

The General Tab

The General Tab contains the following controls:

The Server Tab

The Server Tab contains the following controls:

The Accessibility Tab

The Accessibility Tab contains the following controls:

The Window Tab

The Window Tab contains the following controls:

The Client Tab

The Client Tab contains the following controls:

The Sound System Tab

The Sound System Tab contains the following controls:

The Sound Events Tab

The Sound Events Tab contains the following controls:

The Shortcuts Tab

The Shortcuts Tab contains the following controls:

The Video Capture Tab

The Video Capture Tab contains the following controls:

The Advanced Tab

The Advanced Tab contains the following controls:

Text Commands

Text commands function similar to those used by the popular IRC protocol in that you type a slash before typing the command. If you type a command by itself without anything immediately after, the program will display the help topic associated with that command. Some text commands can be used even when you are not connected to a valid TeamTalk server.

The /account Command

The /account command allows you to add, remove or modify a specific user's account. To add an account to the server, simply type the word "add" followed by the user name and password after the command. To remove an account, simply type "remove" followed by the user name and password after the command. also, you can type "+a" or "-a" after the password to grant or deny that user administrator privileges. If the specified user account does not exist or you do not have server administrator privileges, you will be notified.

The /afk Command

The /afk command functions exactly like the /away command. Simply type the command either on its own or followed by a reason for your being away. For example, you could type something like "/afk Eating" to put the word "eating" after your away status. To remove your afk status, type "/afk" again.

The /admin Command

The /audio Command

The /audio command is used to check the status of your audio as well as that of other users. The following parameters can be typed after the command:

The "/ai" and "/ao" commands can be used in place of the "/audio input" and "/audio output" commands.

The /autojoin Command

This command lets you specify a channel that you wish to automatically join upon connection to the current server. Simply type the command followed by the channel name and the channel password if applicable. If the specified channel does not exist on the currently connected server, you will be notified. If you do not wish to join any channel upon connection, you can type "clear" after the command. The alias "/aj" can be used instead of having to type the whole command.

The /away Command

This command allows you to set your TeamTalk status as "away" and also lets you type a reason for your being away after the command. For example, you could type something like "/away Eating" to put the word "eating" after your away status. To remove your away status, type "/away" again or simply press a key on your keyboard. The /afk command can be used in place of the /away command.

The /ban Command

The /ban command allows you to ban the specified user from the current channel or from the server itself. Simply type the user name after the command. If the specified user is not in the current channel, is not on the server or you do not have channel operator privileges, you will be notified.

The /broadcast Command

The /broadcast command allows you to send a message to the currently connected TeamTalk server. Simply type the message you wish to broadcast after the command and everyone currently connected to the server will receive it. If you do not have the ability to broadcast messages, you will be notified.

The /channel Command

The /channel command lets you create, delete or modify a channel on the server. To add a channel, type the word "add" after the command followed by the channel name and password if applicable. To remove an existing channel, type the word "remove" followed by the channel name and password (if applicable) after the command. If you are not a server admin, a channel operator or the channel you want to remove does not exist, you will be notified.

The /clear Command

The /clear command simply clears the text from the events box. Be careful when you do this because the event list can not be uncleared.

The /config Command

The /config command will bring up the TeamTalk VI preferences window or allow you to change various options directly. The following commands can be used:

The /connect Command

This command lets you connect to a TeamTalk server by typing its name immediately following the command.

The /date Command

The /date command simply displays the TeamTalk server's current date.

The /deop Command

The /deop command allows you to remove the specified user's channel operator privileges by typing the user's name after the command. If the specified user is not in the current channel or you do not have channel operator privileges, you will be notified.

The /demote Command

The /devoice Command

The /devoice command allows you to remove the user's audio transmission privileges if you are within a classroom channel. Simply type the user name after the command. If you are not a channel/server administrator, the specified user does not have audio transmission privileges or is no longer within the current channel, you will be notified.

The /disconnect Command

The /disconnect command just disconnects you from the current TeamTalk server. You can also type "/leave" in place of this command. If you wish to quit the program altogether, you can use the /quit or /exit commands.

The /echo Command

The /echo command simply sends back the text typed after it. So, if you were to type /echo Hi, it would send back "Hi". If nothing is typed after the command, the help topic pertaining to that command will be displayed.

The /file Command

The "file" command lets you upload or download a file to or from the currently connected TeamTalk server. To upload a file, type "upload" followed by the path to the file you wish to upload. To download a file, simply type the name or number of the file after the command. If the file is too large, you will be notified.

The /help Command

This command will display a list of topics you can receive help about. If you type a command name after the /help command, the topic for that command will be displayed. If nothing is typed after the command, a complete list of available text commands will be displayed.

The /ignore Command

The /ignore command is a quick way to unsubscribe from all of the specified user's streams. Simply type the command followed by the name of the user you wish to ignore. To stop ignoring the specified user, type their name after the command again. If you type "all" after the command, you will ignore everyone currently connected to the server. If you type this command by itself, you will be presented with a list of users you are currently ignoring. If the specified user is not in the current channel or is not on the server, you will be notified.

The /info Command

The /join Command

The /join command allows you to join any valid channel on the current TeamTalk server. Simply type the name and password (if applicable) of the channel after the command or "root" to join the root channel. If you wish to join a channel within a channel, simply type the name of the parent channel followed by a slash and then the name of the subchannel you want to join. If the channel you wish to join is not available, you will be notified.

The /kick Command

The /kick command allows you to kick the specified user from either the current channel or the server itself. Simply type the user name after the command. If the specified user is not in the current channel, is not on the server or you do not have channel operator privileges, you will be notified.

The /leave Command

The /leave command allows you to leave the current channel. This command will move you to the parent channel or to the root channel if nothing is available. If you type this command while you are in the root channel, you will be disconnected from the current server. If you wish to disconnect from the server directly, simply use the /disconnect command.

The /loop Command

The /loop command plays the specified file until the /stop command is issued. If the file is not available or is not in a supported format, you will be notified.

The /me Command

The /me command allows you to send an emote. Simply type the command followed by the action you wish to perform. Typing /me smiles will send back "Joe smiles".

The /motd Command

The /motd command lets you set the message of the day for the server or check the current message of the day. Simply type the command followed by the message you wish to display on the server. If you are not a server admin, you will be notified.

The /move Command

The /move command lets you move the specified user to the specified channel. Simply type the command followed by the name of the user, then the name of the channel. You can also type "all" followed by the channel name to move everyone to the specified channel. If you are not a server admin or the channel you want to move the specified user to is password protected, you will be notified.

The /msg Command

The /msg command allows you to send a private message to the specified user. Simply type /msg then the user's name, followed by the message you want to send. If the specified user is not in the current channel or is not on the server, you will be notified.

The /mute Command

The /mute command lets you mute or unmute yourself, the specified user or everyone on the server. Typing the command on its own will list the parameters it will accept. Typing me will mute or unmute your microphone. Typing a user's name after the command will mute or unmute the specified user. You can also type "all" after the /mute command to mute everyone on the server. If the specified user is not in the current channel or is not on the server, you will be notified.

The /nick Command

The /nick command allows you to change your nickname on the fly. Simply type your desired nickname immediately after the command. If your desired nickname is in use, you will be notified.

The /op Command

The /op command allows you to give the specified user channel operator privileges. Simply type the user name after the command. If the specified user is not in the current channel or you do not have channel operator privileges, you will be notified.

The /play Command

The /play command lets you stream a sound file to the server. Simply type the command followed by the path to the file you want to stream. If the file is not available or is not in a supported format, you will be notified.

The /promote Command

The /question Command

The /question command sends a notification to the server indicating that you would like to ask a question. If you wish, you can type the question itself after the command and it will appear next to your name in the tree view for a brief time. You can also use /q or /? in place of this command. If the current channel is not in classroom mode, you will be notified.

The /quit Command

The /quit command closes TeamTalk VI and returns you to your computer's main operating system. You can also use /exit to accomplish the same task.

The /reply Command

This command lets you send a reply message back to the last person who sent you a private message. Simply type the command followed by the message you want to send. If that user is no longer available, you will be notified.

The /replylock Command

The /replylock command allows you to set the /reply command to send a reply message to the specified user. Simply type the user name after the command and whenever you type "/reply" followed by the message, the person whom you have specified after the /replylock command will receive it. Typing the command on its own disables the reply locking feature. If that user is no longer available, you will be notified.

The /send Command

The /send command lets you upload a file to the currently active TeamTalk server. Simply type the command followed by the path to the file that you want to upload. If the file path is invalid or the file is too large to upload, you will be notified.

The /server Command

The /server command lets you add, remove or modify information pertaining to each server in your TeamTalk VI client's main tree view. To add a server, simply type the command followed by the name of the server, the address, the TCP port and the UDP port. For examply, to add "tt.test.com" you would type something like: "/server add test tt.test.com 3300 3300" To remove a server, type the /server command followed by remove and then the name of the server you want to remove. For example, to remove the test server mensioned previously, you would type: "/server remove test" When either the add or remove commands are used, the program will assume that you really do want to add or remove the specified server so won't bring up a confirmation dialog.

The /sound Command

The /sr Command

The /sr command is a quick way to toggle on and off screen reader announcements of system events as well as messages, audio transmission, video transmission and desktop transmission. You can also type the following commands after /sr to toggle indevidual preferences.

The /stop Command

The /stop command stops the currently streaming file. If there is no file playing, you will be notified.

The /summon Command

This command moves the specified user into the current channel. Simply type the command followed by the user you wish to summon. If the user is not on the server or you do not have server administrator privileges, you will be notified.

The /time Command

The /time command simply displays the TeamTalk server's current time.

The /topic Command

The /topic command allows you to set a topic for the current channel. Simply type the command followed by the topic you wish to set. If you are not a channel operator, you will be notified.

The /unban Command

The /unban command allows you to unban the specified user from the current server. Simply type the user's name after the command. If the specified user is not in the ban list or you do not have channel or admin privileges, you will be notified.

The /update Command

This command checks for updates to TeamTalk VI. If an update is found, the program will ask you whether or not you wish to update it. If you type "yes" or "silent" after the command, the program will perform a silent update.

The /uptime Command

The /uptime command displays the TeamTalk server's current uptime. If you wish, you can type a user name after the command to display the amount of time that user has been connected to the current server.

The /voice Command

This command lets you give the specified user the privilege of audio transmission within a classroom channel. Simply type the user name after the command. If that user already has audio transmission privileges or is no longer within the current channel, you will be notified.

The /version Command

The /version command displays both the current TeamTalk server version as well as the version of the TeamTalk client you are using. If you wish, you can type a user name after the command to display which version of the TeamTalk VI client that user has on their system.

The /video Command

The /video command allows you to toggle whether or not you transmit video. You can also type one of the following parameters after the command:

You can also type a user name after the command to toggle whether or not you are subscribed to that user's video transmission.

The /who Command

This command displays a list of users in the current channel or, if a user name is typed immediately after, it will give you information pertaining to that user. The following commands can be typed immediately after the /who command to display other information:

If the user name you specify after the command is not available, you will be notified.

The /whois Command

This command displays information about the specified user such as their IP address and which channel they happen to be in when the command is typed. Simply type the user name after the command. If the specified user is not in the current channel or is not on the server, you will be notified.

The /whowas Command

This command displays user information for a user that is no longer on the TeamTalk server. Simply type the user name after the command. If there is no user information to display, the program will notify you.

Shortcut Keys

Following is a list of shortcut keys available from within the TeamTalk VI program:

Frequently Asked Questions

How do I create a new user account?

To create a new user account, follow the steps below.

  1. Press enter on the "user accounts" list option
  2. When the list appears, tab to the "add" button and press enter
  3. In the "user name" edit box, type the user name you wish to add
  4. In the "password" edit box, type the new user's password
  5. If you wish for the new user to have administrator privileges, check the "admin" checkbox
  6. Tab to the "okay" button and press enter
  7. The users list should re-appear with the new user listed at the bottom

How do I remove an existing user account?

To remove an existing user account, follow the steps below.

  1. Press alt+s to enter the server menu
  2. Press enter on the "users list" option
  3. Navigate to the user you wish to remove and tab to the "remove" button
  4. Press enter on the button and confirm the deletion prompt that appears
  5. The user list should re-appear with the user name removed

How do I ban a user from a TeamTalk server?

To ban a user, follow the steps below.

How do I unban a user from a TeamTalk server?

To unban a user, follow the steps below.

Am I able to run my own TeamTalk server?

Can I see a list of ideas that might be implemented in the near future?

Absolutely. Here is the todo list.

Why did you guys create another TeamTalk client?

The TeamTalk Vi client was created because the current developer either wouldn't or couldn't add features that we felt would be appreciated by the blind and sighted communities. This client was designed from the ground up to be completely accessible and cross platform to meet the needs of a wide range of users.

What language is this program written in?

This program was written in a language called PureBasic. We decided to use this language because it was not as complex as C or C++ and features could be added much more quickly than the current developer could add them.

You say this program is cross-platform, is this true?

To our knowledge, yes. PureBasic was designed to work with Windows, Linux and the mac operating systems. This means that we wouldn't have to write three different versions of the program for each operating system

Are there scripts that need to be downloaded to make my screen reader work with this program?

Not at all. The TeamTalk VI client was created with native screen reader support meaning that no add-ons or scripts should be needed to make the client accessible to the blind community.

Which audio codecs are supported?

As far as streaming files, which audio formats does this program support?

Why did you guys decide to add commands similar to those used by IRC servers?

We felt we could accomplish much more much faster if we had access to slash commands as in IRC. These allow us to work with accounts, audio settings and to retrieve information without needing to use menus.

Is there ever going to be an IOS or Android version of this client?

There deffinately could be if someone is willing to write both an SDK and client for thos operating systems. Not only would it open the program up to many more users, but it would speed up developement and allow us to work more closely with the TeamTalk community.

What happened to the development of the original TeamTalk client?

Why wasn't there an Android or IOS version of the original TeamTalk client?

Can I record what goes on when I connect to a TeamTalk server?

How do I move users between channels?

To move users to other channels, follow the steps below.

I am having a problem with the program, how do I report it?

Are there ever going to be add-ons I can download for this program?

Is LUA scripting going to be available in TeamTalk VI?

Is TeamTalk VI going to be available in my native language?

Absolutely. If someone is willing to translate the program into your native language, we would be more than willing to add the translation to the main program.

Getting Support

Contact Information

Credits

Program created by Erion with help from Piotr, Zack, GHorthalon and others Manual written by Jeff Rutkowski