capture station telnet controller manual -...

5.1 | June 2011 | 3725-75105-001/A

Capture StationTelnet Controller Manual

© 2011 Polycom, Inc. All rights reserved.

Polycom, Inc.4750 Willow RoadPleasanton, CA 94588-2708USA

No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Polycom, Inc. Under the law, reproducing includes translating into another language or format.

As between the parties, Polycom, Inc., retains title to and ownership of all proprietary rights with respect to the software contained within its products. The software is protected by United States copyright laws and international treaty provision. Therefore, you must treat the software like any other copyrighted material (e.g., a book or sound recording).

Every effort has been made to ensure that the information in this manual is accurate. Polycom, Inc., is not responsible for printing or clerical errors. Information in this document is subject to change without notice.

ii

Trademark Information

Polycom®, the Polycom “Triangles” logo, and the names and marks associated with Polycom’s products are trademarks and/or service marks of Polycom, Inc., and are registered and/or common-law marks in the United States and various other countries.

Other product and corporate names may be trademarks of other companies and are used only as a fair use reference without intent to infringe.

Patent Information

The accompanying product may be protected by one or more U.S. and foreign patents and/or pending patent applications held by Polycom, Inc.

Open Source Software Used in this Product

Polycom Accordent Capture Station contains—in part—open source software, software licensed in a way that allows you the freedom to run, copy, distribute, change, and improve the software.

You can receive the open source software from Polycom up to three (3) years after the distribution date of the applicable product or software at a charge not greater than the cost to Polycom of shipping or distributing the software to you.

For a list of the available open source software, as well as related license and copyright information, you can contact Polycom at the address listed below, or see "Polycom VCM&D OFFER of Source for GPL and LGPL Software Open Source Code " available at:

http://downloads.polycom.com/network/vcmd/offerForSourceVCMDProducts.html

To receive software information, as well as the open source software code used in this product, contact Polycom by regular mail or email at:

Polycom VCM&D Open Source Manager300 N. Continental Blvd. Suite 200El Segundo, CA 90245 USA

E-mail: DL-OpenSource Video <[email protected]>

Polycom, Inc. i

Contents

1 Introduction

2 Logging In

3 CommandsHelp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–1Get ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–2Get Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–2Get Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–2

Status Return Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–3Interface ID (Number) Return Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–3UserName Return Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–3ManualCapture Return Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–3Break Return Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–3

Get Last Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–3Get Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–4Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–5Logout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–5Get Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–6Set Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–6Get Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–7Set Tag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–7Start Capture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–8

Optional Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–8Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–9CommandInfo Return Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–9

Stop Capture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–9Optional Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–10Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–10CommandInfo Return Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–10

Get Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–10Send Sync . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–11Capture Auto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–12

CommandInfo Return Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–12Capture Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–12

CommandInfo Return Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–12Capture Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–13

CommandInfo Return Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–13

Capture Station Telnet Controller Manual

ii Polycom, Inc.

Break In . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–13Break Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–13Quit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3–14

4 Sample Presentation

Polycom, Inc. 1–1

1Introduction

The telnet controller that has been integrated with the Capture Station enables other services to tap into the telnet controller to send remote commands. This manual discusses what functionality is available through the telnet controller and what information can be remotely retrieved from a Capture Station.


1–2 Polycom, Inc.

Polycom, Inc. 2–1

2Logging In

When you first telnet into a Capture Station through a command prompt you will asked for your login information (See Figure 1-1).

Figure 2-1

The login information is specified directly from the Capture Station Administrative Settings, under the Screen Capture tab (See Figure 1-2). Without the Telnet Controller Enabled selected, you will not be able to gain access to the Capture Station through telnet.

Figure 2-2

After you have entered your login information you will be notified that you are now connected (See Figure 1-3).

Figure 2-3


2–2 Polycom, Inc.

Polycom, Inc. 3–1

3Commands

There are many commands available for the Capture Station through the telnet controller. To access the list of commands available, type Help.

Help The Help menu displays a list of commands available from the telnet controller (See Figure 2-1).

Figure 3-1

On the left side of the screen you will see the commands themselves and the syntax to utilize the commands. On the right side of the screen you have an explanation of what the command does and the general layout of the information displayed. At the bottom of the list you will notice a message that says "* commands = Protected Commands Require Login", which means that if you have security users on your Capture Station, you will need to first log in to the Capture Station in order to utilize the commands with an asterisk next to it.

At any point you can type Help to access this menu.


3–2 Polycom, Inc.

