Quick Overview

The Community PRO Video Chat Plugin for WordPress handles the integration between your WordPress web site and the AVChat video chat platform.

The plugin will handle the following:

  • User name integration
  • Profile url integration
  • Profile image integration
  • Placement of video chat within the web site (user and admin interface)
  • Enable/disable/limit more than 47 features for each user role
  • MultiSite support
  • BuddyPress support: BuddyPress avatars will be used and BuddyPress users profiles can be accessed directly from AVChat

All the documentation regarding the Community PRO plugin is on this page so if you’re looking for something specific use the menu on the right or search within this page by pressing Ctrl+F on your keyboard. The main AVChat documentation is here.

Installation instructions

Download & Extract archives

First, you will need the two archives downloaded from your client area:

  • AVChat 3.0 Build xxxx.zip (contains media server files for Red5/FMIS/Wowza and AVChat Standalone)
  • avchat3_wordpress_plugins_pro.zip (contains 1 plugin for WordPress 4.x)

Save and extract the archives somewhere on your computer.

Setting up the media server application

Once we’ve downloaded & unzipped everything the next thing we need to do is to setup the media server app to which AVChat will connect to.

AVChat uses a media server to send all the audio video and text data between users. AVChat supports the 3 major media servers:

  • Red5
  • Adobe Media Server
  • Wowza

Here’s how to install the avchat30 app on each one of them:

Upload the avchat30 folder from the Files to upload to your media server (Red5) folder to your Red5's webapps folder (C:\Program Files\Red5\webapps on Win, /opt/red5/webapps/ on Linux).

On Linux, chmod the new avchat30 folder to 777.

For versions of Red5 1.0.7 or higher one additional change needs to be made:

  1. Go to /Your_Red5_Install_Directory/webapps/avchat30/WEB-INF
  2. Open red-web.xml with any text editor
  3. Uncomment line 37

Restart the Red5 server.

Upload the avchat30 folder (you will find it in your AVChat archive in the Files to upload to your media server (FMS) folder) to the applications folder of your AMS installation.

On Linux, chmod the new avchat30 folder to 777.

Upload the applications, lib and conf folders from the Files to upload to your media server (Wowza) folder to the root folder of your Wowza Media Server installation.

Restart the Wowza server.

Plugin Installation

To install the plugin, you will need to be logged in as admin on your website. Once logged in:

  1. Go to the Plugins page, section Add New in your WordPress backend:

  2. Press the Upload Plugin button:

  3. Press Choose File and select the avchat3_wordpress_plugins_pro.zip file:

  4. Press Install Now and wait for the setup to finish:

Before activating the plugin, you will have to upload the AVChat client files on your server. To do so, you will need FTP (or SFTP) access to your server.

If you are not sure how to access your server using FTP, it's better to contact your Hosting Company.

Go ahead and open your favorite FTP Client. Navigate to /wp-content/plugins: You should see a new folder called avchat-3-pro. Open it.

Also open the folder on your computer containing the AVChat client files (the ones from the AVChat 3.0 Build xxxx.zip archive): Copy all the files in the Files to upload to your website folder inside the avchat-3-pro folder:

Make sure you change the permissions on the tokens and uploadedFiles folders to 777:

Complete Installation

You can now activate the plugin. Once activated, a new page is added in your WordPress Dashboard: Video Chat PRO.

Connect AVChat to the media server app

You need to insert the connection string. The connection string has the following form:

rtmp://your_media_server_ip/avchat30/_definst_

Add your connection string in the Connection string field:

Scroll down and press Update Options

Enter the chat, connect and insert the license key

Now go to Enter Chat to access the chat interface:

You will be asked for the license key. You can get your license key from your client area:

The installation is complete and you should be able to see the chat interface:

Embed the chat

In order for your users to access the chat, it must be accessible from a page on your website. The Community PRO plugin will allow you to embed the chat easily, using a shortcode in a post or page.

To embed the chat in a page:

  1. Go to the Pages section in your Wordpress Dashboard:
  2. Press Add New and give your page a title.

  3. Add the [chat] shortcode in your page body and press Publish:

Going to this page will allow you and your users to access AVChat:

Plugin Features

User roles and permissions

The Community PRO plugin for WordPress allows you to control permissions for each user role. By default, there are 5 user roles predefined on every WordPress installation:

  • Administrator
  • Editor
  • Author
  • Contributor
  • Subscriber

You can also handle permissions for non-registered users (visitors).

  • In your WordPress Dashboard, go to Video Chat PRO > Settings.
  • Select the User roles & Permissions tab.
  • Here you can enable or disable any permission for each user role
  • Once you are done setting up the permissions, don’t forget to press the Update Options button.

For example, if you want to disable access for visitors, you will have to uncheck the Can access chat box under Visitors:

Admin access

The admin interface is visible to all the users that have the permission to access it (see User Roles and Permissions).

If you access the chat from a page in which AVChat is embedded, the integration plugin will automatically detect if the user has access to the admin interface, and will show it accordingly.

If you access the chat from your WordPress Dashboard (Video Chat PRO > Enter Chat), you will get access to the admin interface.

AVChat files location

