MLMediaStream Plugin

From Cinemar Wiki
Jump to: navigation, search

System Requirements


1 Ghz Pentium or Athlon processor

512 MB RAM

English version of Microsoft Windows 2000 or higher

10MB of free hard drive space

100% Windows compatible mouse

About MLVideoStream


What is MLVideoStream? MLVideoStream is a powerful video streaming application designed for the MainLobby suite of products. It dynamically expands the capabilities of MainLobby by providing a video streaming environment. MLVideoStream can be installed on the same machine as a MainLobby Server 3 or a separate computer on the network.

Installation and Setup

MainLobby suite base components are MainLobby Client and MLServer. You should install MLServer first. After MLServer installation, start the server and then install MainLobby Client. MLServer and MainLobby Client can be installed on the same PC, or on different PCs. After installation of MainLobby Client and MLServer 3, you can then install MLVideoStream.

This section will guide you through the basic installation and setup of MLVideoStream.

How to download MLVideoStream:

To download Cinemar MLVideoStream, use the following URL and place the MLServer program file in the same folder created above. MainLobby 3 requires MLServer 3 or newer.

1. Once you’ve downloaded MLVideo3, Open the MainLobby Software folder you created earlier (Figure 1-1). Figure 1-1

MLVideo 3 program files in ZIP compressed format.

2. Double-click on the file and uncompress the contents into the same folder (Figure 1-1). IMPORTANT: The MainLobby suite of applications comes compressed in ZIP format. If you are running Windows XP or later, ZIP file support is built into the Operating System. If you have an older Operating System such as Windows 2000 or if you are unfamiliar with ZIP, please visit the following URL: You should now have a new file called MLVideoStream_Setup.exe in your MainLobby Software folder (Figure 1-2). Figure 1-2 MainLobby setup.exe file.

3. Double-click on the MLVideoStream_Setup.exe to initiate the MLVideo3 Server installation. You will be greeted by the MLVideoStream Server Setup Welcome screen (Figure 1-3). Figure 1-3 MainLobby Setup Welcome screen.

4. If you have never installed MLVideoStream before and HAVE a license code, check "Licensed Mode". If you are demo'ing the software and DON'T have a license code, check "Evaluation Mode". If you have already Activated MLServer and now want to Upgrade to a newer version that you just downloaded, check "Upgrade Mode". Click Next.

5. Read the Welcome screen and ensure all other Windows applications are closed. Then click the Next button. The Licensing Agreement screen appears (Figure 1-4). Figure 1-4 License Agreement.

6. Read all terms of the Licensing Agreement. If you agree to them, accept by clicking Next. The Destination Selection screen appears. Note: It is recommended that you leave the destination path at the default setting of C:\Program Files\MLServer (Figure 1-5). Figure 1-5 Default Destination Folder.

7. Click Next to proceed to the Plugin install options screen (Figure 1-6). Select which plugins you will use. IMPORTANT: Take the time to review the list of plug-ins and deselect any plug-in you don’t intend to use. For a detailed description of each plug-in included with MLServer, see the end of this guide. Figure 1-6 Plugin Install Options screen.

8. Click Next to proceed to the Start Menu Folder options screen (Figure 1-7). Figure 1-7 Start Menu Folder Name.

9. Click Next for the Select Additional Tasks screen (Figure 1-8). Figure 1-8 Installation Confirmation

10. Click Next for the final setup confirmation screen (Figure 1-9). Figure 1-9 Installation Confirmation

11. If you are satisfied with your choices, click the Install button. The MainLobby files will now be copied to their respective directories.

12. The final screen will appear. You can select the See What's New to view MLVideo3 application updates. Leave Launch MLVideoStream checked and select Finish. MLVideo3 will automatically launch. Figure 1-10 Clicking Finish will complete the installation process.

Overall Architecture Diagram of MainLobby and MLVideoStream

MainLobby 3 works with the MLServer 3 software in a “client / server” architecture. MainLobby3 client is what you “see” and interact with and MLServer 3 software performs the “actions”. The two work as a pair. MainLobby 3 client and MLServer 3 software can be installed on the same or on different PCs (see diagram X). You can also have multiple MainLobby 3 clients connected to one MLServer (dependent on software licensing). MLServer 3 contains “plugins” or software that is designed to interact with 3rd party software (like TheaterTek DVD player software) or automation hardware (like an ELK alarm system). This architecture design allows for very powerful and complex setups that reuse existing 3rd party hardware for cost effectiveness. You can also find additional “architecture” slides here.