Get ID The Get ID command is used to retrieve the name associated with the Capture Station you are connected to through telnet (See Figure 2-2).

Figure 3-2

As you can see, when the getid command is entered, you receive the id of the Capture Station in quotes.

Get Version The Get Version command is used to retrieve the version of the Capture Station software which is being run on the machine you are connecting to (See Figure 2-3).

Figure 3-3

When this command is used you will see the version number in quotes. This example shows the version of the Capture Station software is version 2.0.

Get Status The Get Status command is used to show the current status of the Capture Station. The status includes whether the Capture Station is started or stopped, the id for the interface being used, who is logged into the Capture Station as well as whether or not manual capture and break in/out are enabled. The output of this command is in three parts as shown below (Also See Figure 2-4).

Figure 3-4

If any of these options do not have a value you will see an open and close quote “ “. For example, if no one is logged into the Capture Station the getstatus command may return the following.

"Stopped", "2", "", "false", "false" >getstatus

Commands

Polycom, Inc. 3–3

"<Status>", "<Interface ID>", "<UserName>", "<ManualCapture>", "<Break>"

Status Return Values • Stopped: Capture Station is not running and is idle.

• Loading: Capture Station is preparing to start by loading settings/profile, transferring files, starting encoders, etc.

• Running: Capture Station has completed loading and is running a presentation.

• Stopping: Capture Station has been instructed to stop and is transferring media/files to enable the presentation for on-demand mode.

• Settings: Capture Station has the Administrative Settings window loaded/shown.

Interface ID (Number) Return ValuesThis can be any number from 1 to xx, where xx is the total number of interfaces/skins.

UserName Return ValuesThis is the current user/profile name that is logged in and is optional. This value will be empty if there is no user logged in.

ManualCapture Return Values• true: Manual Capturing is ON.

• false: Manual Capture is OFF.

Break Return Values• true: Break-IN is ON.

• false: Break-IN is OFF.

Get Last Error The Get Last Error command is used to see the last error which the Capture Station produced. This command can be useful if you have a problem starting or stopping a presentation, this will allow you to see what the cause was. If there have been no errors, this command will send empty quotes (See Figure 2-6).


3–4 Polycom, Inc.

Figure 3-5

Generally speaking, if you receive empty quotes, your presentation did not run into any issues with regards to the Capture Station software.

An example of an error which could keep your presentation from starting is as follows (See Figure 2-7).

Figure 3-6

This means that the Capture Station could not sense a feed going into the Vision RGB card.

Get Users The Get Users command is used to access the list of people set up in the security tab of Capture Station. This option is outputted in three sections as seen below (Also See Figure 2-8):

>getusers "<Name>", "<Type>", "<Password Required>"

Figure 3-7

• Name is the name given to the user in the Security section of Capture Station.

• Type is whether the user has administrative or presenter access to the Capture Station.

• Password Required is whether or not the user has a password associated with them. If there are no users in the Security section, this command will output empty quotes.

Commands

Polycom, Inc. 3–5

Login The Login command is used to log in to the Capture Station if you have Security accounts set up. The proper login method is as follows:

>login <name>, [password]

If you do not use the correct syntax, you will be shown the correct syntax (See Figure 2-9).

Figure 3-8

After you have entered in your login information correctly, you will be shown that you are now logged into the Capture Station (See Figure 2-10). If you do have Security accounts setup, you will need to be logged into the Capture Station to access all of the commands.

Figure 3-9

In this example the password section is empty because this user does not have a password associated with their login. As you can see, however, we are now logged into the Capture Station.

Logout The Logout command is used to log out of the Capture Station. If you logout successfully you will see the following message (See Figure 2-11).

Figure 3-10

If you are not logged into the Capture Station when you submit the log out command, you will be shown that the logout was not successful (See Figure 2-12). In the scenario, where you were never logged in, the message is to be expected.


3–6 Polycom, Inc.

Figure 3-11

Get Interfaces The Get Interfaces command is to retrieve the list of interfaces available from the Capture Station. This option is outputted in three sections (See Figure 2-13).

>getinterfaces "<Interface ID>", "<Interface Style>", "<Specific Interface>"

Figure 3-12

If you have Security accounts, this command can only be used if you have logged in. If you try to use this command without being logged in, you will receive the following message (See Figure 2-14).

Figure 3-13

Set Interface The Set Interface command is used to specify which interface you would like to use for the presentation.