All the files are in the /wp-content/plugins/avchat-3-pro/ folder.

Opening method

By default, AVChat will be embedded where you place the [chat] shortcode. However, you have the possibility of opening AVChat in a popup window.

To do so, go to Video Chat PRO > Settings and find How AVChat opens.

Change the opening method to Popup and press Update Options.

Facebook Login

To enable Facebook Login you will need to create a Facebook Application from where you will receive an App ID. You can follow the next steps to accomplish this.

  1. Go and Register as a Developer at: http://developers.facebook.com
  2. Click Create New App
  3. Insert your application name (App Name), select the category and press Create App
  4. After pressing the Create App button you will be redirected to the application page where you will find the App ID. Don’t forget to enter your website URL in Website with Facebook Login

  5. Now that you have your Facebook App ID, in your website, go to your WordPress Admin > Video Chat PRO > Facebook & Twitter Login tab
  6. Insert your Facebook App ID
  7. Press Update Options

Twitter Login

To enable Twitter Login for your video chat you will need to create a Twitter Application that will provide you with a Consumer Key and an Consumer Secret. You can follow the next steps to accomplish this.

  1. Go to https://dev.twitter.com/apps and click on the Create a new application button.
  2. Complete the form:
    • Name - enter the name of your application
    • Description - insert the description
    • Website - enter your website URL
    • Press Create your Twitter application!

  1. After you completed the form you will be redirected to the application page, where you will find your Consumer key and Consumer secret.
  2. Now that you have your Consumer key and Consumer Secret, in your website, go to your WordPress Admin > Video Chat PRO > Facebook & Twitter Login tab
  3. Insert your Consumer key in Twitter Consumer Key option and Consumer secret in Twitter Consumer Secret
  4. Press Update Options

Updating the plugin

First you should download the new archive from your client area on nusofthq.com

Then we need to remove the old version. While logged in as and admin in the WP backend go to Plugins and click Deactivate followed by Delete for the AVChat Community PRO plugin. This will remove the wp-content/plugins/avchat-3-pro folder and all its contents.

Warning! This will also delete the chat client so make sure you make a backup before updating

You will now have to re-install the plugin and upload the AVChat 3 client side files again to the wp-content/plugins/avchat-3-pro folder.

Any existing settings or permissions will be kept. Any new settings or permissions added by the new version will most probably be empty, make sure you configure them as you wish for each user role from Video Chat PRO > User Roles & Permissions tab.

Removing the plugin

While logged in as and admin in the WordPress backend go to Plugins and click Deactivate followed by Delete for the AVChat Community PRO plugin.

This will remove the wp-content/plugins/avchat-3-pro folder and all it’s contents.

The plugin’s database holding the permissions for each user role and general settings will still remain tough. To remove it, delete the wp_avchat3_general_settings and the wp_avchat3_permissions tables.

You might also want to remove the page holding the [chat] tag that was replaced by the plugin with the AVChat 3 software

Multisite support

WordPress has a special mode called Multisite. This mode has been introduced in 2010 in WordPress 3.0.

Starting with build 2359, the plugin adds support for installations of WordPress with multisite on.

A new WP user role is present in multisite setups:

Super Admin – somebody with access to the site network administration features and all other features. In such an installation the plugin can either be network activated for all sites or individually activated.

After installation, the super admin can network activate it for all the websites or he can activate it individually for each of his websites.

If My Sites > Network Admin > Dashboard > Settings > Network Settings > Enable administration menus > [ ]Plugins is checked then other network users can independently activate it for their websites too.

Network Activation

When the plugin is network activated, it can not be individually deactivated.

When the plugin is network activated you must visit the Settings > Video Chat PRO page for each of the websites in the network for the permissions tables for AVChat3 to be created. Otherwise in the front end you will find the following error:

Warning: Invalid argument supplied for foreach() in /home/observer/public_html/wp-content/plugins/avchat-3-pro/avchat3.php on line 86

When using a standard WordPress installation (non multisite) or when individually activating the plugin for each sub site in the network the tables are created at activation.

Network Users

When used in a multisite setup, the plugin will show a new column (role) in the Settings > Community PRO area called Network users. These are users who belong to the network but they do not belong to any other website on the network other than their own. They have no role in other websites than their own.

Permissions and Settings

Each site on the network can control the permissions and settings individually. This also means that each site on the network has to have their own connection string. It is possible for 2 or more websites to use the same connection string, in this case they will share the rooms and users list,etc. .

Extended short code functionality

To display AVChat 3 in your WordPress page or posts, you will use the short code [chat].

You can extend the functionality of short code by adding the following options:

  • dropInRoom:r0 - this option allows you to define the rooms ids (r0, r1, r2 etc) in which users will be droped when entering the chat
  • showOnlyRooms:r0 - this options allows you to define the rooms that users will be able to see
  • roomsListEnabled:1 - you can disable (0), enable (1) or hide (2) the rooms list button in the top bar

Community PRO for WordPress and GPL

The AVChat Video Chat Plugin is licensed under the GPL v2 or later. Once you buy the plugin you can modify it and distribute it as long as you keep it under the GPL.