Interface Introduction

Before you get started with MLVideoStream, it’s helpful to take a look around the Interface and begin to familiarize yourself with its tools.

Enhanced User Interface

MLVideoStream sports a new multi-document user interface; MLVideoStream 0.0.3 (alpha build) Instructions


• Run setup.exe

• You should install the latest flash plugin ( (flash9.ocx is included in the installer for development- public distribution requires adobe permission)

• If streaming is desired install the Flash Media Server 2.0 (flash media server does not need to be on the same machine as MLServer)

- The developer edition is free for non-commercial use and limited to 10 streams - click on "free developer edition"- install per adobe instructions

- Create a directory under the flash media server applications directory. The name is of your choice (e.g. livecast) and you need nothing in the directory.

for example create:

c:\program files\macromedia\flash media server 2\applications\livecast - You can test the functionality of Flash Media Server using the flash_stream_broadcaster.exe & flash_stream_receiver.exe programs. In the broadcaster program enter the server address and give the stream a name. The server address will have the format rtmp:// (or whatever you used instead of livecast). The stream name can be anything, and is case sensitive. To select which video source is streamed, right click on the video window and click the camera tab.

This is also an easy way to see which video devices are available on your system. In the receiver program enter the same server address name & the same stream name, you should see the stream.

Open MLVideoStream from the mlserver plug-ins panel to examine the features

• On the top left is the list of video devices. Simply click on one to experiement with it. Note the index number of the device to the left of it's name. This will be used to identify the device in an MLServer Cmd.

• You can click the preview check box to see video.

• If the device is a tuner, you can click the tuner button to see various properties defined by the manufacturer's device driver

• A crossbar is a device for selecting between video and audio inputs. If a crossbar is available (determined by the manufacturer) click the crossbar button. Note the index of each input - this index may be used later to select which input to view or stream

• To try broadcasting a stream, click the stream test check box. Enter the server name (as described above) and a stream name. You may change other properties and then click start. The bandwidth option allows you to cap the maxiumum bandwidth consumed (quality will degrade accordingly). Setting bandwidth to 0 indicates unlimited bandwidth. Set quality from 1 - 100 % to determine the video quality

MLServe Commands

• To set the Channel. <device> is the index of the device as seen in the "Video Devices" list MLServeCmd.MLVideoStream|SetChannel~<device>~<channel> MLServeCmd.MLVideoStream|ChannelUp~<device> MLServeCmd.MLVideoStream|ChannelDown~<device>

• To change the video input. <input pin> is a pin number determined from the crossbar settings page. If there is no crossbar, this has no effect MLServeCmd.MLVideoStream|VideoInput~<device>~<input pin>

• To start a video stream from MLServer: MLServeCmd.MLVideoStream|Stream~<device>~<server address>~<stream name>~<microphone num>~<width>~<height>~<fps>~<bandwidth>~<quality> <server address> is the Flash Media Server address e.g. rtmp:// <stream name> is an unique name for the stream <microphone num> is the number of a microphone if you want to stream audio also. Available mics can be seen by right-clicking on the video window in the flash_stream_broadcaster.exe application provided other parameters are described above To stop the stream MLServeCmd.MLVideoStream|StreamStop~<device>


• An example flash movie called receiver.fla is located in the MLVideoStream subdirectory under plug-ins. See this simple example to create a stream viewer you can place in main lobby

• Only one process can view a video device at a time. Therefore, if you are using a video window to view a device in an instance of main lobby, it cannot be streamed from ML server. However, a video stream can be viewed by any number of clients (within the license constraints of Flash Media Server, 10 for the free edition). In fact, if you expose your flash media server to the internet, it can be viewed anywhere - either within Main Lobby, using the flash_stream_receiver.exe program, of by creating your own stream viewer in a flash application • stream_window_dynamic.swf is another preconfigured flash movie that works within MainLobby client. Recommended install directory is the MainLobby\swf directory. This object allows the user to specify the rtmp adress and Stream Name in the label field. The Label Field should look something like this: rtmp_address,StreamName So for example: rtmp://,Stream1