The syntax for this command is as follows (Also See Figure 2-15): >setinterface <Interface ID>

Figure 3-14

After you have successfully set an interface, it will now be set for when you start a presentation. If you type getstatus now, you will see your newly selected Interface ID.

Commands

Polycom, Inc. 3–7

Get Tags The Get Tags command is used to see the Meta Data associated with the presentation. You will also be able to see any extra information associated, for example, logo banners and email addresses. When you type gettags, you will see each tag and the information specific to that tag (See Figure 2-16).

Figure 3-15

The text surrounded by <<@ @>> are the tags themselves. The text that follows the tags, between the quotes, is the title of the tag, an explanation of what data is being asked for, the meta data set for those tags.

<<@tag@>>, "Title", "Explanation", "Meta Data"

Example:

<<@speaker@>>: This is the tag name.

"Speaker(s)": This is the Title of the tag.

"Please enter the Speaker(s) name": This is the explanation of the data being asked for.

"Brian": This is the meta data set for the tag. This means that "Brian" will be shown in the Presenters section of the presentation.

Set Tag The Set Tag option enables you to change the information associated with a given tag for your presentation.

The syntax for the settag command is as follows (Also See Figure 2-17):

>settag <TagName>, <TagValue>

(Example: >settag <<@speaker@>>, Brian)

Figure 3-16


3–8 Polycom, Inc.

Start Capture The Start Capture command is used to start the presentation remotely. When you type this command it will take a few moments to let you know whether you have successfully started the capture or not, you will know the attempt has been either successful or not by the message that is displayed (See Figure 2-18 and 2-19 respectively)

Figure 3-17

Figure 3-18

If you attempt to start a capture has been unsuccessful, you can use the get last error command to help troubleshoot the reason the capture did not start.

>startcapture [Wait], [FolderName], [OverwriteFolder] <CommandInfo>

Optional Parameters

Wait

• true (default) = Wait for the Capture Station to completely start before allowing additional telnet commands.

• false = Do not wait for Capture Station to completely start, before allowing additional telnet commands. This is equivalent to a background start.

FolderName

This is the Folder Name to publish the presentation into. It can be a single folder name or include sub-folders as well, for example, classes\english\101

OverwriteFolder

• true = Overwrite the specified presentation folder name even if it exists in the Capture Station Work Folder.

• false (default) = If the specified presentation folder name exists in the Capture Station Work Folder, then do not overwrite the folder, do not start the presentation, and display the following error message:

StartCapture Failed

If StartCapture Failed due to an overwrite error, the following will be displayed when running the getlasterror command:

Specified Folder Name already Exists

Commands

Polycom, Inc. 3–9

Defaults Wait = true

FolderName = "" (auto-generate when blank, using date/time stamp)

OverwriteFolder = false

CommandInfo Return Values

StartCapture Successful

Capture Station has started and is in a running state.

StartCapture Failed

Capture Station was unable to start. Use the getlasterror command to retrieve detailed error message(s).

StartCapture In Progress

Capture Station has been sent a start command and is running the command in the background. Use the getstatus command to retrieve the start status. If the status is Stopped, then use the getlasterror command to retrieve detailed error message(s).

Stop Capture The Stop Capture command is used to stop the presentation that is currently in progress (See Figure 2-20).

Figure 3-19

Similar to the Start Capture command, if you receive a "StopCapture Failed" message, you can use the get last error command to help troubleshoot (see section 2-5).

>stopcapture [Wait] <CommandInfo>

Optional Parameters

Wait

• true (default) = Wait for the Capture Station to completely stop before allowing additional telnet commands.


3–10 Polycom, Inc.

• false = Do not wait for Capture Station to completely stop, before allowing additional telnet commands. This is equivalent to a background stop.

Defaults Wait = true

CommandInfo Return ValuesStopCapture Successful: Capture Station has stopped and is in not in a running state.

StopCapture Failed: Capture Station was unable to stop, possibility due to not being started. Use the getlasterror command to retrieve detailed error message(s).

StopCapture In Progress: Capture Station has been sent a stop command and is running the command in the background. Use the getstatus command to retrieve the stop status. If the status is not Stopping or Stopped, then use the getlasterror command to retrieve detailed error message(s).

Get Link The Get Link command is used to access the URL that has been generated for the presentation you have created (See Figure 2-21).

Figure 3-20

This is a command that requires you to be logged in if you have security accounts in place. If you see empty quotes, that means there is no URL available for the presentation yet. This generally occurs when you have not yet started a presentation.

Send Sync The Send Sync command is used to remotely send a synchronization to the Capture Station.

This command accepts only URLs pointing to image files already existing on the server that you specify in the URL. This option will not be used regularly and is only for rare instances where you would like an additional image that will not be captured by the RGB card.

Commands

Polycom, Inc. 3–11

The syntax for this command is as follows (Also See Figure 2-22):

>sendsync <URL>, [Region]

where [Region] is the location in the skin where images are synchronized.

In most interfaces there is one region, so you can use the number 1. In the instance that your interface has multiple regions, please refer to the image preview from the Capture Station directly to verify the region you want to synchronize to. It is in brackets is because this is an optional field. You do not have to enter a region if you do not want to. With a skin that has only one region, if you leave the [Region] entry blank it will synchronize to the solitary region.

Figure 3-21

An example of a URL sync is as follows (See Figure 2-23).

Figure 3-22

If you are unsuccessful in sending a remote synchronization you will receive the following message (See Figure 2-24).

Figure 3-23

The sendsync command requires you to be logged in if you have security users in place.

Capture Auto The Capture Auto command switches the Accordent Capture Station to automatically scan for motion changes and capture slides/images based on the motion profile that is in use. (See Figure 2-25).

Figure 3-24

>captureauto "<CommandInfo>"



CommandInfo Return ValuesCaptureAuto Successful: Capture Station is now scanning for motion changes in the slide source and has turned off the Manual Capture.

CaptureAuto Failed: Capture Station was not able to change the Manual Capture state. This could be because the presentation has not started. Use the getlasterror command to retrieve detailed error message(s).

Capture Manual The Capture Manual command switches the Accordent Capture Station to cease the automatic scanning and move to manual captures. With this option set, the main screen of the Accordent Capture Station will warn you that you are in Manual Capture mode. The manual image can be taken from either the Show Capture window or from the CaptureScreen telnet command. (See Figure 2-26).

Figure 3-25

>capturemanual "<CommandInfo>"

CommandInfo Return ValuesCaptureManual Successful: Capture Station is no longer scanning for motion changes in the slide source and has turned on the Manual Capture.

CaptureManual Failed: Capture Station was not able to change the Manual Capture state. This could be because the presentation has not started. Use the getlasterror command to retrieve detailed error message(s).

Capture Screen The capture screen command enables you manually to trigger the Accordent Capture Station to take a screen capture. This option is primarily used when the Manual Capture method is in use. This command can run successfully no matter what state the Manual Capture is set to. This enables one to force a screen capture at anytime.

>capturescreen "<CommandInfo>"

Commands

Polycom, Inc. 3–13

CommandInfo Return ValuesCaptureScreen Successful: Capture Station has captured a screen image/slide successfully.

CaptureScreen Failed: Capture Station was not able to capture a screen image/slide. This could be because the presentation has not started. Use the getlasterror command to retrieve detailed error message(s) .

Break In The break in command sets a break in point for your presentation. The combination of a break in and out will enable you to remove the portion of a presentation that is between the break in and out points after you have edited the presentation in PresenterPLUS. You will see the break in time on the main screen of the Accordent Capture Station.

Enable Break In/Out must be selected in the Administrative setting for this command to work. (See Figure 2-28).

Figure 3-26

Break Out The break out command sets a break out point for your presentation. The combination of a break in and out will enable you to remove the portion of a presentation that is between the break in and out points after you edited the presentation in PresenterPLUS. You will see the break in time on the main screen of the Accordent Capture Station.

Enable Break In/Out must be selected in the Administrative setting for this command to work. (See Figure 2-29).

Figure 3-27

Quit The quit command enables you to log off and exit out of the telnet controller.

When this command is used, you will be notified after you have been fully disconnected (See Figure 2-30).



Figure 3-28

Polycom, Inc. 4–1

4Sample Presentation

Assuming that all of the necessary data has been entered and selected, such as Interface and Meta Data, the following is an example of the steps taken for a presentation with security users in place. The sample shows the telnet commands.

For questions about what will be produced by the individual commands, refer to the command descriptions earlier in this document.

1 telnet 127.0.0.1

2 username

3 password

4 startcapture

5 getstatus

6 stopcapture

7 quit

This is an example of what can take place, and not the commands that must be used or the order in which they have to be used for every presentation.


4–2 Polycom, Inc.

capture station telnet controller manual -...

Documents