Polycom SoundStructure C16 Design Manual
Hide thumbs Also See for SoundStructure C16:
Table of Contents

Advertisement

Quick Links

DESIGN GUIDE
1.9.0 | September 2016 | 3725-33186-002A
®
®
Polycom
SoundStructure
C16, C12, C8,
and SR12

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the SoundStructure C16 and is the answer not in the manual?

Questions and answers

Summary of Contents for Polycom SoundStructure C16

  • Page 1 DESIGN GUIDE 1.9.0 | September 2016 | 3725-33186-002A ® ® Polycom SoundStructure C16, C12, C8, and SR12...
  • Page 2 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. To receive software information, as well as the open source software code used in this product, contact Polycom by email at OpenSourceVideo@polycom.com.
  • Page 3: Table Of Contents

    Defining SoundStructure Architectural Features ........17 Understanding Polycom OBAM™ - One Big Audio Matrix ......19 Understanding SoundStructure C-Series Products .
  • Page 4 Design Guide for Polycom C16, C12, C8, and SR12 SoundStructure Studio 1.9.0 Controlling Array Virtual Channels ......... . 68 Understanding IR Receiver Virtual Channel .
  • Page 5 Routing The Polycom Video Codec Signals ........
  • Page 6 Connecting Polycom Microphones ........
  • Page 7 Viewing the Gating Information Sent To A Control System Example ....265 Positioning A Polycom Video Codec Camera Example ......267 Creating SoundStructure Events Best Practices .
  • Page 8 Updating Polycom Touch Control Software ........293...
  • Page 9 Design Guide for Polycom C16, C12, C8, and SR12 SoundStructure Studio 1.9.0 Upgrading Software with a Local FTP Server ....... . . 354 Upgrading Software with an Existing Provisioning Server .
  • Page 10 Controlling The System ..........450 Creating an Eight Microphones with The Polycom Video Codec Conferencing System ..451 SoundStructure Studio Steps .
  • Page 11 Polycom Video Codec Integration ........
  • Page 12 Design Guide for Polycom C16, C12, C8, and SR12 SoundStructure Studio 1.9.0 Understanding Virtual Channel Types ........536 Understanding Virtual Channel Groups .
  • Page 13 Design Guide for Polycom C16, C12, C8, and SR12 SoundStructure Studio 1.9.0 Tail Time ............. 725 Transmission Delay .
  • Page 14: Introduction

    SoundStructure Studio and Firmware, and any concepts that refer to HDX apply for Group Series as well. The Polycom SoundStructure C16, C12, and C8 audio conferencing devices are single rack unit devices that have 16 inputs and 16 outputs, 12 inputs and 12 outputs, or 8 inputs and 8 outputs respectively. The SoundStructure SR12 is an audio device for commercial sound applications that do not require acoustic echo cancellation capabilities and has 12 inputs and 12 outputs.
  • Page 15 Touch Control with SoundStructure Systems provides the steps for using the Polycom Touch Control with a SoundStructure system. See the SoundStructure and the Polycom Touch Control Users Guide for instructions on how to use the Polycom Touch Control with SoundStructure. Polycom, Inc.
  • Page 16 If you are new to the SoundStructure products, read this guide starting with Introducing the Polycom SoundStructure Product Family for an overview, Customizing SoundStructure Designs...
  • Page 17: Introducing The Polycom Soundstructure Product Family

    Introducing the Polycom SoundStructure Product Family There are two product lines in the SoundStructure product family: the SoundStructure Conferencing series devices (C-series) designed for audio conferencing applications and the SoundStructure Sound Reinforcement series devices (SR-series) designed for commercial sound applications.
  • Page 18 SR-Series Input Processing Up to 8th order highpass and lowpass 1st or 2nd order high shelf and low shelf 10-band parametric equalization Acoustic echo cancellation, 20-22kHz 200 msec tail-time, monaural or stereo Automatic gain control: +15 to -15dB Polycom, Inc.
  • Page 19: Understanding Polycom Obam™ - One Big Audio Matrix

    Signal delay on telco transmit and receive: up to 1000 msec Noise cancellation: 0-20dB noise reduction on telco receive Understanding Polycom OBAM™ - One Big Audio Matrix One of the significant advancements in the SoundStructure products is the ability to link together multiple...
  • Page 20 Since one SoundStructure C16 device has a 16x16 matrix, two C16 devices linked together create a 32x32 matrix and so forth.
  • Page 21: Understanding Soundstructure C-Series Products

    All outputs have the same processing capability. A single SoundStructure C16, C12, or C8 device supports 16, 12, or 8 microphone or line inputs and 16, 12, or 8 line outputs, respectively. You can link up to eight SoundStructure devices together including any combination of SoundStructure C-series or SR-series products may be used together to build audio processing systems that support up to 128 analog inputs and outputs.
  • Page 22: Understanding C-Series Input Processing

    Automatic gain control: +15 to -15dB Dynamics processing: gate, expander, compressor, limiter, peak limiter Feedback Eliminator: 10 adaptive filters Noise cancellation: 0-20dB noise reduction Automixer: gain sharing or gated mixer Signal fader gain: +20 to -100 dB Signal delay to 1000 msec Polycom, Inc.
  • Page 23 0.5 dB steps. There is also an option to enable 48 V phantom power on each input. Finally the analog input signal is digitized and available for processing. The digital signal is processed by five different DSP algorithms: parametric equalization, acoustic echo cancellation, noise cancellation, feedback reduction, and echo suppression (non linear processing). Polycom, Inc.
  • Page 24 Gain Control Processor Matrix Reinforcement Each analog input signal is processed to generate three different versions of the processed input signal that can be used simultaneously in the matrix: ● Conferencing version ● Sound reinforcement version ● Recording/ungated version Polycom, Inc.
  • Page 25 This is the path that is typically used for sending local audio to loudspeakers in the room for sound reinforcement. There is no non-linear processing on this path so that the local talker audio to the loudspeakers is not affected by the presence of remote talker audio in the local room. Polycom, Inc.
  • Page 26 ● Conferencing ● Sound reinforcement Processing Recording/Ungated–Bypass The recording/ungated-bypass has no input processing other than a fader gain control, input delay, and input mute. This version bypasses the automatic gain control and dynamics processing, as shown in the Polycom, Inc.
  • Page 27 The recording/ungated conferencing processed input includes acoustic echo and noise cancellation, as shown in the following figure. This path is used for the recording of conference microphones as it includes all the acoustic echo cancellation but not the automatic microphone mixer processing. Polycom, Inc.
  • Page 28: Creating C-Series Matrix Crosspoints

    In addition, you can also negate and invert the matrix crosspoint so that the crosspoint arithmetic creates a subtraction rather than an addition. The inversion technique is effective in difficult room reinforcement environments by creating phase differences in alternating zones to add more gain before feedback. Polycom, Inc.
  • Page 29: Understanding C-Series Output Processing

    1st or 2nd order high shelf and low shelf filters 10-bands of parametric or 31-band graphic equalizer Dynamics processing: gate, expander, compressor, limiter, peak limiter Signal fader gain: +20 to -100 dB Signal delay: up to 1000 msec Polycom, Inc.
  • Page 30: Processing C-Series Submixes

    Microphones, remote audio sources, or other signals are typically sent to a submix channel and the resulting submix signal is used as a single input in the matrix. SoundStructure C-Series Submix Processing Submix Processing Up to 8th order highpass and lowpass filters Polycom, Inc.
  • Page 31: Understanding C-Series Acoustic Echo Canceller References

    Understanding C-Series Acoustic Echo Canceller References In conferencing applications, an acoustic echo canceller (AEC) removes the remote site's audio that is played in the local room and prevents the audio from being picked up by the local microphones and sent Polycom, Inc.
  • Page 32: Understanding Soundstructure Sr-Series Products

    You can create an acoustic echo canceller reference from any output signal or any submix signal. For a SoundStructure C16 device, this means that there are 32 possible echo canceller references (16 outputs + 16 submixes) that you can define and select.
  • Page 33 SoundStructure SR12 inputs. The following figure shows an installation that does not work because the microphones that are connected to the SoundStructure SR12 are not echo canceled. If you need more conferencing microphones than can be Polycom, Inc.
  • Page 34: Understanding Sr-Series Input Processing

    SoundStructure SR-Series Signal Input Processing Path SR-Series Input Processing Up to 8th order highpass and lowpass 1st or 2nd order high shelf and low shelf 10-bands of parametric equalization Automatic gain control: +15 to -15dB Dynamics processing: gate, expander, compressor, limiter, peak limiter Polycom, Inc.
  • Page 35 Each analog input signal has an analog gain stage that is used to adjust the gain of the input signal to the SoundStructure's nominal signal level of 0 dBu. The analog gain stage can provide from -20 to 64 dB of Polycom, Inc.
  • Page 36 ● Recording/ungated The AGC, dynamics processor, and input fader are linked together on all three audio paths and apply the same gain to the signal paths based on an analysis of the signal earlier in the signal path. Polycom, Inc.
  • Page 37 This is the path that is typically used to send a noise reduced version of the microphone audio to paging zones that are not acoustically Polycom, Inc.
  • Page 38 For additional flexibility in audio applications, there are four different versions of the recording/ungated signal that can be selected through the four-input router shown in the previous processing figures. This Polycom, Inc.
  • Page 39 The recording/ungated bypass version has no input processing other than a fader gain control, input delay, and input mute. This version bypasses the automatic gain control and dynamics processing, as shown in the following figure. This version can be used when it is important to have minimal audio processing on an input signal. Polycom, Inc.
  • Page 40 Cancellation Gain Control Processor Matrix Gain Sound Feedback Automatic Dynamics Input to Automixer Fader Delay Cancellation Gain Control Processor Matrix Reinforcement Parametric Noise Automatic Dynamics Fader Delay Mute Equalization Cancellation Gain Control Processor Processing Recording/Ungated - Sound Reinforcement Polycom, Inc.
  • Page 41: Creating Sr-Series Matrix Crosspoints

    Creating Designs with SoundStructure Studio, different versions of the input processing are represented with different background colors at the matrix crosspoint. The SoundStructure Studio software allows the user to select which version of the input signal processing at the matrix crosspoint. Polycom, Inc.
  • Page 42: Understanding Sr-Series Output Processing

    1st or 2nd order high shelf and low shelf filters 10-bands of parametric or 31-band graphic equalizer Dynamics processing: gate, expander, compressor, limiter, peak limiter Signal fader gain: +20 to -100 dB Signal delay: up to 1000 msec Polycom, Inc.
  • Page 43: Processing Sr-Series Submix

    Up to 8th order highpass and lowpass filters 1st or 2nd order high shelf and low shelf filters 10-bands of parametric equalization Dynamics processing: gate, expander, compressor, limiter, peak limiter Signal fader gain: +20 to -100 dB Signal delay: up to 1000 msec Polycom, Inc.
  • Page 44: Understanding Telephony Processing

    SoundStructure Telephony Card These cards are field-installable and are ordered separately from the SoundStructure C- or SR-series devices. See the SoundStructure Hardware Installation Guide or the Hardware Installation Guide for the TEL1 and TEL2 for additional information. Polycom, Inc.
  • Page 45 Noise cancellation: 0-20dB noise reduction on telco receive On the telephony receive path, the processing includes up to 20 dB of noise cancellation, automatic gain control, dynamics processing, 10-band parametric equalization, fader, and audio delay. In addition there is Polycom, Inc.
  • Page 46 The telephony cards should not be used with the SR-series of products for audio conferencing applications (i.e., simultaneous two-way audio communication) unless all the microphones in the system are connected to SoundStructure C-series devices. The SR-series products do not have acoustic echo cancellation. Polycom, Inc.
  • Page 47: Introducing Soundstructure Design Concepts

    Understanding Virtual Channels extends this concept by creating a layer over physical channels that allows the physical channels to be referenced by a user defined label, such as “Podium mic”, rather than as a channel number. Polycom, Inc.
  • Page 48: Understanding Physical Channels

    Numbering Physical Channel On A Single SoundStructure Device As described previously, in single-device SoundStructure installations (for example using a single SoundStructure C16), the physical channel numbering for the inputs and outputs corresponds to the Polycom, Inc.
  • Page 49: Numbering Physical Channel With Multiple Soundstructure Devices

    For if there are two devices and the first device is a SoundStructure C16, the first input on the second device becomes physical input 17.
  • Page 50 To properly link multiple SoundStructure devices, connect the OBAM OUT port on the first device (typically the top SoundStructure device in the equipment rack) to the OBAM IN port on the next SoundStructure Polycom, Inc.
  • Page 51 Following the connections in the previous figure, consider the system of three SoundStructure C16 devices shown in the following figure as an example of this linking order and how the physical channels are numbered.
  • Page 52 PIN 7: CTS PIN 8: RTS Device A REMOTE CONTROL 1 RS-232 REMOTE CONTROL 2 OBAM SoundStructure C16 Input Physical Channels 1 - 16 Output Physical Channels 17 - 32 PIN 2: TXD PIN 3: RXD PIN 5: GROUND PIN 7: CTS...
  • Page 53 OBAM OUT connection which makes this device the first device in the link. Next, device C becomes the second device in the link and finally device B becomes the third device in the link. The result is that the inputs Polycom, Inc.
  • Page 54 PIN 5: GROUND PIN 7: CTS PIN 8: RTS Device A REMOTE CONTROL 1 RS-232 REMOTE CONTROL 2 SoundStructure C16 OBAM Input Physical Channels 1 - 16 Output Physical Channels 33 - 48 PIN 2: TXD PIN 3: RXD PIN 5: GROUND...
  • Page 55: Physical Channel Summary

    “1” and it corresponds to the first input on the top device. The first input on the second device is input 17 (if the first device is a SoundStructure C16). In the next section, the concept of physical channels is extended as the new concept of virtual channels is...
  • Page 56: Understanding Virtual Channels

    For instance, if a virtual channel were named “Podium mic” then the control system code would control this channel by sending commands to “Podium mic”. It would not matter to the control system if on one Polycom, Inc.
  • Page 57: Virtual Channel Summary

    Virtual channels also simplify the setup and configuration of a system because it is easier to understand and view changes to Podium mic than it is to have to refer to a signal by a particular physical input or output number such as input 17. Polycom, Inc.
  • Page 58: Understanding Virtual Channel Groups

    “Table mic 4” 1 val mute “Table mic 5” 1 val mute “Table mic 6” 1 val mute “Table mic 7” 1 val mute “Table mic 8” 1 val mute “Podium mic” 1 val mute “Mics” 1 Polycom, Inc.
  • Page 59 A Virtual Channel Group “Mics” Input 2 Input 3 Input 4 Input 5 Input 1 Input 6 Input 7 Input 8 Input 9 Input 10 Polycom, Inc.
  • Page 60 1, the podium mic on input 2, the table mics 1-8 on inputs 3-10, a stereo VCR is connected to inputs 11 and 12 and a Polycom Video Codec is connected over the digital ConferenceLink interface.
  • Page 61 In this example there are several virtual channel groups defined including "Reinforced Mics", "All Mics", "All Table Mics", "Program Audio", "Remote Receive Audio", and "Remote Send Audio". Polycom, Inc.
  • Page 62: Virtual Channel Group Summary

    Defining Logic Pins SoundStructure logic input and output pins are also considered physical inputs and outputs that can be abstracted with control virtual channels and control array virtual channels. Polycom, Inc.
  • Page 63: Labeling Physical Logic Pins

    When multiple devices are OBAM linked, as shown in the next figure, the logic inputs and outputs on the first device are numbered 1 - 22 and the logic inputs and outputs on the second device (device B) are Polycom, Inc.
  • Page 64 SoundStructure device - not just provide control on the device the logic inputs are on. Similarly logic outputs can be used to provide status on signals on any SoundStructure device - not just status on a physical channel on that particular device. Polycom, Inc.
  • Page 65 The next figure shows the analog gain input pin and the associated +5 V and ground pins that are used with the analog gain input pin. The analog voltage on the analog gain input pin is converted to a digital value via an analog-to-digital converter for use within the SoundStructure devices. The maximum voltage value, that Polycom, Inc.
  • Page 66 The open collector design is shown in the following figure and works as a switch as follows: when the logic output pin is set high (on), the transistor turns on and the signal connected to the logic output pin is grounded and current flows from the logic output pin to chassis ground. Polycom, Inc.
  • Page 67: Controlling Virtual Channels

    “Logic Input Example” The state of digital logic output may also be set active using the digital_gpio_state command as follows for the control virtual channel “Logic Output Example” that would be created with the vcdef command. Polycom, Inc.
  • Page 68: Controlling Array Virtual Channels

    In the above table, if all the pins are open, the get command described above returns the value 7. If pin 2 is shorted to ground (value of 0), the value of the get command is 6 and so forth. Polycom, Inc.
  • Page 69: Understanding Ir Receiver Virtual Channel

    1 is the only physical channel that can be specified since there is only one physical IR receiver channel. Once a command from the Polycom IR remote transmitter, a command acknowledgment of the form: val ir_key_press “IR Input” 58 is generated by the SoundStructure device when a key that corresponds to code 58 is pressed on the IR remote transmitter.
  • Page 70: Creating Designs With Soundstructure Studio

    SoundStructure Studio software is not already installed on the local PC, it may be installed from the CD that was included with the product. More recent versions of SoundStructure Studio may also be available on the Polycom website - please check the Polycom website before installing the SoundStructure Studio version that is on the CD-ROM.
  • Page 71: Understanding System Requirements

    ● A display with 1280x1024 resolution or higher Installing SoundStructure Studio To install SoundStructure Studio, 1 Run the StudioSetup.exe software and follow the prompts. 2 After Studio is installed, launch SoundStructure Studio and select File > New Project, as shown in following figure. Polycom, Inc.
  • Page 72 SoundStructure Studio provides default input gains for the various input and output channels. After the design has been created, these gains, along with all other settings, can be adjusted as described in Customizing SoundStructure Designs. Polycom, Inc.
  • Page 73 The choices for Hybrids/Codecs include the Polycom Video Codec, the Polycom VSX series, and a generic mono or stereo video codec. When the Polycom Video Codec is selected, it is assumed that the Polycom Video Codec connects to the SoundStructure device over the Conference Link2 interface. To use the Polycom Video Codec with the SoundStructure devices via the analog input and output instead of Conference Link requires selecting a different codec such as the VSX8000 stereo codec.
  • Page 74 In this example, a stereo amplifier was selected as well as a mono recording output. The telephone and Polycom Video Codec conferencing system outputs were automatically created when their respective inputs were added to the system. Notice that there are multiple audio channels associated with the Polycom Video Codec. See Connecting Over Conference Link2 for additional information.
  • Page 75 The Polycom Video Codec does not require any analog inputs and outputs because the signals are transferred over the digital Conference Link2 interface.
  • Page 76 In step 4, you can decide to either work offline or work online. When working online, you can select a set of devices to upload the settings to via the Ethernet or RS-232 interfaces. As a best practice, Polycom recommends you design the file offline, customize settings - including the wiring page as described in the...
  • Page 77: Operating In Online And Offline Mode

    SoundStructure devices. Commands are sent to the emulator and command acknowledgments receive commands from the emulator allowing the designer to test a SoundStructure system design without ever connecting to a system. Polycom, Inc.
  • Page 78 Regardless of whether the system is operating online or offline with SoundStructure Studio, you can open the SoundStructure Studio Console and see the commands and acknowledgments by right clicking on the control port interface as shown in the following figures. SoundStructure Studio Console SoundStructure Studio Data Console Polycom, Inc.
  • Page 79 .str file extension. When working online, saving the project prompts you to save the file on the disk as well as store the settings in the SoundStructure device. Polycom, Inc.
  • Page 80: Customizing Soundstructure Designs

    1 and 2 and the recording channel uses physical output 3. Remember that stereo virtual channels are always defined with two physical channels while mono virtual channels are defined with one physical channel. Polycom, Inc.
  • Page 81 If it is necessary to change the wiring from the default wiring, you can change the virtual wiring by clicking and dragging signals from their current input or output to a new input or output, as shown in the following figure. In this example, the Recording output changed from physical output 3 to physical output 6. Polycom, Inc.
  • Page 82 It is important to know that the actual wiring of the system needs to match the wiring specified on the Wiring page. Otherwise, the system does not operate as expected. For instance, in the example above, if the recording output is physically plugged into output 3 when SoundStructure Studio notices the recording Polycom, Inc.
  • Page 83: Editing Devices

    ● Grow a project from a smaller SoundStructure device to a larger device ● Shrink a project from a larger SoundStructure device to a smaller device, if there are enough unused inputs and outputs ● Add, change, or remove telephony cards Polycom, Inc.
  • Page 84: Using The Channels Page

    Using the Channels Page The Channels page is the primary area for customizing the signal gains and processing for the input, output, and submix signals. Regardless of the number of SoundStructure devices used in a design, there is only Polycom, Inc.
  • Page 85 Channels Page in SoundStructure Studio The input and output signals are shown with different colored outlines to differentiate among inputs, outputs, and submixes. The signals are color coded with the input signals having a green shading and outline, the Polycom, Inc.
  • Page 86 Channels page as shown in the following figure. Editing Controls on the Channels Page in SoundStructure Studio In addition, you can expand groups of virtual channels to display the individual members of the group by Polycom, Inc.
  • Page 87: Editing Virtual Channels

    Channels page with default gain settings for the devices and default signal routing created for the matrix based on the type of signal added. If virtual channels are deleted, the channels are removed from the Channels page and the channels’ matrix signal routings are removed. Polycom, Inc.
  • Page 88: Creating Virtual Channel Groups

    A virtual channel group may be collapsed or expanded by clicking the graphics respectively, on the top of the group page. All groups in the channels page can be expanded or collapsed by clicking on the Expand or Collapse buttons respectively. Polycom, Inc.
  • Page 89 All existing virtual channel groups display on the right of the screen. Virtual channels can be in more than one virtual channel group. For example, Table Mic 1 can be in the virtual channel group Mics and Zone 1 Mics. Polycom, Inc.
  • Page 90 3 are all muted and the Zone 1 Mics logical group display as muted. If individual members of a group have different values for the same parameter, such as the mute state, the value of the group parameter displays with a crosshatch pattern, as shown in the following figures. Polycom, Inc.
  • Page 91: Setting Input Signals

    The settings applied to input signals depend on the type of virtual channel created from that physical input. For example, there are different controls if the signal is a microphone input, line level input, a stereo virtual channel, a signal generator, or a telco input. Polycom, Inc.
  • Page 92: Enabling Input Signal Meters

    Ethernet connection. If meters are viewed over the RS-232 interface, Polycom recommends that you use the highest data rate of 115,200 baud to minimize any lag between registering for meters and having the meter information displayed on the screen.
  • Page 93 The level_post meter is after any processing, as shown in the following figure. In the example below, if the input signal is muted the level_post meter does not display any signal activity. The exact location of the meter in the signal processing path depends on the type of signal that is viewed, as described next. Polycom, Inc.
  • Page 94 You can use the fader on the bottom of the input channel to adjust the gain of the output of the input processing. The fader changes the level of all three outputs going to the matrix. The meter activity displays the affect of any gain adjustments. Polycom, Inc.
  • Page 95 For telephony channels, the level_pre and level_post for the phone input channel and level_post for the phone output channels are shown in the following figure. As with the analog input and output channels, the level_pre is before any processing and the level_post is after the processing. Polycom, Inc.
  • Page 96 The Codec Voice In and Codec UI Audio In channels do not have level_pre or level_post meters as those signals are available directly at the matrix and do not have any input processing on a SoundStructure device. Polycom, Inc.
  • Page 97: Using Input Channel Controls

    The input channel controls are expanded to show less frequently used controls such as phantom power, trim, delay compensation, and the selection of the different ungated signal types. See Introducing the Polycom SoundStructure Product Familyfor more information about the ungated/recording signal types and Polycom, Inc.
  • Page 98: Operating Analog Signal Gain

    -20 dB to +64 dB with 0.5 dB gain increments. Values are rounded to the nearest 0.5 dB. This continuous gain range is different from the gain Vortex products uses because the Vortex Polycom, Inc.
  • Page 99: Changing The Mute Status

    Enabled or disabled 48 V phantom power on a per input basis by clicking the phantom power button. The SoundStructure device supports up to 7.5 mA of current at 48 V on every input. By default, phantom power is turned off for all inputs if there is no SoundStructure Studio configuration loaded into the device. Polycom, Inc.
  • Page 100: Using The Ungated Type

    The ungated type user control refers to which signal path to use for the ungated (or un-automixed) processing path. The decision of whether to use the ungated version of the input channel processing is made at the matrix crosspoint, as shown in the following figure, where the gated type None is highlighted. Polycom, Inc.
  • Page 101 Ungated Version of Input Channel Processing Matrix Crosspoint As described in Introducing the Polycom SoundStructure Product Family, there are four types of ungated signal processing paths that can be selected for each input. The different signal processing paths for the four ungated signal types are summarized in the following table.
  • Page 102 (or ducking) to the signal. The application of using this path is shown in the following figure where a microphone is connected and echo canceled and feedback reduced, but not automixed Polycom, Inc.
  • Page 103 Delay Mute Cancellation Processor Equalization Cancellation Cancellation Gain Control A complete summary of the signal processing associated with each ungated processing type is shown in the following figure. For additional information, see Introducing the Polycom SoundStructure Product Family. Polycom, Inc.
  • Page 104: Using Delay Type

    Delay Mute Equalization Cancellation Cancellation Cancellation Gain Control Processor Using Delay Type When you select the Sound Reinforcement ungated type, there are two delay options that are available on the Sound Reinforcement signal path: normal and low delay. Polycom, Inc.
  • Page 105 The signal path includes the latency associated with the echo and noise cancellation signal path Low delay The signal path does NOT include the latency associated with the echo and noise cancellation signal path. The echo and noise cancellation blocks are completely bypassed. Polycom, Inc.
  • Page 106: Using Delay Compensation

    Microphone inputs have approximately 16 msec of latency due to the AEC and noise cancellation processing. By selecting delay compensation, 16 msec of delay is added to the line input and bypass ungated signal types. Polycom, Inc.
  • Page 107: Using Trim

    As shown in the following figure, there are two trim knobs for stereo virtual channels and no trim knob for mono virtual channels. Polycom, Inc.
  • Page 108: Processing Equalization

    These filter types are shown in the following figure. The overall equalization processing are enabled or disabled using the button next to the EQ block name on the Channels page or equivalently by using the button next to the EQ Filters text, as shown in the following figure. Polycom, Inc.
  • Page 109 ● Notch filter ● Allpass filter Parametric filters emphasize or de-emphasize the center frequency with a gain and bandwidth setting. You can specify the bandwidth (in octaves), center frequency (in Hz), and gain (from 0 to 20 dB). Polycom, Inc.
  • Page 110: Eliminating Feedback

    The bandwidth is defined as the bandwidth (in octaves) where the phase shift is 90 degrees and 270 degrees. Eliminating Feedback Feedback elimination uses 10 adaptive filters to reduce feedback that may be picked up by the microphone. When the feedback cancellation processing is enabled for a particular virtual channel, you can adjust the Polycom, Inc.
  • Page 111 The Filter Decay control allows the adaptive filters to relax as the feedback is reduced in the system. During operation, if persistent frequencies appear, you can fix the filter settings from those offending frequencies by clicking Make Fixed. This transfers the settings of the adaptive filter to one of the fixed parametric filters. Polycom, Inc.
  • Page 112: Enabling Acoustic Echo Cancellation (Aec)

    The AEC is enabled/disabled by toggling the AEC button. The AEC control displays the mode of the acoustic echo canceller with Xmit indicating the system is transmitting audio to the remote site and Recv indicating the system is receiving audio from the remote site and is heard in the local room. Polycom, Inc.
  • Page 113: Processing Noise Cancellation

    You can enable noise cancellation for a non-microphone channel, such as a video codec audio or program audio, by selecting the conferencing version of the ungated signal path. Note that the default selection for non-microphone audio sources is the line-input processing path. Polycom, Inc.
  • Page 114 The ungated conferencing signal path is shown in the following figure. Notice that the noise cancellation processing is now in the signal path along with the automatic gain control, dynamics processing, fader, delay, and mute. The acoustic echo canceller is also in this signal path but is not enabled for non-microphone audio sources. Polycom, Inc.
  • Page 115: Using Automatic Gain Control (Agc)

    You can turn the AGC on or off with the AGC enable button. When the AGC is enabled, you can view the current AGC gain (or attenuation) from the AGC meter and the text box next to the AGC meter. Polycom, Inc.
  • Page 116: Using Dynamics Processors

    SoundStructure devices include the following styles of look-ahead dynamics processing: ● Peak Limiter ● Limiter ● Compressor ● Expander ● Gate The SoundStructure Studio user interface for adjusting the dynamics settings are shown in the following figure. Polycom, Inc.
  • Page 117 You must enable the gate, expander, compressor, limiter, and peak limiter individually with their individual enable buttons. In the following figure the limiter is enabled. Enabled Limiter for Dynamic Processing After the dynamics processing is enabled, the dynamics processing curve updates as adjustments are made to the dynamics processing settings. Polycom, Inc.
  • Page 118 “compression” or division by the compression ratio is engaged. This is shown in the following figure. 1. dBFS means dB full scale where 0 dBFS is the maximum input signal allowed. Due to the SoundStructure design of a nominal signal level of 0 dBu with 20 dB headroom, -20 dBFS equals 0 dBu. Polycom, Inc.
  • Page 119 This expands or increases the dynamic range of a signal. When the input signal level falls below the expander’s threshold, it applies an amount of attenuation (in dB) equal to the expansion ratio times the difference between the threshold and the signal level, as shown in the following figure. Polycom, Inc.
  • Page 120 1 (0 dB), is applied to the input signal. The expander attack time is the amount of time (in milliseconds) it takes the expander to ramp the gain up to the target level once the input signal exceeds the expander threshold. Polycom, Inc.
  • Page 121: Using Automatic Microphone Mixing

    Creating Advanced Applications for more information on room combining applications. Polycom, Inc.
  • Page 122 There are two styles of automixer groups – gating and gain-sharing. The controls for these two styles of groups are described next. Gating Automixer Parameters NOM Limit NOM Limit specifies the maximum number of microphones that can be gated on for a particular gated automixer group. This does not affect a gain sharing mixer. Polycom, Inc.
  • Page 123 Adaptive threshold is the level in dB relative to its noise floor a signal must have to be eligible to be considered active. Higher settings makes the channel less sensitive - harder to turn the microphone on, while lower settings make it more sensitive - easier to turn the microphone on. Polycom, Inc.
  • Page 124 (negative bias value) activating a particular microphone more so than other microphones. When the channel bias is positive, the signal that the automixer sees is made louder by the gating bias value than it really is, even though the actual signal level is unchanged. Polycom, Inc.
  • Page 125: Processing Delay

    A maximum and minimum gain range can be specified for the input faders to make it possible to limit user gain control by moving the triangles associated the gain slider. To set the maximum fader gain, adjust the main slider to the desired maximum gain and then move the upper triangle to that level. Polycom, Inc.
  • Page 126: Defining A Signal Generator

    Each SoundStructure device can have a single signal generator defined which can generate white noise, pink noise, a sine wave, and a sine sweep. By default, each project has a signal generator with pink noise at a level of -30dB added to the project. Polycom, Inc.
  • Page 127 To use the signal generator, unmute the crosspoint at the signal generator to the desired outputs. Typically the signal generator is routed to loudspeakers as part of the setup process (see Installing SoundStructure Devices) to ensure loudspeakers are active and to adjust the loudspeaker levels in the room. Polycom, Inc.
  • Page 128: Setting Output Signals

    SoundStructure Studio user control for the meters and gain control. As presented in Installing SoundStructure Devices, the level slider affects the analog signal level on the output of the digital to analog converter. Positive gain is added in the digital Polycom, Inc.
  • Page 129: Processing Output Dynamics

    The output equalization includes a dedicated Low Pass, High Pass, Low Shelf, and High Shelf filter. In addition the designer may enable either 10 bands of parametric equalization (the same as the input processing) or an octave, 2/3 octive, or 1/3 octave graphic equalizer. Polycom, Inc.
  • Page 130 The nominal and exact center frequencies of these equalizers are shown in the following table. Equalizer Nominal and Center Frequencies Center Freq (Hz) 1 octave band 2/3 octave band 1/3 octave band — — — — — — — Polycom, Inc.
  • Page 131: Processing Delay

    Each time a signal is sent to a submix and received back into the matrix, 1.5 msec is added to the delay of the signal. Polycom, Inc.
  • Page 132: Processing Output Dynamics

    Processing Output Equalization As shown in the following figure, the equalization processing that is available for each submix consists of a dedicated list of the following: ● Low Pass ● High Pass ● Low Shelf ● High Shelf Polycom, Inc.
  • Page 133 0 degrees at 0 Hz, 360 degrees at high frequencies, and 180 degrees at the center frequency. The bandwidth is defined as the bandwidth (in octaves) where the phase shift is 90 degrees and 270 degrees. Polycom, Inc.
  • Page 134: Processing Delay

    2 When a mono input signal is mapped to a stereo output signal with a gain of 0 dB, the mono input is mapped to both the left and the right physical output channels with an attenuation of 3 dB. Polycom, Inc.
  • Page 135 For crosspoints whose value differs for members in the group, a shaded boundary is shown. This can be seen in the matrix crosspoint of the Codec In group to the Phone Out virtual channel. Polycom, Inc.
  • Page 136: Adjusting Crosspoints

    Any matrix crosspoint may be adjusted over the range of +20 dB to -100 dB in 0.1 dB increments. A maximum and minimum gain range can be specified for the matrix crosspoints to limit the user gain control. The process of setting the min and max matrix gain controls is described in the Controlling Fader section. Polycom, Inc.
  • Page 137 The following figure shows three crosspoint controls - the first with a mono input to a mono output, the second with a mono input to a stereo output, and the third with a stereo input to a stereo output. Polycom, Inc.
  • Page 138 To select the sound reinforcement version of the input processing, double click the matrix crosspoint to adjust and select Gated and Snd Reinforcement. The crosspoint cell shading changes to light blue to Polycom, Inc.
  • Page 139 Input Processing Path User Controls To select the conferencing version of the input processing, select Gated and Conferencing as shown in the following figure. The crosspoint background turns blue to indicate the conferencing version of the input processing is selected. Polycom, Inc.
  • Page 140 A pan value of 0 means that the monaural input virtual channel is attenuated by 3 dB and sent to both the left and right output channels. The gain (or attenuation) of the matrix crosspoint is also applied to the input signal as it is mapped to the output signal. Polycom, Inc.
  • Page 141: Matrix Summary

    ● Bold values are the gain in dB in the crosspoint. ● An arc with a circle indicates that there is some panning or balance other than the center position in effect. ● An underscore indicates the matrix crosspoint is inverted. Polycom, Inc.
  • Page 142: Using The Telephony Channels

    The signal processing paths for both the input and output channels include equalization, dynamics processing, and audio delay. In addition, the telephone input channel has noise cancellation and automatic gain control that can be applied to the signal received from the telephone line. Polycom, Inc.
  • Page 143: Adjusting Input Gain

    Adjust the telephone gain so that during normal speech there are at least two yellow LEDs lit on the telco receive. The location of the telco signal meters are shown in the following figure. The input channel meters level_pre meter corresponds to the meter next to the analog input gain adjustment on the telephone input virtual Polycom, Inc.
  • Page 144: Processing Noise Cancellation

    By default the maximum and minimum gain are set to 6 and -6 respectively on microphone and telephony signals. The maximum AGC value specifies the maximum amount of gain the AGC can apply to increase the input signal level as the AGC tries to reach the SoundStructure nominal signal level. Polycom, Inc.
  • Page 145: Processing Output Dynamics

    The cut off frequency can be adjusted between 0 Hz and 20,000 Hz, the order can be adjusted from 2 , and either a Butterworth or Linkwitz-Riley filter may be selected. Polycom, Inc.
  • Page 146: Controlling Fader

    The delay processing allows the designer to add from 0 to 1000 milliseconds of delay on both the telephone input and output channels. While the delay is set in milliseconds in the user interface, it can be manually set through the command API in samples where each sample represents 1/48 of a millisecond. Polycom, Inc.
  • Page 147: Using Telephone Controls

    In addition to the audio processing paths described in this section, telephony channels have additional user controls to configure the telephone interface. Select Phone Settings to get access to the telephony specific controls. Telephony Channel User Controls The telephony channel controls are shown in the following figure. Polycom, Inc.
  • Page 148 Enabling ring tones sets the SoundStructure device to play ring tones into the local room when the telephone line rings. If Ring Tone is disabled no ring tone is heard although a phone_ring status message is generated by the SoundStructure device when the phone is ringing. Polycom, Inc.
  • Page 149 The line voltage and loop current are active whenever the Poll Telephony Information is enabled at the top of the user control. The line voltage and loop current allow for diagnostics of the telephone line. See Appendix A of this manual for more information on how to query the line voltage and loop current values. Polycom, Inc.
  • Page 150: Connecting Over Conference Link2

    Guide for additional cable information including the required pin outs. The signals that are transmitted between the SoundStructure device and a Polycom Video Codec conferencing system connected over Conference Link2 are kept as digital signals. No analog signals are transmitted between the SoundStructure device or the Polycom Video Codec video conferencing system when connecting to the Polycom Video Codec system with the Conference Link2 interface.
  • Page 151: Integrating Polycom Video Codec

    Conference Link2 cable as shown in the next figure. Either Conference Link2 port on the SoundStructure device or the Polycom Video Codec system may be used. The Polycom Video Codec system requires firmware release 2.0.1 or higher firmware to be compatible with SoundStructure devices.
  • Page 152 The Conference Link2 interconnect allows for the transmission and reception of multiple digital audio signals between the two devices as shown in the following figures. These signals are described in the following sections. Digital Audio Signals Between SoundStructure Devices and Polycom Video Codecs Polycom, Inc.
  • Page 153: Designing With The Polycom Video Codec

    Designing with The Polycom Video Codec Within SoundStructure Studio, the Polycom Video Codec system may be selected from the video codec selection category and clicking Add to add the codec to the list of inputs as shown in the following figure.
  • Page 154 Codec Voice Call In channel, that channel may be removed from the input channels without affecting the other input channels from the Polycom Video Codec system. Added Virtual Channels for Polycom Video Codec in SoundStructure Studio...
  • Page 155 The input channels from the Polycom Video Codec are described in the following table. Polycom Video Codec Input Channels Video Codec Signal to Description SoundStructure Video Codec Program Audio In A stereo virtual channel that contains a mix of all non-microphone inputs to the...
  • Page 156: Processing The Polycom Video Codec Soundstructure Signals

    Processing The Polycom Video Codec SoundStructure Signals Each of the signals that the Polycom Video Codec system sends to the SoundStructure device have processing that can be applied as shown in the following figure. This processing is configured through the SoundStructure Studio software.
  • Page 157: Understanding The Polycom Video Codec Output Channels

    Understanding The Polycom Video Codec Output Channels SoundStructure Studio creates several output virtual channels that are sent to the Polycom Video Codec system as shown in the following figure. Polycom Video Codec Output Virtual Channels The output channels sent to the Polycom Video Codec are described in the following table.
  • Page 158: Routing The Polycom Video Codec Signals

    All signals have the same processing that includes dynamics, parametric equalization, fader, delay, and mute. All the signals that are sent to the Polycom Video Codec system have signal level meters that are displayed on the Channels page.
  • Page 159: Using The Mute Controls

    “Mics” 1 set mute “Mics” 0 No audio paths are muted inside the Polycom Video Codec when a Video Codec, that is connected to a SoundStructure device over CLink2 interface, receives a mute command. The only effect of the Video Codec receiving a mute command is that the SoundStructure device is sent a mute message as described above.
  • Page 160 (such as program audio) or even the output signal that is sent to the Video Codec into the “Mics” group and have those signals be affected when the Polycom Video Codec mute status is changed. Although the name of the group is “Mics”, any virtual channel can be part of the group.
  • Page 161: Using The Volume Controls

    Codec does not receive the volume change event from the SoundStructure device. Only when volume change commands are sent to the Polycom Video Codec via a control system or infrared remote the volume event is automatically transmitted to the SoundStructure device.
  • Page 162 Polycom Video Codec, the request does not display as the volume continues to change on the Polycom Video Codec UI although a volume limit may have already been reached within the SoundStructure system which would prevent the system from getting any louder in the room.
  • Page 163: Designing With Polycom Digital Microphone Arrays

    Designing With Polycom Digital Microphone Arrays Each Polycom digital microphone array has three microphone elements and must be thought of as three microphone inputs. As a result, each Polycom digital microphone requires the processing of three SoundStructure analog input channels. In other words, for Because each digital microphone array is represented as three microphones, every microphone array and its respective three microphone elements can be used independently with a SoundStructure device.
  • Page 164: Understanding Digital Microphone Cabling Requirements

    The following table shows the number of analog inputs that are available based on the number of microphone arrays that are used in a system. As an example, a SoundStructure C16 supports 16 analog inputs. When used with two microphone arrays, 10 analog inputs are still available for use with other analog inputs including microphones, program audio, etc.
  • Page 165 [0] Video Codec 8 23:16:40 soundstructure cmdd: sts: [1] SoundStructure 8 23:16:40 soundstructure cmdd: sts: [2] Polycom Mic (f/w 26) 8 23:16:40 soundstructure cmdd: sts: [3] Polycom Mic (f/w 26) 8 23:16:40 soundstructure cmdd: sts: [4] Polycom Mic (f/w 26)
  • Page 166: Detecting Clink2 Devices

    When connected to a SoundStructure device, the wiring page shows the status of the number and type of CLink2 devices. This information is shown in the following figure where two table mics and one Polycom Video Codec were discovered. To have this information automatically updated as devices are connected over CLink2, select the poll device information check box on the top of the wiring page.
  • Page 167 The first step of the design process is to select the input signals as shown in the following figure. Notice that for each Polycom ceiling microphone array that is added, there are three mono microphones with names that include A, B, and C that are added to the project.
  • Page 168 In the third step, the equipment is selected. In this case a C12 is required and has three additional analog inputs available to use after the system is designed. Selecting Equipment for Microphone Arrays in SoundStructure Studio In the final step, offline operation is selected and the resulting project is created. The channels page Polycom, Inc.
  • Page 169: Assigning Digital Microphone Array Channels To Physical Inputs

    Studio reserves processing by starting with the last analog input channel and working towards the first analog input. For example, if a single Polycom digital microphone array is used with a SoundStructure C12, the processing from physical analog inputs 12, 11, and 10 are used for the digital microphone elements A, B, and C respectively and the physical inputs 12, 11, and 10 are not able to be used for any analog inputs.
  • Page 170 In this example, up to six analog inputs can be used (three analog inputs are presently in use) in addition to the two Polycom ceiling microphones. Analog Inputs and Polycom Ceiling Microphones on Wiring Page The digital microphone array elements can be moved on the wiring page to different physical inputs if desired by clicking and dragging the microphone to move it to a different physical input.
  • Page 171 Moving Microphones between Physical Inputs If any changes are made to the wiring page, please make sure to save the file from the File Save menu option so that the updated virtual channel definitions are saved in the configuration. Polycom, Inc.
  • Page 172: Numbering Digital Microphone Array

    PIN 3: RXD PIN 5: GROUND PIN 7: CTS PIN 8: RTS REMOTE CONTROL 1 RS-232 REMOTE CONTROL 2 C-LINK2 OBAM SoundStructure C16 POLYCOM POLYCOM POLYCOM POLYCOM Polycom Mic 1 Polycom Mic 2 Polycom Mic 3 Polycom Mic 4 PIN 2: TXD...
  • Page 173 Polycom Mic 2 Polycom Mic 1 When a Polycom Video Codec system is also connected over the CLink2 interface and the digital microphones connected directly to the SoundStructure device, the numbering of the digital microphone arrays are the same as the previous figures.
  • Page 174: Understanding Installation Options

    There are several installation options available depending on whether tabletop or ceiling microphones are being used. The following figure shows typical wiring options using the Polycom SKUs highlighted with the dashed boxes for tabletop microphones and ceiling microphone arrays. Polycom, Inc.
  • Page 175 Wiring Options with Polycom SKUs for Polycom Tabletop Microphones PIN 2: TXD PIN 3: RXD PIN 5: GROUND PIN 7: CTS PIN 8: RTS RS-232 OBAM C-LINK2 2215-23327-001 2215-23327-001 2457-23716-001 POLYCOM POLYCOM 2457-23216-001 (25 ft) 2457-23216-001 (25 ft) Polycom Mic 1...
  • Page 176 2457-23215-001 Walta to Walta cable, 15 ft length 2457-23216-001 Walta to Walta cable, 25 ft length. Included with the Polycom table microphone arrays. 2457-24008-001 RJ45 to RJ45, 50 ft length, cross-over cable. Part of the Polycom ceiling microphone array package.
  • Page 177: Summary

    As an example, a SoundStructure C16 supports 16 analog inputs. When used with two microphone arrays, 10 analog inputs are still available for use with other analog inputs including microphones, program audio, etc.
  • Page 178 The digital microphones should be connected to the right rear CLink2 port and the Video Codec Polycom should be connected to the left CLink2 port as shown in the following figure. Digital Microphones Connected to a Conference Link2 and Polycom Video Codec POLYCOM POLYCOM POLYCOM...
  • Page 179: Linking Multiple Soundstructure Devices With One Big Audio Matrix

    115,200 due to the size of the firmware file and the subsequent long file transfer times at lower baud rates) 3 Once connected, left-click on the system name to show the firmware update option. Select ‘Open’ to find the firmware file from your desktop. Polycom, Inc.
  • Page 180: Linking Soundstructure Devices

    Design Guide for Polycom SoundStructure Studio C16, C12, C8, and SR12 SoundStructure Studio 1.9.0 4 Select Update to begin the firmware update process. Once the firmware has been updated, the SoundStructure system reboots automatically. The front panel light on the SoundStructure device flashes green while booting and turns solid green when the boot process has finished.
  • Page 181 Design Guide for Polycom SoundStructure Studio C16, C12, C8, and SR12 SoundStructure Studio 1.9.0 as shown in the following figure where one TEL1 card is installed into the master device of a three SoundStructure system. Figure: Installing Telephony Cards PHONE...
  • Page 182 Design Guide for Polycom SoundStructure Studio C16, C12, C8, and SR12 SoundStructure Studio 1.9.0 Viewing Rear Panel OBAM LED Status After the devices are linked together, apply power to the SoundStructure devices. After the SoundStructure devices have finished booting, the OBAM status LEDs, shown in the following figure, indicates the status of the OBAM link.
  • Page 183 Design Guide for Polycom SoundStructure Studio C16, C12, C8, and SR12 SoundStructure Studio 1.9.0 If the OBAM-linked SoundStructure master device has a previously loaded configuration file that does not match the currently linked SoundStructure devices, the front panel LED on all SoundStructure devices turn solid yellow.
  • Page 184: Creating A Multi-Device Configuration File

    Design Guide for Polycom SoundStructure Studio C16, C12, C8, and SR12 SoundStructure Studio 1.9.0 are not removed by the SR12. Use additional SoundStructure C-series units if necessary to add additional conferencing microphones to a SoundStructure system. Figure: SR-12 Supporting Additional Output Signals...
  • Page 185: Expanding Or Contracting An Existing Project

    Design Guide for Polycom SoundStructure Studio C16, C12, C8, and SR12 SoundStructure Studio 1.9.0 Expanding or Contracting an Existing Project A configuration file for a single device may be expanded to support additional SoundStructure devices or a configuration file for multiple devices may be contracted to operate on fewer SoundStructure devices by opening the source configuration file offline, navigating to the Wiring page, and using the Edit Devices button as shown in the following figure.
  • Page 186 Design Guide for Polycom SoundStructure Studio C16, C12, C8, and SR12 SoundStructure Studio 1.9.0 select the equipment and click Add. When finished changing the equipment, press Next to continue to step Figure: Adding Equipment In the second step of the Convert Project Devices wizard, any channels that no longer fit into the system if the size of the system was reduced must now be removed.
  • Page 187: Creating A New Project

    Design Guide for Polycom SoundStructure Studio C16, C12, C8, and SR12 SoundStructure Studio 1.9.0 the case in this example because an entire SoundStructure device was added, the left pane is empty as shown in the following figure. Figure: New Channels Fitted into a New System The result of the Edit Devices operation is a new configuration file that can be edited.
  • Page 188 Design Guide for Polycom SoundStructure Studio C16, C12, C8, and SR12 SoundStructure Studio 1.9.0 2 On step 3 of the design process, either select the default equipment (if it matches your target devices) or manually change the equipment to match the equipment that you already have. Add the equipment in the order that you have the devices OBAM linked together.
  • Page 189 Design Guide for Polycom SoundStructure Studio C16, C12, C8, and SR12 SoundStructure Studio 1.9.0 Figure: Wiring Information for Configured Devices Polycom, Inc.
  • Page 190: Uploading Configuration Files

    Design Guide for Polycom SoundStructure Studio C16, C12, C8, and SR12 SoundStructure Studio 1.9.0 Uploading Configuration Files To upload a configuration to the SoundStructure system, open the configuration file within SoundStructure Studio. Select Connect to Devices and find the SoundStructure system to receive the configuration file as shown in the following figure.
  • Page 191 Design Guide for Polycom SoundStructure Studio C16, C12, C8, and SR12 SoundStructure Studio 1.9.0 Any detected SoundStructure systems may be expanded to show the individual devices that are part of the system by clicking the “+” sign next to the system name. The result displays as shown in the following figure.
  • Page 192 Design Guide for Polycom SoundStructure Studio C16, C12, C8, and SR12 SoundStructure Studio 1.9.0 If the actual SoundStructure target devices do not match the devices in the configuration file, SoundStructure Studio presents the option of either correcting the mismatch or not uploading the configuration file as shown in the following figure.
  • Page 193: Controlling The Soundstructure System

    Design Guide for Polycom SoundStructure Studio C16, C12, C8, and SR12 SoundStructure Studio 1.9.0 If the target equipment does not support all the inputs and outputs that the project requires as shown in the following figure, then the project must either be scaled back or the number or type of target devices increased.
  • Page 194: Accessing Soundstructure Logs

    Design Guide for Polycom SoundStructure Studio C16, C12, C8, and SR12 SoundStructure Studio 1.9.0 following example, the IP address of the system is 192.168.1.100 as that is the IP address of the master SoundStructure device. Figure: Master Device IP Address Example...
  • Page 195: Connecting Polycom Microphones

    HDX Ceiling Mic 1 PHONE LINE C-LINK2 OBAM POLYCOM POLYCOM POLYCOM POLYCOM When Polycom microphones are connected across multiple SoundStructure devices, the same numbering sequence applies. For example, designing a large system with eight Polycom microphones may be wired Polycom, Inc.
  • Page 196 Design Guide for Polycom SoundStructure Studio C16, C12, C8, and SR12 SoundStructure Studio 1.9.0 as shown in the next figure with the first four microphones connected to the master SoundStructure device and the next four microphones connected to the slave SoundStructure device.
  • Page 197 Design Guide for Polycom SoundStructure Studio C16, C12, C8, and SR12 SoundStructure Studio 1.9.0 The Wiring page for this configuration is shown in the following figure with the first four Polycom microphones on the SoundStructure C16 (bus id 1) and the remaining four Polycom microphones on SoundStructure C12 (bus id 2).
  • Page 198: Connecting Multiple Polycom Video Codec Conferencing Systems

    Polycom Video Codec conferencing system as shown in the following figure. Each Polycom Video Codec requires one connection to an available CLink2 port on the rear panel of a SoundStructure device and only one Polycom Video Codec may be connected per SoundStructure device.
  • Page 199 "Mics". When using multiple Polycom Video Codecs over Clink2, if any Polycom Video Codec is told to mute via a button press on a microphone, an IR key press, or a control system command to the Polycom Video Codec, then the channels defined by "Mics"...
  • Page 200 If the virtual channel names “Mics” and “Amplifier” are not defined, then nothing is muted and no volume is adjusted on the SoundStructure when one of the Polycom Video Codecs has its mute status changed or volume adjusted.
  • Page 201: Installing Soundstructure Devices

    Wiring The Devices One of the most important steps when working with SoundStructure devices is to ensure the physical cabling (for instance what’s plugged into input 3) of the system exactly matches how the virtual channels are defined. Polycom, Inc.
  • Page 202 - regardless of how the system is physically cabled. As a system is being designed with SoundStructure Studio, the SoundStructure Studio software defines the virtual channels and then uses the virtual channels with all subsequent operations on those channels. Polycom, Inc.
  • Page 203 In this figure table microphones 1 through 8 are connected to physical inputs 1 through 8, the program audio is connected to input 9 and the VSX8000 input is connected to input 10. On the outputs, the amplifier output is connected to physical output 2 and the VSX8000 output channel is connected to physical output 1. Polycom, Inc.
  • Page 204 Rewiring the system virtually requires moving signals on the wiring page. This can be done by clicking and dragging the virtual channels signals to their desired inputs and outputs. It is generally simpler to move the virtual signals than the physical wiring. Polycom, Inc.
  • Page 205: Uploading A Configuration File

    Once the signal wiring is completed, the next step is to upload the settings to the device. Uploading A Configuration File Configuration files are uploaded to a SoundStructure device or downloaded from a SoundStructure device by using the SoundStructure Studio software. Polycom, Inc.
  • Page 206 The SoundStructure system names that are found are shown with their System Name (see Managing SoundStructure Systems for information on how to set the system name), IP address or serial port, and MAC address. The MAC address may be found by looking inside the front panel door on the SoundStructure device. Polycom, Inc.
  • Page 207 If the Serial control is checked, the system also searches for devices over the RS-232 interface as shown in the following figure. Any discovered devices are displayed and the baud-rate and flow control settings required to connect to those devices are displayed. Polycom, Inc.
  • Page 208 The audio is unmuted after the upload of the configuration file has been completed. Once the file has been uploaded, the settings are stored in the non-volatile memory of the device. Polycom, Inc.
  • Page 209: Downloading A Configuration File

    When the Ethernet interface is used, the file transfer time is reduced to less than two minutes. After connecting to a device as described in the previous sections, click on the System name - SoundStructure System in this example - to navigate to the firmware update page shown in the following figure. Polycom, Inc.
  • Page 210 Click on Open and navigate to the directory that contains the firmware file to upload as shown in the following figure. Firmware File Select the file by double clicking on the desired file name. Once the file has been selected, the firmware update page displays as in the following figure. Polycom, Inc.
  • Page 211: Configuring The Signal Gains

    Once the SoundStructure device settings are synchronized with SoundStructure Studio, either by uploading or downloading a configuration file, the next step is to ensure the input signals have the proper analog gain to get to the 0 dBu nominal signal level of the SoundStructure devices. Polycom, Inc.
  • Page 212: Input Signal Level Adjustment

    VU meter. The VU meter drives the meter segment display while the peak meter shows the maximum amplitude. The peak meters conform to the IEC 60268-18 standard and have a 12dB/second decay from the peak signal levels. Polycom, Inc.
  • Page 213 48dB. Sensitivity Information for Tabletop Microphones Sensitivity (dBV/Pa) Microphone gain (dB) Sensitivity (mV/Pa) -50.0 70.0 -48.0 68.0 -46.0 66.0 -44.0 64.0 -42.0 62.0 -40.0 60.0 10.0 -38.0 58.0 12.6 -36.0 56.0 15.8 -34.0 54.0 -32.0 52.0 25.1 Polycom, Inc.
  • Page 214: Room Gain

    The following figure shows different room gain measurements that may be found in a typical room. Room gain is considered good if it is negative, meaning that the echo picked up by the microphone is less than the Polycom, Inc.
  • Page 215 Polycom, Inc.
  • Page 216: Telephony Signal Levels

    20dB of gain may be applied at the phone input gain. The Phone Out fader adjusts the signal level transmitted to the phone line. Any adjustments made to the output fader is reflected in the meter activity of the Phone Out channel. Polycom, Inc.
  • Page 217 Input and Output Signal Meters Polycom, Inc.
  • Page 218: Output Signal Levels

    After the output level has been set appropriately for the next piece of equipment in the signal chain, volume adjustments should be done with the fader control and adjustments in level made in the fader is shown as more or less signal in meter next to the fader control. Polycom, Inc.
  • Page 219 SoundStructure noise generator and an SPL meter. If there are no SPL meters than can be used, the ears of the local participants can be used to help set a comfortable level in the room. Polycom, Inc.
  • Page 220 1 If there isn’t already a signal generator as part of the project, add a signal generator to the project by selecting Edit Channels and select the Signal Generator as shown in the following figure. Polycom, Inc.
  • Page 221 3 Turn down the audio amplifier to the lowest possible volume setting (alternatively the highest amount of attenuation). The noise generator is loud in the next step and it is best to reduce the gain on the amplifier prior to sending noise into the room. Polycom, Inc.
  • Page 222 Pink noise may be heard in the room depending on the amplifier volume settings. 6 Adjust the audio amplifier volume knob until the SPL meter, positioned at the listener’s ear position, measures approximately 75dB SPL C-weighted. Polycom, Inc.
  • Page 223: Presets

    When full presets are executed there are two distinct events that happen. First the default values for all parameters are restored and then the full preset is restored. The analog outputs of the system are muted during the time it takes to execute the full preset. Polycom, Inc.
  • Page 224: Preset Operation

    API command. Any parameter within SoundStructure may be adjusted with a partial preset. Partial presets are similar to the concept of macros in the Polycom Vortex products.
  • Page 225: Saving Presets

    The preset page shows the presets and also the preset contents to make it possible to determine the settings that are in each preset. The column headings may be selected to sort the preset based on the Polycom, Inc.
  • Page 226 This is the way to get access to the individual parameters that if multiple parameters are associated with a parameter such as the AEC reference. Value This is the value that the action applies to the parameter of the Row Channel or at the Row Channel and Col Channel. Polycom, Inc.
  • Page 227: Creating Partial Presets

    If an entry is removed from a full preset, the full preset becomes a partial preset. If there is only one full preset, entries in the preset may not be deleted or added to ensure there is at least one full preset. Polycom, Inc.
  • Page 228 Once a line is deleted from a full preset, it becomes a partial preset automatically. Removing Presets Creating Partial Presets Manually New partial presets may be created by selecting ‘New Partial’ as shown in the following figure. Creating Presets Polycom, Inc.
  • Page 229 The column headers of the partial preset may not be sorted as this would change the execution order of the partial preset. However the column widths may be adjusted on the preset content table to allow showing the full parameters that are being added. Polycom, Inc.
  • Page 230 Shows the last command that was recorded. Number of Commands Shows the number of commands that have been recorded with the partial preset. Once recorded, the presets are available for review and manual editing in the Presets page. Polycom, Inc.
  • Page 231: Running Presets

    Once the full preset has finished running, a ‘ran’ command acknowledgment is generated as shown next. ran “Power-On” Polycom, Inc.
  • Page 232: Removing Presets

    Presets may be removed from the system by left clicking on the preset and then clicking Remove Preset. If the power-on preset is removed and the system rebooted, the system boots into the current settings if they have been stored in the configuration file. Polycom, Inc.
  • Page 233: Using Events, Logic, And Ir

    SoundStructure such as executing presets, or muting microphones. Events are also used to integrate the Polycom IR remote controller with a SoundStructure device, allowing the different key presses to execute functions within SoundStructure such as taking the PSTN interface offhook, dialing digits, or muting microphones.
  • Page 234: Triggers

    Both Boolean parameters (with values of only 0 or 1, e.g., mute state) and numeric parameters (with values from a min to a max value, e.g., fader value) may be mapped. Polycom, Inc.
  • Page 235 -100 to +20 dB range. Using a min/max range on the output parameter is shown on the right side of the figure where the user min has been set to -20 and the user max has been set to +10. Polycom, Inc.
  • Page 236: Creating Events With Soundstructure Studio

    Disabling events is intended to simplify troubleshooting a system that may have many events. Once events are enabled, the trigger is re-evaluated for all map actions and the resulting action executed. The Enable All and Disable All buttons enable or disable all events that have been defined. Polycom, Inc.
  • Page 237: Event Entries In The Logs

    Oct 10 23:05:18 gcp: sts: event "Table Mic C Mute Event" triggered Oct 10 23:05:18 gcp: ack: [all] val mute "Table Mic C" 1 Oct 10 23:05:18 gcp: ack: [all] val clink_mute 1 1 Oct 10 23:05:18 gcp: ack: [all] val mute "Table Mic" 1 Polycom, Inc.
  • Page 238: Removing Events With Studio

    For example, ● If a Polycom Video Codec is added to a project, new events for volume control and mute are created. These new events replace the pre-1.3 requirement to use the virtual channel names “Mics” and “Amplifier”.
  • Page 239 Names of Microphones and Amplifiers Polycom Video Codec Integration Events The following events are automatically generated when a Polycom Video Codec is designed as part of a SoundStructure project. Automatically Generated Events Event Name Description Polycom Video Codec to Maps user volume adjustments from the Polycom Video Codec (from Polycom...
  • Page 240 SoundStructure PSTN Interface Events The events in the following table are automatically generated when SoundStructure telephony interfaces and Polycom table or ceiling microphones are designed as part of a SoundStructure project. Automatically Generated Events for SoundStructure Telephony Projects Event Name...
  • Page 241 When the microphone switch is closed, toggles the value of clink_mute. Clink to Mics Mute Maps the mute of the Polycom Video Codec to mute “Mics” on SoundStructure when all microphones are to be muted Clink Mute Link 1 to 2...
  • Page 242: Polycom Ir Remote

    If the microphone gates off (am_gate=0), the LED is turned off (digital_gpio_state=0). Polycom IR Remote In stand-alone SoundStructure applications without an , the Polycom IR remote can be Polycom Video Codec used to control SoundStructure devices that have both version 1.3 firmware and an external IR remote Polycom, Inc.
  • Page 243 To use the IR remote transmitter, add a Polycom IR remote to the project and connect the receiver physically to the SoundStructure as shown in the following figure. IR Remote Receiver Connected to SoundStructure Device All the keys on the IR remote may be used as sources of events. The individual keys are selected in an event by specifying a trigger that is equal to the key of interest.
  • Page 244 As an example, consider the event for the adjusting the volume of the system. In this example, the trigger equals 59 which is the value of the volume up key on the remote. When key 59 is pressed, the fader for the amplifier is incremented by 1dB. Polycom, Inc.
  • Page 245 Adjusting Events for System Volume The full list of events created when and Polycom IR Remote is added to a project is shown in the following table. Events Created for Polycom IR Remote Event Name Description IR Remote Vol Down Held Decrements the fader for “Amplifier”...
  • Page 246: Polycom Ir Remote Channel Id

    Runs the preset “Polycom IR Remote Preset” The automatically generated events may be customized to suit a particular application and additional events for the other key presses on the Polycom IR remote may be added by using the Add Events feature. Polycom IR Remote Channel ID SoundStructure Studio creates projects assuming the Polycom IR remote has the default Channel ID of 3.
  • Page 247: Logic Ports

    ● One analog logic input on each connector for a total of two analog logic inputs ● One 5V supply on each connector for a total of two 5V supply pins ● One signal ground on each connector for a total of two signal grounds Polycom, Inc.
  • Page 248: Digital Logic Inputs

    1 due to the internal pull-up resistor. A dry contact closure is one where there is no voltage externally applied to the contacts – it is simply an open or closed circuit. Polycom, Inc.
  • Page 249 When the logic switch is closed, as shown in the figure below, the logic value reads the value 0 (low) indicating that the contact has been closed. Closed Remote Control Contact Closure Example The logic inputs are internally debounced and can detect changes in the contact closures as short as 100msec. Polycom, Inc.
  • Page 250: Analog Logic Inputs

    LED’s and relays with minimal additional circuitry. Please note that only positive external voltages, such as the +5V supply on pin 1, should be used with the logic output pin. Each logic output pin is capable of sinking 60mA of current. Polycom, Inc.
  • Page 251: Logic Arrays

    When defining logic array pins, the pin with the highest array index is the most significant bit. As shown in the figure, creating a two pin logic input array creates TwoPinArray[2] and TwoPinArray[1] pins as part of the array TwoPinArray. TwoPinArray[2] is the most significant bit in the two bit word. Polycom, Inc.
  • Page 252 Pin 1and to limit the voltage and current to a safe level for the LED. Increasing the series resistor value decreases the current through the circuit and also decreases the voltage at the input to the LED, reducing the brightness of the LED. Polycom, Inc.
  • Page 253: Viewing Event Examples

    In this example, two presets are selected in the SoundStructure device, “Combine” and “Split”. The goal of this application is to have a logic input select which preset is executed based on the state of the logic switch. Polycom, Inc.
  • Page 254 Step 1: Use the Edit Logic button to add a single Digital Logic Input. From the Events page select the Edit logic button and select a single digital logic input pin. Use a name for the pin that makes sense to you. In this example the pin is called “Combine Switch”. Polycom, Inc.
  • Page 255 After adding these two events, the event page shows both events. From the events page is it easy to see that when the switch is closed the split preset are run and when the switch is open the combined preset is Polycom, Inc.
  • Page 256: Viewing Push To Talk Microphones With Leds Example

    If this is a new system, then use the logic input and logic output modes on the edit channels control to automatically add the logic inputs and outputs and events when the microphone inputs are defined. Polycom, Inc.
  • Page 257 1 to clink_mute on device 2 and so on and finally map the clink_mute on device N (N may vary from 2 to 8) back to the clink_mute on device 1 to ensure the mute state is synced across multiple SoundStructure devices. Polycom, Inc.
  • Page 258 Mics group. Now whenever the PTT microphone button is pushed, the clink_mute parameter toggles and any change in the clink_mute parameter is mapped directly to the mute state of “Mics” causing all microphones in the “Mics” group to be muted. Polycom, Inc.
  • Page 259 Remember, if you have microphones across multiple SoundStructure devices you will require events that will map the clink_mute of device 1 to the clink_mute of device 2, and so on to ensure the clink_mute parameter on all devices is synchronized together. Polycom, Inc.
  • Page 260: Viewing Push And Hold To Temporarily Mute A Microphone

    Step 1: Add the logic input button. Use the edit logic button to add a digital logic input. As with other examples, check the wiring page to confirm that the logic input is on the desired logic input pin. Polycom, Inc.
  • Page 261: Viewing The Phone Off Hook Drives A Relay Example

    In this example, the status of the phone_connect parameter will be used to drive a logic output that is connected to a relay that can control an external circuit for illuminating a sign to indicate the phone is offhook. Polycom, Inc.
  • Page 262 Step 1: Add the logic output that will be used to drive the relay In this example, an analog logic output called “Phone Connect Status” was created. Polycom, Inc.
  • Page 263: Viewing The Volume Knob Adjusts "Amplifier" Fader Example

    (phone_connect = 1) then the logic output will allow current to flow and the relay will energize. The invert option is not necessary in this example. Viewing the Volume Knob Adjusts “Amplifier” Fader Example In this example, a volume knob will be used to control volume of an output named “Amplifier”. Polycom, Inc.
  • Page 264 Step 1: Add the analog logic input In this example a single Analog Logic Input was created and named this logic input Volume Knob . Polycom, Inc.
  • Page 265: Viewing The Gating Information Sent To A Control System Example

    In this example, a logic output will be used to indicate that a particular microphone has gated on. When the gate status changes, the logic output will change and the SoundStructure system will send a command acknowledgment that could be used by a control system to indicate that a microphone has gated on. Polycom, Inc.
  • Page 266 Step 1: Add the Logic Output pin In this example, a single logic output pin called “Mic 1 Gate” is created. Check the wiring page and the logic connections to a desired logic output pin if required. Polycom, Inc.
  • Page 267: Positioning A Polycom Video Codec Camera Example

    Positioning A Polycom Video Codec Camera Example In this example, camera gating information will be used to send a command to a video codec over the serial interface of SoundStructure.
  • Page 268: Creating Soundstructure Events Best Practices

    SoundStructure system from an external control system or SoundStructure Studio. Creating SoundStructure Events Best Practices When creating SoundStructure events, the following recommendations will make it easier to use events. 1 Define logic inputs and outputs before trying to use logic inputs or outputs with events. Polycom, Inc.
  • Page 269 5 Use the event enable/disable option if it is necessary to isolate and test individual events 6 Select event names that are meaningful to make it easier to interpret the event list Polycom, Inc.
  • Page 270: Managing Soundstructure Systems

    10/100 Mbps communication with Auto-MDIX (medium dependent interface crossover) capability. Auto-MDIX enables the use of either a standard CAT5e cable or cross-over cable to connect to an Ethernet network. The SoundStructure device will detect either connection and work properly. Polycom, Inc.
  • Page 271: Dynamic Ip Addresses

    SoundStructure Studio will display a list of systems found on the network interface specified by the Search Network option. The SoundStructure systems that are found will be shown with their system name, IP addresses, MAC addresses, and firmware version as shown in the following figure. Polycom, Inc.
  • Page 272 SoundStructure Systems Listed in SoundStructure Studio By default the system name is set to “SoundStructure System” as shown in the next figure. Polycom, Inc.
  • Page 273: Link-Local Ip Addresses

    SoundStructure device powers up. The link local addressing makes it possible to connect to a computer directly to a SoundStructure device with either a straight-through or crossover Ethernet cable with- out either having to set a static IP address or having a DHCP server available. Polycom, Inc.
  • Page 274: Static Ip Addresses

    (if that creates a conflict the system will continue until it finds an available address) Static IP Addresses SoundStructure devices may also be assigned a static IP address directly from SoundStructure Studio or manually via the API and a terminal session. Polycom, Inc.
  • Page 275 1 and subsequent connected devices will have sequential device id’s ranging from 2 to the number of devices assuming the OBAM interface is connected from OBAM in to OBAM out as described in Introducing the Polycom SoundStructure Product Family Introducing SoundStructure Design Concepts.
  • Page 276: Setting The Time Server

    SoundStructure systems are controlled and configured with the SoundStructure API command set via a communication to port 52774. The number of active TCP control sessions on port 52774 is unlimited subject to network bandwidth to access the device. Polycom, Inc.
  • Page 277 For example, if a control session queries the value of the mute status, only that control session will receive the acknowledgment of the mute value. However if the control session changes the mute state, for example, all control sessions will receive an acknowledgment. Polycom, Inc.
  • Page 278: Soundstructure Device Discovery

    239.255.250.250 port 9131 at random intervals between 30 to 60 seconds. The broadcast beacon depends on the particular SoundStructure device model and is formatted as shown below. AMXB<-UUID=001122334455><-SDKClass=AudioConferencer><-Make=Polycom> <-Model=SoundStructureC16><-Revision=1.0.0><Config-Name=SoundStructure C16 Configuration> <Config-URL=http://172.22.2.109/> where 001122334455 is the MAC address of the SoundStructure C16 device in this example. Polycom, Inc.
  • Page 279: Configuring And Accessing The Logs

    The RS-232 port may be used for control sessions or for configuration with SoundStructure Studio. Configuring And Accessing The Logs The SoundStructure device logs include the following information and may be retrieved from the device using SoundStructure Studio. 1 API commands 2 API command responses 3 Error messages Polycom, Inc.
  • Page 280 Aug 29 14:06:19 gcp: ack: [all] val matrix_mute "Mics" "Phone Out" 0 API commands correspond to the commands that were sent to the system and how they were transmitted, IP or RS-232. API command responses show the command acknowledgment and where the response was directed. Polycom, Inc.
  • Page 281: Using The Polycom Realpresence Touch With A Soundstructure System

    Use the RealPresence Touch to Generate a Flash Hook Command Setting Up and Enabling the RealPresence Touch For information on setting up and enabling the RealPresence Touch, refer to the Polycom Touch Devices chapter in the Polycom RealPresence Group Series Administrator Guide at support.polycom.com.
  • Page 282: Placing Calls On The Realpresence Touch

    The Call screen is displayed. Unpair a RealPresence Touch from a SoundStructure System You must unpair the RealPresence Touch device from the Polycom SoundStructure system before you can pair another system to the device. To unpair the RealPresence Touch from a SoundStructure system: 1 From the Home screen, tap Settings >...
  • Page 283: Use The Realpresence Touch To Generate A Flash Hook Command

    ® ™ Using the Polycom RealPresence Touch with a SoundStructure System Use the RealPresence Touch to Generate a Flash Hook Command You can execute a flash command in a call. The Flash command places the phone line on-hook for a proscribed time, restores it to off-hook, then the Private Branch Exchange (PBX) responds with a secondary dial-tone for adding another call participant.
  • Page 284: Soundstructure Studio

    SoundStructure events are used to customize the behavior when muting and adjusting volume. The Polycom Touch Control can also integrate directly with a Polycom Video Codec system. When con- trolling an Video Codec system, a SoundStructure system connected to the Video Codec system over Conference Link2 will be controlled indirectly via the Conference Link2 integration.
  • Page 285: Using A Polycom Touch Control With Video Codec Systems Versus Soundstructure Systems

    Using a Polycom Touch Control with Video Codec Systems Versus SoundStructure Systems To use the Polycom Touch Control, it must be first paired with the system to be controlled. A Polycom Touch Control may be paired either with: ● A video codec system for video conferencing applications (which may include optional SoundStructure devices), or ●...
  • Page 286: Pairing The Polycom Touch Control With Soundstructure

    Preparing the Polycom Touch Control Device: 1 Connect the Ethernet cable to the underside of the Polycom Touch Control device. The Polycom Touch Control, by default, expects to receive an IP address from a DHCP server on the network. To set a static IP address on the Polycom Touch Controller, see Configuring the Polycom Touch Control LAN Properties.
  • Page 287 The Polycom Touch Control device powers on and displays the language selection screen. 4 Choose the desired language and follow the on-screen instructions to pair the Polycom Touch Control device with the SoundStructure system. To Pair the Polycom Touch Control with the SoundStructure System 1 Select SoundStructure from the Connect to Device menu as shown in the following figure.
  • Page 288 IP address field is touched as shown below. If the IP address of the SoundStructure system is not known, use SoundStructure Studio to discover the IP address of the SoundStructure system. 3 Press Connect to initiate pairing. Polycom, Inc.
  • Page 289 IP address of the SoundStructure system, and the confirm that the Polycom Touch Control has a valid IP address and that there is a network route to the SoundStructure system and then press Connect again.
  • Page 290: Polycom Touch Control Administrative Settings

    If the connection is lost the Polycom Touch Control will show a banner across the top of the screen that indicates the connection to the SoundStructure has been temporarily lost as shown in the following figure.
  • Page 291: Configuring The Polycom Touch Control Lan Properties

    • Enter IP address manually — Select if the IP address is not automatically assigned. IP Address If the Polycom Touch Control obtains its IP address automatically, this area displays the IP address currently assigned to the Polycom Touch Control. If you selected Enter IP address manually, enter the IP address here.
  • Page 292: Configuring Polycom Touch Control Regional Settings

    Setting Description Subnet Mask Displays the subnet mask currently assigned to the Polycom Touch Control. If you selected Enter IP address manually, enter the subnet mask here. Default Gateway Displays the gateway currently assigned to the Polycom Touch Control. If you...
  • Page 293: Configuring Security Options

    It is possible to transfer the Polycom Touch Control logs to an external USB storage device. To configure Polycom Touch Control log management: 1 Ensure that a USB device is connected to the USB port on the right side of the Polycom Touch Control device.
  • Page 294 1 From the Home screen, touch and then Updates. 2 Ensure the correct server address is entered in the Server Address field. To use the Polycom server, enter Polycom. The field is not case sensitive. 3 Enable Automatically Check for Software Updates.
  • Page 295: Using The Polycom Touch Control With Soundstructure

    Adding Polycom Touch Control in SoundStructure Studio While up to four Polycom Touch Controls can be added into a project, only one Polycom Touch Control is necessary to create the required events. The additional three supported Polycom Touch Controls are planned for future use.
  • Page 296 Video Codec system were added to the SoundStructure Studio project. In this system, a Polycom microphone channel and a SoundStructure PSTN telephony channel are also part of the project and there are events that were created to support those channels. See...
  • Page 297 By default, SoundStructure Studio automatically sets the fader min of the “Amplifier” channel to -31 and the fader max to +20. This maps the volume range of the Polycom Touch Control slider from 0 to 51 to the fader range of -31dB to +20dB as shown in the following figure.
  • Page 298 _Clink to Mics Mute The ‘_Clink to Mics Mute’ event maps the mute status from the Polycom Touch Control to the mute of the virtual channel group "Mics". Muting or unmuting the system via the Polycom Touch Control maps that same mute state to the channel or group called "Mics".
  • Page 299: Using Multiple Soundstructure Telephony Interfaces

    Using Multiple Polycom Touch Controls with SoundStructure After a Polycom Touch Control has been designed in the system and the events are created, multiple Poly- com Touch Controls may be paired with the SoundStructure system and used to control the SoundStructure system.
  • Page 300: Using Multiple Polycom Touch Controls With Soundstructure

    All Polycom Touch Controls paired with a SoundStructure system operate synchronously and control the same aspects of SoundStructure system. For example, multiple Polycom Touch Controls may be used to mute and adjust volume in the system and all Polycom Touch Controls will show the same mute and volume status.
  • Page 301: Validating Polycom Touch Control And Soundstructure Integration

    To resolve this situation check the network connections on both the Polycom Touch Control and the SoundStructure system. Touching the i button shows that the Polycom Touch Control is paired with a system but the connection has been lost as shown in the following figure.
  • Page 302 Are the SoundStructure system’s events defined properly? If the Polycom Touch Control is paired with the proper SoundStructure system, the next step to check is whether the events are properly defined within the SoundStructure system.
  • Page 303 Control has been paired with a SoundStructure system, it will neither be possible to dial that telephony inter- face nor receive incoming calls on that telephony interface because the Polycom Touch Control will not be using the proper channel name within the API commands sent to the SoundStructure system.
  • Page 304 Polycom, Inc.
  • Page 305: Integrating Soundstructure With Soundstructure Voip Interface

    SIP-based end-point. This card has been designed to inter-operate with other compatible equipment including application servers, media servers, Internet-working gateways, voice bridges, and other end-points. The SoundStructure VoIP Interface uses the industry-leading Polycom UC Software that is the foundation of the SoundPoint IP and SoundStation IP phones.
  • Page 306: How To Read This Chapter

    Understanding SoundStructure VoIP Interface API Commands Want to learn more about administration of VoIP systems Polycom UC Software Administrators Guide 4.0.1 SoundStructure VoIP Interface Overview The SoundStructure VoIP interface is a plug-in card designed for use with the rear panel slot available on all SoundStructure devices.
  • Page 307 See the command examples at the end of this chapter for more information on dialing two remote participants. ● Support for 12 “lines” means that 12 different extensions can be defined for this card to provide different dial-in numbers for remote participants if necessary. Polycom, Inc.
  • Page 308: Soundstructure System Requirements

    SoundStructure VoIP Interface Firmware version 4.0.1 Support for the SoundStructure VoIP Interface requires version 4.0.1 or later of the Polycom UC Software for the SoundStructure VoIP Interface. By default, the SoundStructure VoIP Interface product ships with version 4.0.1 or later installed.
  • Page 309: Upgrading An Existing Tel1/Tel2 Project To The Soundstructure Voip Interface

    Upgrading an Existing TEL1/TEL2 Project to the SoundStructure VoIP Interface Polycom recommends upgrading telephony cards in a SoundStructure system by working offline with the project file and running the Upgrade Plugin Card Tool with the offline project. Starting with an Online System...
  • Page 310 To change the telephony interfaces in an offline project, select Upgrade Plug-in Card for Example from the Tools menu as shown next. Upgrade Plugin Card Example Polycom, Inc.
  • Page 311 1 Select the plug-in cards to change. For each plug-in card in the SoundStructure system, you have the following options:  Leave the plug-in card as it is,  Change the plug-in card to a different card, or  Remove the plug-in card from the system. Polycom, Inc.
  • Page 312 Consider the example, shown below, where there is a single SoundStructure device and one plug-in card displayed. When there are multiple SoundStructure devices in the system, there may be a plug-in card entry for each device. Upgrade Plugin Example Polycom, Inc.
  • Page 313 TEL1 telephony card that supports only one telephony channel. In this example, as shown below, you must remove one telephony channel from the project before being able to continue with the project conversion. In this case the ‘Unused Channels’ field in the lower right-hand corner of the Upgrade Plug-in Polycom, Inc.
  • Page 314 To complete the upgrade process in this situation, you need to either:  Remove the telephony channel definition that will not be in the upgraded project after the transition from the TEL2 to the TEL1. Remove the channel by selecting it and clicking Remove, or Polycom, Inc.
  • Page 315 To remove the telephony channel, select either the Phone In or Phone Out channel and click Remove. Selecting either the input or output channel will remove the entire telephony channel. Deleting the channel will update the number of Unused Channels, and, if no further channels are needed, you may click Next to continue. Polycom, Inc.
  • Page 316: Creating A New Project With The Soundstructure Voip Interface

    3 Decide to continue to work offline or send the project to an online SoundStructure system. Polycom recommends you continue to work offline. 4 Click Finish to create the updated project with the new plug-in cards that you selected in the process.
  • Page 317 Add. The following figure shows an example system with 8 analog microphones (Table Mics 1 through 8), a SoundStructure VoIP interface (VoIP In), and mono program audio input (Program Audio). 3 Click Next to select the outputs from the system. Polycom, Inc.
  • Page 318 4 In Create A Project - Step 2, select a mono audio amplifier and click Add. The resulting system will look like the following figure. Notice the VoIP Out channel was automatically added when the SoundStructure VoIP Interface was selected. Click Next to proceed to the next step. Polycom, Inc.
  • Page 319 6 In Create A Project - Step 4, you can either send the project directly to the SoundStructure system or to continue to work off line (default). Polycom recommends you continue to work offline and click Finish to complete the project and remain offline.
  • Page 320 The resulting project is shown in SoundStructure Studio. Select the Matrix tab to view the matrix as shown next. Project Matrix By default the audio from the VoIP In and Program Audio channels are routed to the Amplifier while the Program Audio and the echo canceled microphone audio are routed to the VoIP Out channel. Polycom, Inc.
  • Page 321 The wiring page of the new project will show the SoundStructure VoIP Interface installed as shown in the following figure. Project Wiring Page Polycom, Inc.
  • Page 322: Upgrading The Firmware In The Soundstructure System

    IP address of the system or choose a system from the address book. You may also connect to your system over RS-232 if you don’t have an IP connection. 2 Once the system is identified, select the Get configuration from devices option and select Connect as shown next. Polycom, Inc.
  • Page 323 Yes. If the settings have changed since the last preset was executed, you are prompted with the options of Overwrite preset Power-On, Save settings to a new preset, or Discard current settings. If you want to preserve any changes you’ve made to the preset that runs when the system is powered Polycom, Inc.
  • Page 324: Installing The New Plugin Cards

    (or replace) the plug-in cards with the newly selected cards. Power Down the System To power down the system, remove the power cord from the rear of the SoundStructure system. If there are multiple devices in a system, remove power from all the devices. Polycom, Inc.
  • Page 325 LED to indicate that the configuration file that is loaded does not match the hardware. To correct the yellow front panel LED status you will upload the proper configuration file in the next step. Polycom, Inc.
  • Page 326: Uploading The Configuration File

    SoundStructure Studio project status will be solid green as shown next. Green Status Indicator in SoundStructure Studio The system is now ready for the final online setup required by the SoundStructure VoIP Interface to register with the desired call platform. Polycom, Inc.
  • Page 327: Configuring The Soundstructure Voip Interface

    2 Assuming the SoundStructure VoIP Interface gets an IP address, it will request provisioning server information if the DHCP options are set to the default value. 3 If a provisioning server is found, the interface will attempt to log into the provisioning server with the user-supplied credentials. Polycom, Inc.
  • Page 328 If the network address is not listed, then the SoundStructure VoIP Interface did not receive an IP address from a DHCP server and either its network cable must be installed or its IP address must be configured manually through SoundStructure Studio. Polycom, Inc.
  • Page 329 Select Admin and use the default password of 456. Web Configuration Utility Once logged in, you are presented with a series of settings including the model number, part number, MAC address, IP address, UC Software version, and Updater software version as shown next. Polycom, Inc.
  • Page 330 Settings > Network menu as shown next. Setting Ethernet Address The Ethernet settings page displays as shown next. The fields shown are a superset of the fields available via SoundStructure Studio described earlier in Setting an IP address with SoundStructure Studio. Polycom, Inc.
  • Page 331 Dotted-decimal IP Enter the IP address of the primary domain name server. address DNS Alternate Dotted-decimal IP Enter the IP address of the secondary domain name server. Server address DNS Domain Domain name string The phone’s Domain Name System Polycom, Inc.
  • Page 332 Choose the speed of the network on the Ethernet interface. 10FD, 100HD, 100FD, 1000FD See the Polycom UC Software Administrators Guide 4.0.1 for additional information about the advanced settings of Ethernet 802.1x and PAC File Info. The VLAN settings are described in the following table.
  • Page 333: Setting The Provisioning Server Settings

    Web Configuration Utility. Full technical details concerning the SIP setting for the SoundStructure VoIP Interface may be found in the Polycom UC Software Administrators Guide 4.0.1. Additional detail for using the Web Configuration Utility can be found in the Polycom Web Configuration Utility User Guide.
  • Page 334 SoundStructure device configuration file. If you are not using a provisioning server, Polycom recommends using the Web Configuration Utility for setting the VoIP parameters.
  • Page 335 Setting Up the Provisioning Server Enter the provisioning server information settings as shown next. These settings are a superset of the settings that can be configured directly with SoundStructure Studio on the Wiring page. Polycom, Inc.
  • Page 336 (if required). File Transmit Tries 1 to 10 This setting specifies the number of times to attempt a file transfer. Choose a value from 1 to 10. The default is 3. Polycom, Inc.
  • Page 337 If a single alternate DHCP server responds, this is functionally equivalent to the scenario where the primary DHCP server responds with a valid boot server value. If no alternate DHCP server responds, the INFORM query process will retry and eventually time out. Polycom, Inc.
  • Page 338 DHCP option in which the SoundStructure VoIP Interface will look for its boot server. The IP Address must specify the boot server. String The string must match one of the formats described for server address. Polycom, Inc.
  • Page 339: Registering Lines With The Soundstructure Voip Interface

    Vendor-Identifying Vendor Options for Dynamic Host Configuration Protocol version 4. For more information, refer to Technical Bulletin 54041: Using DHCP Vendor Identifying Options With Polycom Phones. Note: DHCP option 125 containing the RFC 3295 formatted data will be sent whenever option 60 is sent.
  • Page 340 Studio when connected to a SoundStructure system as shown next. SoundStructure VoIP Interface MAC Address in SoundStructure Studio If you are not using a provisioning server, you can manually setup one or more line registrations for the SoundStructure VoIP Interface with the Web Configuration Utility. Polycom, Inc.
  • Page 341 SIP URI. For example, if the phone's line is 1002@polycom.com, enter 1002 as the SIP where polycom.com is the server. Or, you can enter 1002@polycom.com. Any address entered will be displayed as the phone's line if the display name and label are not specified.
  • Page 342 11 Triplet 12 Ringback-style 13 Low Trill Precedence 14 Ring Splash Configuring a Call Server To configure the primary call server, continue to the Server 1 settings and enter the appropriate parameters as described in the following table. Polycom, Inc.
  • Page 343 This same information can be set for a second server which will be used if the primary server is not accessible. In addition, you can permanently forward calls to a different number with the Call Diversion options. See the Polycom UC Software Administrators Guide 4.0.1 for additional information. Polycom, Inc.
  • Page 344: Using The Soundstructure Voip Interface With Soundstructure Studio

    The user interface within SoundStructure Studio has been designed to look like the user interface of the SoundPoint IP phones with a dial keypad, line keys, and phone soft keys for initiating and managing calls as shown in the following figure. In addition, there are telephony settings for customizing auto-answer mode Polycom, Inc.
  • Page 345 Phone Settings in SoundStructure Studio Polycom, Inc.
  • Page 346 Phone soft keys The keys displayed vary depending on the call state and can be used to get a new line, end a call, put a call on hold, resume a call, transfer a call, and create conference calls. Polycom, Inc.
  • Page 347: Customizing Soundstructure Telephony Settings

    Line 1 > Ring Type. The default value for the Ring Type is 8 Highest trill to use the Default Ringtone setting from Preferences > Ringtones 9 Highest double trill 10 Beeble 11 Triplet 12 Ring splash 13 Low trill precedence 14 Silent Polycom, Inc.
  • Page 348: Soundstructure Voip Interface Settings On The Wiring Page

    VoIP-specific parameters. You will be prompted to confirm after selecting this option. Before using this option you may want to use the Utilities > Phone Backup and Restore options from the Web Configuration Utility to save the VoIP-specific settings. Polycom, Inc.
  • Page 349: Setting An Ip Address With Soundstructure Studio

    2 Left click on the desired SoundStructure device with the SoundStructure VoIP Interface device as shown next. For SoundStructure system with only one device, the device is already selected. 3 Next click on the Edit Devices Settings portion of the wiring page and then click Edit Network Settings as shown next. Polycom, Inc.
  • Page 350 ● Provisioning Server Settings to manually configure the provisioning server settings if the DHCP Boot Server settings are set to Static or the Ethernet settings are set to Manual. These areas display as shown in the following figure. Edit Network Settings Areas Polycom, Inc.
  • Page 351 If you are using a central provisioning server or temporarily setting up a manual FTP server for a firmware update, you may enter the server information on this page including the type of access to the provisioning server, the server address, username, and password information as shown in the following table. Polycom, Inc.
  • Page 352: Using The Soundstructure Studio Console

    SoundStructure device while configuring the system, and follow the acknowledgment that are returned. Please note that you need to be connected online to control a SoundStructure VoIP Interface. To open the console, right-click on the project name and select Console as shown next. Polycom, Inc.
  • Page 353 This example shows other acknowledgments in addition to the phone_connect acknowledgment. Depending on your system configuration and programmed events, you may other command acknowledgments as a consequence of taking the phone offhook. Data Console Acknowledgments Polycom, Inc.
  • Page 354: Updating Software On The Soundstructure Voip Interface

    Upgrading the Firmware in the SoundStructure System. In the event there is new software available from Polycom’s Web site for SoundStructure VoIP Interface, you can download that firmware and use it to update the plug-in card. You can update the software of the SoundStructure VoIP Interface in several ways, including using a local PC-based FTP/HTTP/TFTP server or using a central provisioning server via FTP or HTTP.
  • Page 355: Upgrading Software With An Existing Provisioning Server

    FTP server has been created. Use the username and password created above as the username and password for the provisioning server settings. Upgrading Software with an Existing Provisioning Server To update the SoundStructure VoIP Interface software via an existing provisioning server, follow these steps. Polycom, Inc.
  • Page 356 3 Copy the file 000000000000.cfg file to the directory specified in step 7 of installing the FTP server. This configuration file tells the SoundStructure VoIP Interface which firmware file to look for when it connects to the FTP server. The contents of this configuration file must have at least the information Polycom, Inc.
  • Page 357: Upgrading Software With The Web Configuration Utility

    SoundStructure Studio wiring as shown below. Upgrading Software with the Web Configuration Utility The Web Configuration Utility provides a convenient way to manage and upgrade the software in your SoundStructure VoIP Interface through a local FTP server or local HTTP server. Polycom, Inc.
  • Page 358 A free and popular Web server, Apache Server, is available for 32-bit Windows at http://httpd.apache.org/download.cgi#apache22 and version 2.2.19 has been tested with the Polycom UC Software. To set up the Web server: 1 Download and install the latest version of Apache Server from http://httpd.apache.org/download.cgi#apache22.
  • Page 359 1 Within the Web Configuration Utility navigate to the Utilities > Software Upgrade menu of the Web Configuration Utility as shown in the following figure. 2 Select the Custom Server option as shown in the following figure. Polycom, Inc.
  • Page 360 Note that steps 3 and 4 could also use an FTP server by replacing all the references to http:// with ftp://username:password@ in the example XML file in step 3 and in the address of the server in this Polycom, Inc.
  • Page 361 If the specified XML file is not found, then an error message will display indicating that it is not possible to communicate to the phone as shown next. If software versions are found, select the version of software from the Software menu and select Install as shown in the following figure. Polycom, Inc.
  • Page 362 7 If you select Yes, then you will be presented with a license agreement to accept or reject. To continue, select Accept. 8 Finally, the system will begin the upgrade process by rebooting the phone and beginning the firmware file transfer. Press Ok to continue. Polycom, Inc.
  • Page 363 Software Upgrade Server has been cleared by clicking Clear Upgrade Server or the SoundStructure VoIP Interface has been factory reset. To clear the Software Upgrade Server 1 Click the Clear Upgrade Server as shown in the following figure. Polycom, Inc.
  • Page 364: Validating A Soundstructure Voip Interface Installation

    These steps are described in more detail in the following sections. Version 1.7.0 or Newer of SoundStructure Studio Used Version 1.7.0 SoundStructure Studio software is required for connecting to a SoundStructure system that has firmware version 1.5.0 or newer and has a SoundStructure VoIP Interface card installed. Polycom, Inc.
  • Page 365 SoundStructure VoIP Status in SoundStructure Studio If the SoundStructure VoIP Interface is booting, the VoIP status will indicate the device is booting and this section of the wiring page will appear as shown in the following figure. The SoundStructure VoIP Interface Polycom, Inc.
  • Page 366 VoIP interface info in the device information area. After you’ve confirmed a SoundStructure VoIP Interface is part of the configured devices installed, check the Edit Channels control to ensure you have a SoundStructure VoIP Interface designed into your project. Polycom, Inc.
  • Page 367 If you don’t have the VoIP interface input and output virtual channels defined in the project, using the Edit Channels control select a VoIP Interface, click Add, and close the Edit Channels control. Use the File > Save option to save your file to ensure your new channel definition will survive a power cycle. Polycom, Inc.
  • Page 368 SoundStructure VoIP Interface to the local router. From the PC you should be able to reach the SoundStructure VoIP Interface and configure the device via the Web Configuration Utility. Once done, you may reconnect the original network connections. Polycom, Inc.
  • Page 369 If the line appears unregistered on the Phone Settings page, and on the Web Configuration Utility page the Identification settings are correct, check that the transport settings on the line settings page within the Web Configuration Utility is set correctly. Some networks may require TCPOnly. Polycom, Inc.
  • Page 370 For the ‘dot’ in between the IP address octets, use the ‘.’ on your keyboard. The remote endpoint can be a desktop phone or the IP address of a different SoundStructure VoIP Interface being installed. Once the IP address has been entered, click Send as shown next. Polycom, Inc.
  • Page 371 Next, dial the extension of another registered phone and press Send. If you have dialed a valid extension, you will hear the call ring. If you don't have a valid extension to dial, call your own extension and you will see an incoming call display as shown next where extension 1029 has dialed extension 1029 Polycom, Inc.
  • Page 372: Voip Interface Logs

    VoIP Interface Logs You may view the logs of the SoundStructure VoIP Interface with the Web Configuration Utility by navigating to the Diagnostics > View & Download Logs. There are two types of logs available: Boot and App. Polycom, Inc.
  • Page 373 1117164420|sip |4|00|Registration failed User: 1234, Error Code:404 Not Found If a the call server is not available or the server IP address is not correct, the log may contain a message as follows: 1117161439|pmt |4|00|Login failure. 1117161441|sip |4|00|Registration failed User: 200024, Error Code:480 Temporarily not available Polycom, Inc.
  • Page 374: Back Up And Restore The Voip Specific Settings

    2 Enter a filename to store the settings. The default filename includes the MAC address, the device type, and the current date and time as shown in the following figure. 3 Click Save to store the settings in a text file that can be viewed with any text editor. Polycom, Inc.
  • Page 375 Once the file is opened, the settings will be restored to the SoundStructure VoIP Interface. Global Settings The SoundStructure VoIP Interface settings may be reset to factory default values by clicking the Restore button in the Global Settings section as shown in the following figure. Polycom, Inc.
  • Page 376: Importing And Exporting Voip Parameter Settings

    Config Files Exports the parameters from the configuration files which includes line registration information. This file is useful if you want to take the line registration from one system, customize it, and reuse it in a different system. Polycom, Inc.
  • Page 377: Soundstructure Log Information

    Jul 28 05:25:40 lcp: sts: VoIP plug-in card booted successfully At the end of the SoundStructure system log there will be a summary (shown next) of the SoundStructure information and the SoundStructure VoIP Interface settings. ======================================== ============== system info ============= ======================================== sys_name: SoundStructure System sys_num_devs: 1 dev_bus_id Polycom, Inc.
  • Page 378 5.0.1.2999 16-Sep-11 07:05 voip_uc_sw_ver Mink 4.0.1.4394 16-Sep-11 06:41 file sip.ld voip_dhcp_boot_serv static voip_dhcp_boot_serv_opt voip_dhcp_boot_serv_type string voip_dhcp_option_60_type ascii_string voip_eth_settings [mode] dhcp voip_eth_settings [addr] 192.168.1.118 voip_eth_settings [dns] 192.168.1.1 0.0.0.0 voip_eth_settings [gw] 192.168.1.1 voip_eth_settings [nm] 255.255.255.0 voip_eth_vlan_id voip_prov_serv_address 192.168.1.200 voip_prov_serv_type voip_prov_serv_user username voip_status Polycom, Inc.
  • Page 379: Information Required For Support

    Information Required for Support Polycom’s Technical Support team is ready to help our integration partners ensure their equipment is functioning properly. For specific questions regarding integration with a VoIP PBX or call management platform, you should contact the IT/Phone integration specialist in your organization or at your end user’s installation.
  • Page 380 Displays the city field when the Lync Server is configured with voip_loc_city location information. Corresponds with the loc.Info.x.A3 Polycom UC software parameter. Displays the company name field when the Lync Server is voip_loc_company_name configured with location information. Corresponds with the Polycom UC software parameter.
  • Page 381 SoundStructure VoIP Interface API Commands Displays the country field when the Lync Server is configured voip_loc_country with location information. Corresponds with the Polycom UC software parameter. loc.Info.x.country Displays the description field when the Lync Server is configured voip_loc_description with location information. Corresponds with the Polycom UC software parameter.
  • Page 382: Using The Soundstructure Api

    # If the remote party answers at extension 2029 then the call # is connected. # Alternatively, you can now dial the digits first and as # long as you take the phone off hook within 20 seconds of dialing, Polycom, Inc.
  • Page 383: Hanging Up A Call

    # Once the call is on hold, you will get the confirmation with the # voip_call_appearance_state acknowledgment val voip_call_appearance_state "VoIP Out" 1 ncas_call_hold # To resume the call, use the voip_resume command set voip_resume “VoIP Out” # Once you have the acknowledgment that the line is connected, Polycom, Inc.
  • Page 384: Forwarding An Incoming Call

    This example shows how you can dial a call, connect to the remote party (extension 2029 in this example), and then perform a consultative transfer of that call to a different extension (extension 5148 in this example). # Dial the desired number Polycom, Inc.
  • Page 385: Blind Transfer Of A Call

    # Dial the desired number set phone_dial "VoIP Out" "2029" val phone_dial “VoIP Out” “2029” # Take the phone offhook to send the digits to the call server set phone_connect "VoIP Out" 1 val phone_connect “VoIP Out” 1 Polycom, Inc.
  • Page 386: Dialing Two Calls On The Same Line

    # Once you know the call is connected by waiting for the # voip_call_appearance_state set to connected val voip_call_appearance_state "VoIP Out" 1 connected # Then you can use the conference feature to place the connected # call on hold and get a new dialtone set voip_conference “VoIP Out” Polycom, Inc.
  • Page 387: Dialing Two Calls On Different Lines

    # voip_call_appearance_state is set to connected val voip_call_appearance_state "VoIP Out" 1 connected # Then you can put the first call on hold set voip_hold “VoIP Out” # Once the call is on hold, the call appearance state will change # to ncas_call_hold Polycom, Inc.
  • Page 388: Soundstructure Api Behavior Changes

    Preset The run action for presets has been enhanced to provide an immediate “run Preset” acknowledgement once the preset begins execution. After the preset has finished executing, the “ran Preset” acknowledgment is Polycom, Inc.
  • Page 389 Once the system has finished booting, the connection from pins 8 to 9 can be removed. The RS232 port with pins 8 and 9 shorted together is shown next. Pins 8 and 9 on the RS 232 Interface Polycom, Inc.
  • Page 390: Adding Authentication To Soundstructure Systems

    To use SoundStructure authentication, the following versions of software are required. To get the latest software versions, visit SoundStructure Support to download the required versions of software for your SoundStructure system. SoundStructure Firmware version 1.6 This firmware version is fully compatible with configuration files created with earlier versions of SoundStructure Studio. Polycom, Inc.
  • Page 391: Enabling Authentication On A Soundstructure System

    Once connected to the SoundStructure System, follow these steps. 1 Navigate to the system page by clicking on the system name, SoundStructure System, as shown in the following figure. 2 Change the Authentication mode from Open to Authenticated. Polycom, Inc.
  • Page 392: Discovering A System With Authentication

    Using SoundStructure Studio version 1.8 or newer, a system may be discovered by selecting Connect > Search for Devices. Assuming your computer running SoundStructure Studio is on the same subnet as the desired SoundStructure systems, the discovery process will find SoundStructure devices as shown in the Polycom, Inc.
  • Page 393 Selecting an authenticated system and clicking Connect with SoundStructure Studio v1.8 or newer does not cause the Authentication dialog to display, as shown in the following figure. Authentication Dialog To connect to the system, enter the system password and click Ok. Polycom, Inc.
  • Page 394: Removing Authentication From A Soundstructure System

    To remove authentication from a SoundStructure System, set the Authentication mode to open and click Apply. SoundStructure Studio will reconnect to the system using port 52774. The password in an open system will still be retained, but will not be required to connect to the system when it is open mode. Polycom, Inc.
  • Page 395: Viewing Soundstructure Command Logs

    52775 can authenticate as follows, assuming the password of the system is 456: authenticate "admin" "456" The SoundStructure device will send back the response: authenticated Once authenticated, SoundStructure API commands can be sent and the associated command acknowledgements will be received. Polycom, Inc.
  • Page 396 SoundStructure system. The white-list commands are shown in the following table. White-List of Commands White-list Parameter Names clink_num_attached dev_status dev_type dev_firmware_ver dev_habanero_ver dev_hw_eco dev_hw_rev dev_plugin_type dev_uptime dev_temp dev_temp_status dev_volt_clink dev_volt_neg_15 dev_volt_phantom dev_volt_pos_15 eth_auth_mode eth_mac eth_settings Polycom, Inc.
  • Page 397 LED flashes green, remove the connection between pins 8 and Pin 8 and Pin 9 After the system has finished booting, the system is in a factory reset state with no configuration file settings. Polycom, Inc.
  • Page 398: Soundstructure Authentication Api Command Summary

    Used to set the authentication mode to either open or auth. When set to open, TCP communication occurs over port 52774 and TCP communication over port 52775 is disabled. When set to auth, TCP communication occurs over port 52775 and TCP communication over port 52774 is disabled. Polycom, Inc.
  • Page 399 This parameter returns the total number of Ethernet connections to the system and is equal to the sum of sys_num_auth_connections + sys_num_open_connections. sys_num_open_connections This parameter returns the total number of Ethernet connections for which eth_auth_mode is open. Polycom, Inc.
  • Page 400: Creating Advanced Applications

    This simple example is designed to show how to get started designing with the SoundStructure products. In this example, one microphone and a Polycom VSX8000 are used with a SoundStructure C8 device. The block diagram of this system is shown in the following figure. The channel names are labeled with the virtual channel names that are created by default by the SoundStructure Studio software.
  • Page 401: Soundstructure Studio Steps

    SoundStructure Studio Steps Step 1 - Select Inputs For the first step, select one table top microphone and a VSX8000 mono video codec. Polycom, Inc.
  • Page 402 Step 2 - Select Outputs For the second step, select a mono amplifier as the output source. The VSX8000 output is automatically defined when the VSX8000 input is selected. Polycom, Inc.
  • Page 403 Step 3 - Select Equipment Select the equipment required to create this design. By default a SoundStructure C8 is selected. Polycom, Inc.
  • Page 404: Using The Channels Page

    Amplifier can accept the nominal 0dBu level from the SoundStructure device, allowing the SoundStructure Amplifier output to have 0dB output gain. If the Amplifier input has an RCA connection, the Amplifier output gain adjusted from 0dB to -10dB to prevent overdriving the consumer-level input on the Amplifier. Polycom, Inc.
  • Page 405: Using The Matrix Page

    Virtual Channels and Virtual Channel Groups Using the Matrix Page The matrix page shows how the input signals are mapped to the output signals. In this example, the tabletop Polycom, Inc.
  • Page 406: Understanding Wiring Information

    In this example, Table Mic 1 is connected to physical input 1, the VSX8000 In channel is connected to physical input 2, the VSX8000 Out channel is connected to physical output 1 and the Amplifier channel is Polycom, Inc.
  • Page 407: Controlling The System

    The microphones in the system may be muted either individually or as the “Mics” group by sending the following API command to the SoundStructure device: set mute “Mics” 1 will mute all the microphone in the system and set mute “Mics” 0 will unmute the microphone in the system. Polycom, Inc.
  • Page 408: Creating Four Digital Array Microphones And A Soundstation Vtx1000 Conferencing System

    Aux In and Aux Out connectors on the VTX1000 power supply. ● The VTX1000’s microphones and loudspeaker are not used in this configuration. Digital microphones are used in this example for ease of installation, however traditional analog microphones could also be used in the system. Polycom, Inc.
  • Page 409 Block Diagram for Conferencing System Program Audio VTX1000 Out VTX1000 In Amplifier SoundStructure CLink2 (L) CLink2 (R) Polycom Microphones The From VTX1000 and To VTX10000 signals are wired to the VTX1000 power module as shown in the following figure. Polycom, Inc.
  • Page 410: Soundstructure Studio Steps

    SoundStructure PIN 2: TXD PIN 3: RXD PIN 5: GROUND PIN 7: CTS PIN 8: RTS REMOTE CONTROL 1 RS-232 C-LINK2 OBAM REMOTE CONTROL 2 SoundStructure C16 POTS Powered SoundStation SoundStation Interface Loudspeaker VTX1000 VTX1000 Power Supply Aux In Aux Out SoundStructure Studio Steps The steps to create this project are shown in the following figures.
  • Page 411 Step 2 - Select Outputs Select a mono amplifier as the output source. The VTX1000 output will be automatically defined when the VTX1000 input is defined. Polycom, Inc.
  • Page 412 Step 3 - Select Devices Select the equipment required to create this design. By default the SoundStructure C16 is selected. Note that no telephony card is required as the VTX1000 will be the telephony interface. Polycom, Inc.
  • Page 413: Editing Matrix Settings

    Step 4 - Work Offline Or Online In this step offline operation is selected to create a file for later upload into a SoundStructure C16. Editing Matrix Settings After you have designed the system, click the Matrix label in the project window to view the matrix shown in the following figure.
  • Page 414 The matrix may be collapsed by clicking the up arrows next to the “Mics” group. Because all the microphones are used in the same way, the group crosspoint represents how all the table microphone channels are being used. The result is a compact matrix representation as shown in the following figure. Polycom, Inc.
  • Page 415: Editing Channels Settings

    The channels page associated with this matrix is shown in the following figure. If the channels are collapsed in the matrix, they are also collapsed in the channels page. The AEC block has been expanded to show the AEC reference. Polycom, Inc.
  • Page 416 On the VTX1000 out channel, change the output gain from -5 to -10 as shown in the following figure. This change is to ensure the SoundStructure’s output signals at 0du do not overdrive the input of the VTX1000 which is expecting a -10dBu nominal signal. Polycom, Inc.
  • Page 417 After this output gain change, and any other changes that are made to the file, the next step is to save the settings to the power on preset as shown on the presets page and in the following figure to ensure all changes are stored permanently inside the system. Polycom, Inc.
  • Page 418: Understanding Wiring Information

    The system should be wired according to the layout on the wiring page as shown in the following figure. To wire the system with virtual channels on different physical inputs or outputs, simply drag the channels to their desired locations and then wire the system according to the updated wiring information. The digital Polycom, Inc.
  • Page 419: Controlling The System

    While a control system can be used to adjust volume levels and to mute the signal paths, this example uses the SoundStation VTX1000 to control the telephone line, muting status of the send signal to the remote telephony participants, and the in room level of the telephone signal. Polycom, Inc.
  • Page 420: Creating An Eight Microphones, Video, And Telephony Application Conferencing System

    The room may look similar to the reflected ceiling plan shown in the following figure with in-ceiling loudspeakers, a video screen in the front of the room, and microphones distributed on the table. Polycom, Inc.
  • Page 421: Creating A Project In Soundstructure Studio

    VSX8000 In VSX8000 Out Phone In Phone Out Creating a Project in SoundStructure Studio The steps to create this project are shown in the following figures. The names for the channels are the names that SoundStructure Studio defines. Polycom, Inc.
  • Page 422 Step 1 - Select Inputs Select eight table microphones, a mono program audio source, a VSX8000 mono video codec, and a telephone interface. Polycom, Inc.
  • Page 423 Step 2 - Select Outputs Select a mono amplifier as the output source. The telephone and VSX8000 outputs are automatically defined when their respective inputs are selected. Polycom, Inc.
  • Page 424 Step 3 - Select Devices Select the equipment required to create this design. By default the SoundStructure C12 with a single line telephone card is selected. Polycom, Inc.
  • Page 425: Matrix Settings

    In”. These channels are routed to the “Amplifier” channel so they can be heard in the local room. The microphones “Table Mic 1” through “Table Mic 8” are routed to the “Phone Out”, “VSX8000 Out”, and “SubMix Mics” channels using the conferencing signal path which includes echo and noise cancellation, and Polycom, Inc.
  • Page 426 The matrix may be collapsed by clicking the up arrows next to the “Mics” group. Because all the microphones are used in the same way, the group crosspoint represents how all the table microphone channels are being used. The result is a compact matrix representation as shown in the following figure. Polycom, Inc.
  • Page 427: Channels Settings

    The channels page associated with this matrix is shown in the following figure. If the channels are collapsed in the matrix, they are also collapsed in the channels page. The AEC block has been expanded to show the AEC reference. Polycom, Inc.
  • Page 428: Wiring Information

    The system should be wired according to the layout on the wiring page as shown in the following figure. To wire the system with virtual channels on other physical inputs or outputs, simply drag the channels to their desired locations and then wire the system according to the updated wiring information. Polycom, Inc.
  • Page 429: Controlling The System

    The microphones in the system may be muted either individually or as the “Mics” group by sending the following API command to the SoundStructure device: set mute “Mics” 1 will mute all the microphones in the system and Polycom, Inc.
  • Page 430: Creating A Two Pstn Line Positional "Receive" Audio Conferencing System

    The layout of the room may look like the following figure with two zones of audio driving the ceiling loudspeakers. Polycom, Inc.
  • Page 431 Room Layout for Conferencing System Amplifier 1 Amplifier 2 This system will be designed to include eight table microphones, stereo program audio, two telephony interfaces, and either a stereo amplifier or two mono channel audio amplifiers. Polycom, Inc.
  • Page 432: Soundstructure Studio Steps

    The steps to create this project are shown in the following figures. The names for the channels are the default names created by SoundStructure Studio, although the virtual channel names could be set to any valid text string. Polycom, Inc.
  • Page 433 Step 1 - Select Inputs Select 8 table microphones, a stereo program audio source, and two telephone interfaces. Polycom, Inc.
  • Page 434 Step 2 - Select Outputs Select two mono amplifiers as the output devices for this example. The telephone outputs are automatically defined when their respective inputs are added. Polycom, Inc.
  • Page 435 Step 3 - Select Equipment Select the equipment required to create this design. By default the SoundStructure C12 with a dual-line telephone card is selected. Polycom, Inc.
  • Page 436: Matrix Settings

    In this step offline operation is selected to create a file for later upload into a SoundStructure C12 and dual-line telephony card. Matrix Settings Once the system has been designed, select the Matrix entry on the project window on the left tab to view the matrix shown in the following figure. Polycom, Inc.
  • Page 437 To create the positional solution, route one telephony interface to one amplifier and route the other to the second amplifier. Also, we’ll make the assumption that each amplifier should receive one channel of the stereo program audio. The mapping of the stereo program audio signal to the mono amplifier outputs can Polycom, Inc.
  • Page 438 The program audio is balanced to the left to “Amplifier 1” and to the right to “Amplifier 2”. Mapping of Stereo Program Audio Signal The matrix may be collapsed by clicking the arrows next to the “Mics” group resulting in the compact matrix Polycom, Inc.
  • Page 439: Channels Settings

    Compact Matrix and Telephony Interface Routing Channels Settings The channels page will look like the following figure. The AEC block has been expanded to show the AEC references. Polycom, Inc.
  • Page 440: Wiring Information

    The system should be wired according to the information found in the wiring page and shown in the next figure. To wire the system with virtual channels on other physical inputs or outputs, simply drag the channels to their desired locations and then wire the system according to the modified wiring information. Polycom, Inc.
  • Page 441: Controlling The System

    Project Wiring Information Controlling The System Mute The microphones in the system may be muted either individually or as the “Mics” group as follows: set mute “Mics” 1 will mute all the microphones in the system and Polycom, Inc.
  • Page 442 "Phone 1 In" "Amplifier 2" 1 No change to the AEC reference would be required as the AEC reference uses both “Amplifier 1” and “Amplifier 2” and will work whether there is one or two phone lines connected. Polycom, Inc.
  • Page 443: Creating An Eight Microphones And Stereo Video Conferencing System

    Once the design is completed, the matrix looks very similar to the mono conferencing case with the exception that the “Program Audio”, “VSX8000 In”, “VSX8000 Out”, and “Amplifier” virtual channels have the stereo graphic symbol next to their names signifying they are stereo virtual channels as shown in the following figure. Polycom, Inc.
  • Page 444 Consider the room layout in the following figure that has microphone 1 located at one end of the table at site 1. This microphone has a relative position of being “right” of the camera from the camera’s perspective as shown by the dotted line from the microphone to the camera’s left/right reference line. If you imagine Polycom, Inc.
  • Page 445 In this example microphone 1 is panned to approximately 0.4 right (assuming the edge of the room is considered 1.0) relative to the camera location. The exact amount of panning can be increased to create a wider spatial presence at the remote site. Polycom, Inc.
  • Page 446 The relative position for microphone 1 can be set at the matrix crosspoint to 0.4 as shown in the following figure. This means that the microphone is panned to the right by 0.4. Setting Relative Position ofr Microphone at Matrix Crosspoint The other microphones also have relative positions as shown in the following figure. Polycom, Inc.
  • Page 447 Room Left Right Site 1 By estimating their pan position, the resulting matrix will look like the next figure. As microphones move from right to left relative to the camera, their panning is adjusted from positive to negative. Polycom, Inc.
  • Page 448: Channels Settings

    Since the telephony interface is monaural, no panning of the microphones is possible. Channels Settings Collapsing the “Mics” group and changing to the channels page will show the screen of the following figure. The AEC block has been expanded to show the AEC reference. Polycom, Inc.
  • Page 449: Wiring Information

    The system should be wired according to the information found in the wiring page and shown in the following figure. To wire the system with virtual channels on other physical inputs or outputs, simply drag the channels to their desired locations and then wire the system according to the modified wiring information. Polycom, Inc.
  • Page 450: Controlling The System

    Because the stereo virtual channel names have the same name as the mono virtual channels in the previous example, the SoundStructure API will seamlessly operate on the stereo virtual channel without having to make any change to the control system code. Polycom, Inc.
  • Page 451: Creating An Eight Microphones With The Polycom Video Codec Conferencing System

    Video Codec Conferencing System This example shows how to use 8 analog microphones with a SoundStructure device connected to a Polycom HDX video conferencing system. This system will use the telephony interface that is native to the Polycom HDX system.
  • Page 452 Step 1 - Select Inputs Select eight table microphones and a Polycom HDX video conferencing system. Notice that when the HDX system is selected, there are multiple audio streams that will be transmitted from the HDX to the SoundStructure. Additional information may be found in Connecting Over Conference Link2.
  • Page 453 Step 2 - Select Outputs Select a stereo amplifier as the output source. Notice that the Polycom HDX is already defined as an output and includes multiple audio streams that will be sent to the HDX from the SoundStructure device.
  • Page 454 Step 3 - Select Devices Select the equipment required to create this design. By default the SoundStructure C8 is selected. Polycom, Inc.
  • Page 455: Matrix Settings

    The input virtual channels include microphones that are included in the virtual channel group “Mics” collapsed as shown in the next figure and the remote audio from the Polycom HDX. The Polycom HDX audio channels are routed to the “Amplifier” channel so they can be heard in the local room, and the echo canceled...
  • Page 456: Channels Settings

    Polycom HDX stereo mics stream so they can be sent to the remote video participants .Project Matrix Settings The audio channels from the Polycom HDX system are available as separate audio streams within the SoundStructure matrix.
  • Page 457: Wiring Information

    The system should be wired according to the layout on the wiring page as shown in the following figure. To wire the system with virtual channels on other physical inputs or outputs, simply drag the channels to their desired locations and then wire the system according to the updated wiring information. Polycom, Inc.
  • Page 458: Controlling The System

    “Mics” 0 will unmute the microphones in the system. When connected to the Polycom HDX system, the microphones on the SoundStructure by muting the microphones on the Polycom HDX system. As described in Connecting Over Conference Link2, the HDX Polycom, Inc.
  • Page 459: Encing System

    HDX API or via the HDX IR remote receiver. Telephony The SoundStructure in this example can use the Polycom HDX’s telephony signal as that is a separate stream that is sent from the HDX to the SoundStructure device. The telephony system would be controlled with the Polycom HDX system.
  • Page 460 Zone 2 -6dB -6dB -6dB Zone 3 The block diagram of this system is shown in the following figure. The channel names are labeled with the virtual channel names that are created by default by the SoundStructure Studio software. Polycom, Inc.
  • Page 461: Soundstructure Studio Steps

    Table Mic 8 Wireless Mic Lectern Mic Program Audio (L) Program Audio (R) Phone In Phone Out SoundStructure Studio Steps Creating the design described in the previous section will require a SoundStructure C12 and single line telephony solution. Polycom, Inc.
  • Page 462: Matrix Settings

    To add the reinforcement of the wireless and lectern microphones, the lectern microphone will only be reinforced into Amplifier zones 2 and 3 and not in Amplifier zone 1. Because the wireless microphone may be in any zone, it is reinforced into all zones. Polycom, Inc.
  • Page 463 All microphones are sent to the remote telephony participant as shown with the routing of the conferencing version of the microphones to the “Phone Out” virtual channel. Polycom, Inc.
  • Page 464 The resulting matrix will look like the following figure. Project Matrix Page Polycom, Inc.
  • Page 465: Channels Settings

    The next step is to enable the feedback processing on the wireless and lectern microphone. This can be done from the channels page by clicking on the EQ button for the “Presenter Mics” group as shown in the following figure. Project Channels Settings Polycom, Inc.
  • Page 466 To ensure the wireless microphone will be the active microphone if the presenter with the wireless microphone is picked up by another nearby microphone, the automixer channel bias for the wireless microphone will be set to 6dB as shown in the following figure. Polycom, Inc.
  • Page 467 The AEC reference for the wireless microphone should include the lectern microphone (as that will be reinforced into the room) and any remote audio sources - the phone line in this case, and the program audio material. Polycom, Inc.
  • Page 468 The first step to creating the wireless microphone’s reference is to build this reference by creating a new submix called “WirelessRef” as shown in the following figure. Polycom, Inc.
  • Page 469 The AEC reference for the wireless microphone is assigned to the new submix as shown in the next figure. AEC Reference for Wireless Microphone Polycom, Inc.
  • Page 470 The same approach can be taken with the lectern microphone, creating a submix called “LecternRef” that includes the reinforced wireless microphone, the remote audio sources, and the program audio. The new matrix will appear as shown in the following figure. Project Matrix Page Polycom, Inc.
  • Page 471 Finally, the reference for the table microphones can be set to include both the lectern and wireless microphone references. Since two references can be configured per microphone, the first reference will be set to “WirelessRef” and the second reference will be set to “LecternRef”. Microphone References Polycom, Inc.
  • Page 472 Keep in mind that the “RemoteAudio” channel should not be sent to the “Phone Out” signal to prevent the “Phone In” channel from being routed to the “Phone Out” signal causing a persistent electronic echo of the telephone talker back to the telephone talker. Polycom, Inc.
  • Page 473: Wiring Information

    The system should be wired according to the information found in the wiring page and shown in the next figure. To wire the system with virtual channels on other physical inputs or outputs, simply drag the channels to their desired locations and then wire the system according to the modified wiring information. Polycom, Inc.
  • Page 474: Controlling The System

    “Presenter Mics” 1 and may be unmuted by sending the command set mute “Presenter Mics” 0 The reinforcement of the wireless microphone may be disabled by muting the reinforced crosspoints as shown next. set matrix_mute “Wireless Mic” “Amplifier 1” 1 Polycom, Inc.
  • Page 475: Creating A Sixteen Microphones With Six-Zone Sound Reinforcement Conferencing System

    The layout for this style of room can be seen in the following figure along with the zone definitions. In this room, the lectern microphone will be reinforced into zones 2-6, the wireless microphone reinforced into Polycom, Inc.
  • Page 476: Soundstructure Studio Steps

    Mic 7 Mic 10 Mic 8 Mic 9 Zone 3 Zone 4 SoundStructure Studio Steps Step 1 - Select Inputs The system is designed with 16 table microphones, one lectern mic, one wireless mic with line level input, Polycom, Inc.
  • Page 477 VSX8000 video codec, and a single telephony interface. Polycom, Inc.
  • Page 478 Step 2 - Select Outputs Six mono audio amplifiers are added to the system in this step. The output to the telephone line and VSX8000 were created when their respective input components were added to the system in step 1. Polycom, Inc.
  • Page 479 Step 3 - Select Equipment The default equipment selection will use two C12’s, and a TEL1 telephony card. Polycom, Inc.
  • Page 480 Step 4 - Work Offline Or Online As there are many matrix settings to change, we’ll work off line and adjust the crosspoints. Polycom, Inc.
  • Page 481: Matrix Settings

    Matrix Settings The default matrix with the desired inputs and outputs is shown in the following figure. Default Matrix Settings Polycom, Inc.
  • Page 482 This mapping shows how the different input zones will be mapped to the different amplifier zones. For example, the zone 1 microphones are mapped to zones 2, 3, 4, 5, and 6 with a gain of -9, -6, -6, -9, and -12dB respectively. The zone numbering matches the room layout description. Input Mapping Amplifier Polycom, Inc.
  • Page 483 The next step is to map the stereo program audio and video codec audio to the appropriate left and right loudspeakers in the room. The result is shown in the following figure where the left channel of the audio is Polycom, Inc.
  • Page 484: Channels Settings

    Channels Settings Once the matrix has been configured, the next step is to enable the feedback processing for each microphone. This can be done easily with the channels page editing the EQ settings for the “Mics” group as Polycom, Inc.
  • Page 485 Zone 1 and Zone 6 microphones will have Zone 1 and Zone 6 amplifiers selected as their two references, Zone 2 and Zone 5 microphones will have Zone 2 and Zone 5 amplifiers selected as their references, and Polycom, Inc.
  • Page 486: Wiring Information

    In this example, two C12 devices were required to implement the design. The two devices are linked with the OBAM interface and each device is wired as shown in the following figure. Polycom, Inc.
  • Page 487 The first C12 is configured to be bus id 1 and the second is configured to be bus id 2 by default assuming the OBAM out of the first device is connected to the OBAM in on the second device. Project Wiring Information Polycom, Inc.
  • Page 488: Controlling The System

    PSTN line, a program audio feed, a loudspeaker zone, and one digital microphone array in each room. In addition, room 1 also has a Polycom HDX video conferencing system that is used with all microphones when the rooms are combined and only in room 1 when the rooms are split.
  • Page 489 ● Both telephone lines are routed to the HDX system ● Both telephone lines are routed to the loudspeakers ● Both program audio sources are routed to the loudspeakers ● All microphones are in the same automixer ● The telephones are routed to each other Polycom, Inc.
  • Page 490 When an HDX video codec is used with SoundStructure, any command to mute the HDX will forward a command to mute the virtual channel “Mics” and if a command is sent to the HDX, the HDX will forward a command to SoundStructure to adjust the fader level on the channel “Amplifier”. Polycom, Inc.
  • Page 491: Soundstructure Studio Steps

    SoundStructure Studio Steps Step 1 - Select Inputs The system should be designed in the combined mode with two HDX table microphones, two program audio source, two telephone lines, and a Polycom HDX system. Polycom, Inc.
  • Page 492 Step 2 - Select Outputs Two mono amplifiers will be selected in this step. The output to the telephone lines and the output to the HDX 9000 were created when their respective input components were added to the system in step 1. Polycom, Inc.
  • Page 493 Step 3 - Select Equipment The default equipment selection requires a C8 and a dual telephone line card. Polycom, Inc.
  • Page 494 Step 4 - Work Offline Or Online As there are many matrix settings to change, we’ll work off line and adjust the crosspoints. Polycom, Inc.
  • Page 495: Combined Room Settings

    The next steps are to rename the “Mics” virtual channel to “Room 1 Mics” and change the membership to only include Room 1 microphones, add the group “Room 2 Mics” and add the Room 2 mics to that group. Polycom, Inc.
  • Page 496 “Mics” and “Amplifier” submix channels. The updated matrix is shown in the following figure. Polycom, Inc.
  • Page 497 Project Matrix Page In this matrix, the submix “Amplifier” is used to route the remote audio of the combined system to the “Amplifier 1” virtual channel and the “Mics” submix is used to send the combined microphones to the remote Polycom, Inc.
  • Page 498 Once the matrix settings are configured, the next step is to save these settings to the “Combine” preset by selecting “Save To New” on the preset page and set the power on preset to be the “Combine” preset. Polycom, Inc.
  • Page 499: Split Room Settings

    In the split room configuration, the matrix settings must be adjusted to route the audio to meet the original specifications. The following figure shows the routing that keeps the audio from the two rooms completely separate while routing the HDX audio to only Room 1. Polycom, Inc.
  • Page 500 In addition to the matrix settings, the automixer settings must be adjusted to have two automixer groups with the microphones from each room in their respective automixer group. The automixer settings for the Room 1 mics is shown in the following figure after the Room 2 microphones have been removed. Polycom, Inc.
  • Page 501 Automixer Settings for Room 1 Microphones The automixer settings for the Room 2 mics is shown in the following figure after setting the Automixer Group to 2 and adding the Room 2 microphones. Polycom, Inc.
  • Page 502 Finally, confirm that there is a power on preset - in this example it should be set to be the “Combine” preset as shown in the following figure. Polycom, Inc.
  • Page 503: Wiring Information

    In this example, a single C8 device was used to implement the design. This device is wired as shown in the following figure. The digital microphone arrays use the processing from inputs 3 - 8, leaving inputs 1 and 2 Polycom, Inc.
  • Page 504: Controlling The System

    “Mics” 0 The in-room volume for the remote audio may be increased with the fader command on the phone or video codec audio as follows. inc fader “HDX Video Call In” 1 inc fader “Phone In 1” 1 Polycom, Inc.
  • Page 505 Amplifier by 1 dB. In the split mode, this command would increment only the Room 1 amplifier by 1dB since only the Room 1 remote audio sources are routed to the “Amplifier” submix in the split mode. Polycom, Inc.
  • Page 506: Troubleshooting

    Check that the audio from the remote participants is not muted either locally or at the remote site. Remote Participants Can’t Hear Local Participants Check that the audio from the local participants is routed through the matrix to the remote participants. Polycom, Inc.
  • Page 507 How Do I Enable Auto Gain Control Or Noise Cancellation On The Program Audio Material And Video Codec Audio? Customizing SoundStructure Designs, in the Processing Noise Cancellation section, describes how to select the Line Input “ungated” type, and then how to use that signal processing path in the matrix. Once Polycom, Inc.
  • Page 508: Echo Troubleshooting

    If the echo is still there when the microphones are muted, it is not an acoustic echo issue and may be an issue with wiring or with routing through the matrix. Polycom, Inc.
  • Page 509 “Amplifier” channel and all the remote audio sources that make up the “Amplifier” channel is shown in the following figure. Notice that the audio from the Polycom Video Codec, the telco audio, the program audio, and the audio from the remaining remote source are all part of the “Amplifier” virtual channel and consequently used as the AEC reference.
  • Page 510 If the output fader on the amplifier channel is used to attenuate the amplifier signal as shown in the figure below and the AEC reference is also set to the amplifier output, then the AEC reference would also be attenuated by the fader amount. Polycom, Inc.
  • Page 511 Changing these settings are shown in the following figure. The result of this is that the proper signal levels are presented to the echo canceller and the output signal levels are attenuated appropriately. Polycom, Inc.
  • Page 512: Api Troubleshooting

    SoundStructure with two bytes - CR and a Null character - even though only the CR termination is selected in the Tera Term user interface. This is a bug within Tera Term. The result is that Polycom, Inc.
  • Page 513 If the command syntax of the command is not followed such as specifying too many parameters or not enough parameters, this error message may occur. As an example, setting the baud rate of a SoundStructure device requires specifying the device ID as in the following example. Polycom, Inc.
  • Page 514 SoundStructure device. Virtual channel and virtual channel group names can be in mixed case. Remember that virtual channel names are case-sensitive - “Table Mic 1” and “table mic 1” are two different virtual channel names. Polycom, Inc.
  • Page 515: Rs-232 Troubleshooting

    Reboot the SoundStructure device and see if it is possible to connect to the device either via RS-232 or Ethernet. If so, check the Polycom website for a newer version of firmware and release notes to see what issues may be been resolved.
  • Page 516 - then it should be enabled on both the SoundStructure device and the device that is connected to the SoundStructure device. Hardware flow control may be enabled on a SoundStructure device with the API command set ser_flow 1 hw and may be removed with the command set ser_flow 1 none where 1 is the device ID. Polycom, Inc.
  • Page 517: Polycom Video Codec Integration

    The connection status can also be viewed within the System Information page on the Polycom Video Codec. If the status shows Polycom Mixer then the system has connected properly to the SoundStructure.
  • Page 518: Telco Troubleshooting

    SoundStructure system. If the mute status of the “Mics” group is adjusted independently on the SoundStructure system, a command is not sent to the Polycom Video Codec and consequently the Polycom Video Codec will not update the mute status on the screen.
  • Page 519: Hardware Troubleshooting

    Status using devices that match the actual Yellow Solid devices. In other applications, this means the system has logged a warning and the system logs should be reviewed. A system component has failed and Solid requires immediate attention. Polycom, Inc.
  • Page 520: Obam Troubleshooting

    OBAM in and out connectors. If the cables are properly seated, try looping a known good cable into the OBAM in and out ports as shown in the following figure. If the SoundStructure device’s OBAM interface is working properly the LEDs should illuminate. LINK2 OBAM Polycom, Inc.
  • Page 521: Troubleshooting The Ir Interface

    The next step is to make sure the IR receiver is wired properly and terminated to the IR receive port on the SoundStructure rear-panel as shown in the following figure. By default the SoundStructure device is configured for the Polycom IR remote to have the default device ID of 3 for the SoundStructure to detect the IR key presses.
  • Page 522: Specifications

    These sensor values are found on the Wiring page within SoundStructure Studio when connected to a SoundStructure device. Green indicates normal operation up to the temperatures listed in the following table. Yellow indicates an elevated temperature that is acceptable but Polycom, Inc.
  • Page 523 ● Linearity: 0 dB FS to -122 dB FS +/- 1 dB ● THD+N: < 0.005%, -20 dB FS input signal ● Common mode rejection ratio: <-61 dB, 20-20,000 Hz, no weighting ● Cross talk: <-110 dB, 20-20,000 Hz, 1 kHz, channel-to-channel Polycom, Inc.
  • Page 524: Pin Out Summary

    Note: Drawing and Part Numbers For Reference Only Drawings and part numbers are provided for reference only. Other than cables provided by Polycom, Polycom claims no responsibility or liability for the quality, performance, or reliability of cables based on these reference drawings. Contact a Polycom reseller to order cables that meet the appropriate manufacturing tolerances, quality, and performance parameters for particular applications.
  • Page 525: Pstn Cable

    WHITE/ORANGE ORANGE WHITE/BROWN BROWN DRAIN WIRE SHELL SHIELD SHELL P1 - RJ-45 shielded Keystone jack, L-com RJ110C5-S or equivalent, P1 - RJ-45 shielded plug, Tyco 5-569552 or equivalent with shielded RJ-45 panel coupler kit (L-com ECF504-SC5E or equivalent). Polycom, Inc.
  • Page 526: Obam Link

    OBAM and any non-SoundStructure approved device that is placed on the OBAM Link will prevent OBAM Link from operating properly. Connector Pinout Pin 7 is not connected in the below figure. 1394b 1394b BETA Plug BETA Plug Green Blue Orange White Black SHELL SHELL Polycom, Inc.
  • Page 527: Ir Receiver

    IR Receiver Accepted Terminal Ports Signal +12 V Ground IR Signal Data RS-232 The RS-232 interface requires a straight-through cabling to a control system as shown in the following figures. Pin 5 Pin 1 Pin 9 Pin 6 Polycom, Inc.
  • Page 528: Logic Interface

    Remote Control 1 Signal Signal +5 V Logic Input 1 Logic Output 1 Logic Input 2 Logic Output 2 Logic Input 3 Logic Output 3 Logic Input 4 Logic Output 4 Logic Input 5 Logic Output 5 Logic Input 6 Polycom, Inc.
  • Page 529: Audio Connections

    Logic Output 21 Logic Input 22 Logic Output 22 Ground Analog Gain 2 Audio Connections SoundStructure devices provide balanced audio input and output connections that are terminated with 3.5 mm terminal blocks as shown in the following figure. Polycom, Inc.
  • Page 530 To connect the SoundStructure device's audio input and output to other balanced or unbalanced audio equipment, follow the wiring convention in the unbalanced audio connections in the following figure. XLR Female XLR Male Balanced Audio Connections Unbalanced Audio Connections Polycom, Inc.
  • Page 531: Using Soundstructure Studio Controls

    In addition, an arbitrary collection of crosspoints can be selected by clicking on the first crosspoint and then holding the Control key as other crosspoints are selected. Once the collection of crosspoints has been Polycom, Inc.
  • Page 532 Control key and double click any of the cells to bring up the matrix crosspoint control. Any changes made to the matrix control will affect all selected crosspoints. Polycom, Inc.
  • Page 533: Appendix A: Command Protocol Reference Guide

    9600, 19200, 38400, 57600, and 115200 with a default baud rate of 9600. This interface is primarily intended for connecting a control system (such as AMX or Crestron) to a SoundStructure device. However, other types of controllers (such as a Windows PC running SoundStructure Studio) may use this interface as well. Polycom, Inc.
  • Page 534: Connecting With The Ethernet Interface

    SoundStructure system using port 52775. Ethernet Interface on SoundStructure System Rear Panel PIN 2: TXD PIN 3: RXD PIN 5: GROUND PIN 7: CTS PIN 8: RTS REMOTE CONTROL 1 RS-232 REMOTE CONTROL 2 C-LINK2 OBAM Polycom, Inc.
  • Page 535: Using Virtual Channels

    Multiple network connections can be on the same network or on different subnets as shown in the following figure. Multiple Network Connections on the Same Network and Different Subnets SoundStructure C16 .100 SoundStructure C16 OBAM Link .101...
  • Page 536: Understanding Virtual Channel Types

    Virtual channels are operated on by the command set which can apply parameter changes to the underlying physical channels. For example, setting the fader parameter of a virtual channel would set the fader parameter for its underlying physical channels. Polycom, Inc.
  • Page 537: Understanding Virtual Channel Groups

    It is possible to have multiple virtual channel groups that include the same virtual channels. Commands can be sent to the particular virtual channel group will affect the members of the group and those members will respond with the appropriate command acknowledgments. Polycom, Inc.
  • Page 538: Understanding Soundstructure Command Syntax

    SoundStructure device that is to be controlled. The device ID is created automatically when multiple SoundStructure devices are linked together through the OBAM interface. All stand-alone SoundStructure devices will have a device ID equal to 1. In a multi-device system, the device that has no OBAM in Polycom, Inc.
  • Page 539 List parameters represent a sequence of string values. For example, the pstn country parameter is a list parameter that sets the country code for the PSTN telephony interface. Some possible values for the pstn country parameter might be: north america, europe, and china. Even though list parameters are represented Polycom, Inc.
  • Page 540: Understanding The Command Format

    The acknowledgment is sent to all interfaces if a setting changed. The acknowledgment is only sent to the originating interface if no settings changed, for example, a query for a parameter is made. Command Length All commands must be less than or equal to 2048 bytes in length, including the terminator. Polycom, Inc.
  • Page 541: Understanding The Control Commands

    (0061-007A), and the underscore character (005F). The underscore character is used when it would make long arguments more readable. Examples of valid system-defined text arguments are cr_mic_in and agc_rate. System-defined text arguments must be less than or equal to 32 bytes in length. Polycom, Inc.
  • Page 542: Understanding Virtual Channel Definition Commands

    The vcdef action is a virtual channel definition command that defines a new virtual channel and its physical channel mapping. Commands with the vcdef action have the following syntax. vcdef <label> <vctype> <pctype> <num> [<num> ... ]<term> Each of the command arguments is described in the following section. <label> Polycom, Inc.
  • Page 543 The physical channel for the transmit signal from the VoIP telephony interface sig_gen The physical channel is the signal generator input. submix The physical channel is one of the sub-mix channels. clink_in The physical channel is one of the ConferenceLink inputs. Polycom, Inc.
  • Page 544 The <num> argument is an integer argument. As an example, consider two SoundStructure C16 devices linked via OBAM link. The following command defines a stereo virtual channel consisting of the last microphone on the first device and the first microphone of the second device.
  • Page 545 The vcundef action is a virtual channel definition command that undefines a virtual channel that was previously defined with the vcdef action. Commands with the vcundef action have the following syntax. vcundef <label> <term> Each of the command arguments is defined below. Polycom, Inc.
  • Page 546: Virtual Channel Group Definition Commands

    Virtual channel group definition commands are a type of control command that provide methods for defining virtual channel groups. Virtual channel group definition commands support the following six actions. vcgdef Define a new virtual channel group. vcgundef Delete a virtual channel group definition. Polycom, Inc.
  • Page 547 The <label> argument is a user-defined text argument that defines the name of the virtual channel group to be undefined. If no virtual channel group exists with the given label, then the SoundStructure device will respond with an error message. Polycom, Inc.
  • Page 548 If no virtual channel with the specified name exists, the SoundStructure device will respond with an error message. If the virtual channel is already a member of the virtual channel group, the SoundStructure device will respond with an error message. Polycom, Inc.
  • Page 549 If no virtual channel group exists with the given label, then SoundStructure will respond with an error message. vcglist Acknowledgements When a virtual channel group definition command with the vcglist action is successfully executed, SoundStructure will send an acknowledgement with the following syntax: vcglist <label> [<vcmember> [<vcmember ... ]]<term> Polycom, Inc.
  • Page 550: Adjusting Parameters

    "DVD Audio" 2 tog aec_en "Mic 1" set eq_en "Speaker 1" 1 set peq_gain "Speaker 2" 1 -2.5 set matrix_gain "DVD Audio" "Codec Output" 0 authenticate “admin” “456” run “Power-On” The fields in the command are described below. <action> Polycom, Inc.
  • Page 551 Parameters may be multi-dimensional while most parameters are scalar. For example, the gain parameter is scalar, meaning that there is one value for each physical or virtual channel. An example of a one-dimensional parameter is the parametric EQ gain parameter. There are multiple bands of parametric Polycom, Inc.
  • Page 552 The argument to an integer parameter command is an integer argument. Integer parameter commands support the get, set, inc, and dec actions according to the command’s read-write mode. Integer parameter commands do not support the tog action. Integer parameter commands Polycom, Inc.
  • Page 553 Acknowledgments are generated when either a parameter command is issued or a parameter changes value for some other reason. When a parameter command is executed with the get action, the acknowledgment is only sent to the control interface that the parameter command was received from. Polycom, Inc.
  • Page 554: Command List

    The complete system parameter command reference is found in the file SoundStructure-parameters.html on the CDROM and may also be found by browsing in the SoundStructure device’s web interface by pointing a browser at the IP address of the SoundStructure device. Polycom, Inc.
  • Page 555: Command Example

    Submix, ConferenceLink Aux Input, ConferenceLink Aux Output Virt Chans Mono, Stereo System Limits Minimum: -100.0, Maximum: 20.0, Resolution: 0.1 Default User Limits Supported Event Source Description This parameter sets the fader level (in dB) in the digital domain. Polycom, Inc.
  • Page 556 (used with the SR12), telephony input and output channels, submix channels, and the ConferenceLink channels to and from the Polycom Video Codec system. The Virt Chans entry indicates that the command can operate on both mono and stereo virtual channels.
  • Page 557: Soundstructure Parameters

    Submix, ConferenceLink Aux Input, ConferenceLink Aux Output Virt Chans Mono, Stereo System Limits Minimum: -100.0, Maximum: 20.0, Resolution: 0.1 Default User Limits Supported Event Source Description This parameter sets the fader level (in dB) in the digital domain. Polycom, Inc.
  • Page 558 Argument value Channel Type Virtual Channel Value Type Floating-Point Read/Write Mode Read/Write Phys Chans Conferencing Line Output, Sound Reinforcement Line Output Virt Chans Mono, Stereo System Limits Minimum: -100.0, Maximum: 20.0, Resolution: 0.5 Default User Limits Supported Event Source Polycom, Inc.
  • Page 559 Argument value Channel Type Global System Value Type Void Read/Write Mode Write-Only Event Source Description This parameter resets all of the peak meters in the system, if the peak meters are configured to have the infinite peak hold behavior. Polycom, Inc.
  • Page 560 Signal Generator, Submix, ConferenceLink Aux Input, ConferenceLink Aux Output Virt Chans Mono, Stereo Default Event Source Description This parameter sets the mute status of the virtual channel. A value of 0 indicates the virtual channel is unmuted, while a value of 1 indicates it is muted. Polycom, Inc.
  • Page 561 Conferencing Mic/Line Input, Sound Reinforcement Mic/Line Input Virt Chans Mono, Stereo Default Event Source Description Enables or disable phantom power on mic inputs. Setting phantom to 1 enables phantom power, while setting it to 0 disables phantom power. Polycom, Inc.
  • Page 562 This parameter sets the status of the safety mute. If safety mute is enabled (1), all line outputs of all the devices are muted. Examples Command Response Description set safety_mute 1 val safety_mute 1 Enables the safety_mute for a SoundStructure system. set safety_mute 0 val safety_mute 0 Turns off the safety_mute for a SoundStructure system. Polycom, Inc.
  • Page 563 This parameter applies gain (in the analog domain) to the individual components of a virtual channel. The index indicates to which physical channel of the virtual channel the trim will be applied. For example, indices 1 and 2 correspond to the left and right physical channels of a stereo virtual channel. Polycom, Inc.
  • Page 564: Matrix Parameters

    The matrix_balance parameter is available at crosspoints where stereo virtual channels are mixed to mono or stereo virtual channels. The matrix_balance parameter provides a way to control the amount of gain going to the left and right channels. Polycom, Inc.
  • Page 565 Submix, ConferenceLink Aux Output Col Virt Chans Mono, Stereo System Limits Minimum: -100.0, Maximum: 20.0, Resolution: 0.1 Default User Limits Supported Event Source Description This parameter sets the gain (in dB) for the specified crosspoint in the matrix mixer. Polycom, Inc.
  • Page 566 Conferencing Line Output, Sound Reinforcement Line Output, Analog Telephony Output, Submix, ConferenceLink Aux Output Col Virt Chans Mono, Stereo Default Event Source Description This parameter selects whether the gated (1) or ungated (0) version of the input signal is sent to the output. Polycom, Inc.
  • Page 567 Col Virt Chans Mono, Stereo Values conf : Conference Style Gating (default) sr : Sound Reinforcement Style Gating Event Source Description This parameter selects the gating style for crosspoints with conferencing inputs. Gating is enabled with the matrix_gate parameter. Polycom, Inc.
  • Page 568 Aux Output Col Virt Chans Mono, Stereo Default Event Source Description Inverts the specified crosspoint in the matrix mixer. Setting matrix_ invert to 0 sets the crosspoint to normal polarity; setting matrix_invert to 1 inverts the crosspoint polarity. Polycom, Inc.
  • Page 569 "Phone Out". get matrix_mute "Table val matrix_mute "Table Queries the mute status of the crosspoint from "Table Mic Mic 1" "Phone Out" Mic 1" "Phone Out" 1 1" to the output channel apos;Phone Out". Polycom, Inc.
  • Page 570 Event Source Description The matrix_pan parameter is available at crosspoints where mono virtual channels are mixed to stereo virtual channels. The matrix_pan parameter provides a way to control the amount of gain going to the left and right channels. Polycom, Inc.
  • Page 571: Telephony Parameters

    Some telephony API commands operate on the input virtual channel and some operate on the output virtual channel. Below is a table of commands and whether they operate on the input or output channel. Telephony Parameter Commands Command Input channel Output channel phone_auto_answer_en phone_connect phone_dial phone_dial_tone_gain phone_dtmf_gain phone_entry_tone_en phone_exit_tone_en phone_flash phone_flash_delay phone_redial phone_ring phone_ring_tone_en Polycom, Inc.
  • Page 572 Argument value Channel Type Virtual Channel Value Type Boolean Read/Write Mode Read/Write Phys Chans Analog Telephony Input Virt Chans Mono Default Event Source Description This parameter enables (1) or disables (0) the auto-answer feature for the telephony interface. Polycom, Inc.
  • Page 573 Hangs up the phone line associated with the virtual "Phone Out" 0 "Phone Out" 0 channel "Phone Out". Note that the phone out virtual channel name must be used, not the phone input virtual channel name. Polycom, Inc.
  • Page 574 When the telephony interface is eventually connected, the characters stored in the dial buffer shall be dialed. If more than 20 seconds pass after the last phone_dial or phone_connect parameters are sent, then the dial buffer is automatically cleared. Polycom, Inc.
  • Page 575 This is true for the VoIP interface as well, but the parameter also affects the dial buffer when the interface is off-hook before a call is placed. Polycom, Inc.
  • Page 576 "Phone In"-6 "Phone In" -6 phone associated with the virtual channel "Phone In" to -6dB when the phone is taken offhook. Note that the phone in virtual channel name must be used, not the phone output virtual channel name. Polycom, Inc.
  • Page 577 This parameter sets the gain (in dB) applied to DTMF tones generated to the local room. To adjust the level of ring tones, entry tones, and exit tones played back into the local room, use the phone_tone_gain parameter. Polycom, Inc.
  • Page 578 (1), then an entry tone is played whenever the auto-answer feature engages and connects the telephony interface. Entry tones and exit tones (see the phone_exit_tone_en parameter) are typically enabled to prevent a caller from entering or exiting a conference unannounced. Polycom, Inc.
  • Page 579 Read/Write Mode Write-Only Phys Chans Analog Telephony Output Virt Chans Mono Event Source Description Setting this parameter disconnects the telephony interface then reconnects it after a short delay. The amount of delay can be configured with the phone_flash_delay parameter. Polycom, Inc.
  • Page 580 This parameter sets the delay (in milliseconds) for the phone_flash parameter. Note that by default, PSTN interfaces use the flash delay determined by their pstn_country setting. However, they can use the value of this parameter if the pstn_flash_delay_override parameter is set to 1. Polycom, Inc.
  • Page 581 Setting this parameter causes the last number to be redialed on the telephony interface. The last number is defined as all the digits that were dialed since the telephony interface was last connected (see the phone_connect parameter). If the telephony interface is not already connected, setting this parameter will automatically connect it before dialing. Polycom, Inc.
  • Page 582 1. When the telephony interface is not ringing, reading this parameter will return 0. Acknowledgements for this parameter will be automatically sent whenever this parameter changes state due to a hook flash, auto-answer, or auto-hangup. Polycom, Inc.
  • Page 583 ● 2: low trill ● 3: low double trill ● 4: medium trill ● 5: medium double trill ● 6: high trill ● 7: high double trill ● 8: highest trill ● 9: highest double trill ● 10: beeble Polycom, Inc.
  • Page 584 Event Source Description This parameter enables or disables ring tone generation for the telephony interface. If ring tones are enabled (1), then a ring tone is played whenever there is an incoming ring signal on the telephony interface. Polycom, Inc.
  • Page 585 Channel Type Virtual Channel Value Type Boolean Read/Write Mode Read/Write Phys Chans Analog Telephony Output Virt Chans Mono Default Event Source Description This parameter enables (1) or disables (0) the auto-hangup on loop drop feature for the PSTN interface. Polycom, Inc.
  • Page 586 Virtual Channel Value Type Boolean Read/Write Mode Read/Write Phys Chans Analog Telephony Output Virt Chans Mono Default Event Source Description This parameter enables (1) or disables (0) the auto-hangup on call progress tones feature for the PSTN interface. Polycom, Inc.
  • Page 587 : Finland france : France germany : Germany greece : Greece guam : Guam hong_kong : Hong Kong hungary : Hungary iceland : Iceland india : India indonesia : Indonesia ireland : Ireland israel : Israel yemen : Yemen Polycom, Inc.
  • Page 588 : South Africa south_korea : South Korea spain : Spain sweden : Sweden switzerland : Switzerland taiwan : Taiwan tbr21 : TBR21 thailand : Thailand uae : UAE united_kingdom : United Kingdom usa : USA (default) Event Source Polycom, Inc.
  • Page 589 Read/Write Mode Read/Write Phys Chans Analog Telephony Output Virt Chans Mono Default Event Source Description This parameter controls whether or not the flash hook delay is determined by the default pstn_country settings (0) or by the phone_flash_delay setting (1). Polycom, Inc.
  • Page 590 "Phone val pstn_in_gain "Phone Adjusts the input gain on the phone input to 6dB. Note In" 6 In" 6 that the phone in virtual channel name must be used, not the phone out virtual channel name. Polycom, Inc.
  • Page 591 Queries the pstn_line_voltage and returns the measured "Phone Out" "Phone Out" 0 value in Volts on the phone line "Phone Out". Note that the phone out virtual channel name must be used, not the phone in virtual channel name. Polycom, Inc.
  • Page 592 Phys Chans Analog Telephony Output Virt Chans Mono System Limits Minimum: -20.0, Maximum: 20.0, Resolution: 0.5 Default User Limits Supported Event Source Description This parameter sets the gain (in dB) of the signal going to the PSTN interface. Polycom, Inc.
  • Page 593 Specify a Blind Transfer—voip_blind Argument Argument value Channel Type Virtual Channel Value Type Void Read/Write Mode Write-Only Phys Chans VoIP Telephony Output Virt Chans Mono Event Source Description This parameter is used along with voip_transfer to make a blind transfer. Polycom, Inc.
  • Page 594 Channel Type Virtual Channel Value Type String Read/Write Mode Read-Only Phys Chans VoIP Telephony Output Virt Chans Mono System Limits Max String Length: 256 Event Source Description This parameter returns manufacturing and hardware information about the VoIP plug-in card. Polycom, Inc.
  • Page 595 This parameter selects the currently active call appearance. Some parameters (e.g. phone_connect, phone_dial, phone_redial) operate on the currently active call appearance, as specified by this parameter. Setting this parameter is analogous to selecting a call appearance on the UI of a Polycom VoIP phone. VoIP plug-in card.
  • Page 596 Integer Read/Write Mode Read-Only Phys Chans VoIP Telephony Output Virt Chans Mono Indices 1-24: Call appearance index System Limits Minimum: 1, Maximum: 12 Event Source Description This parameter reports the line number associated with the specified call appearance. Polycom, Inc.
  • Page 597 : PVC preemption_in_progress : Preemption in Progress pre_dialtone : Pre-Dialtone Event Source Description This parameter reports the call appearance state for the specified call appearance. Automatic status messages are generated for this parameter when it changes automatically. Polycom, Inc.
  • Page 598 This parameter is used to cancel a transfer or conference. Start a Conference Call—voip_conference Argument Argument value Channel Type Virtual Channel Value Type Void Read/Write Mode Write-Only Phys Chans VoIP Telephony Output Virt Chans Mono Event Source Description This parameter is used to start a conference call. Polycom, Inc.
  • Page 599 Mono System Limits Minimum: 0, Maximum: 255 Default User Limits Supported Event Source Description When voip_dhcp_boot_serv is set to custom, this parameter specifies the DHCP option number in which the VoIP card will look for the boot server. Polycom, Inc.
  • Page 600 VoIP Telephony Input Virt Chans Mono Values rfc3925_binary : RFC3925 binary (default) ascii_string : ASCII string Event Source Description This parameter specifies the format for the vendor identifying information used with a DHCP server when DHCP option 60 is enabled. Polycom, Inc.
  • Page 601 Argument value Channel Type Virtual Channel Value Type Boolean Read/Write Mode Read/Write Phys Chans VoIP Telephony Output Virt Chans Mono Default Event Source Description This parameter enables (1) or disables (0) do-not-disturb mode on the VoIP plug-in card. Polycom, Inc.
  • Page 602 A single server or multiple servers (separated by spaces) may be specified. The gw attribute specifies the gateway. The nm parameter specifies the netmask. DHCP Example set voip_eth_settings "VoIP In" "mode='dhcp'" val voip_eth_settings "VoIP In" "mode='dhcp',addr='172.22.2.129',dns='172.22.1.1 172.22.1.2',gw='172.22.2.254',nm='255.255.255.0'" Static IP Example set voip_eth_settings "VoIP In" "mode='static',addr='172.22.2.200',dns='172.22.1.1',gw='172.22.2.254',nm='255.255.255.0'" val voip_eth_settings "VoIP In" "mode='static',addr='172.22.2.200',dns='172.22.1.1',gw='172.22.2.254',nm='255.255.255.0'". Polycom, Inc.
  • Page 603 State—voip_factory_reset Argument Argument value Channel Type Virtual Channel Value Type Void Read/Write Mode Write-Only Phys Chans VoIP Telephony Input Virt Chans Mono Event Source Description This parameter resets the VoIP plug-in card to its factory state. to "disabled." Polycom, Inc.
  • Page 604 Place Current Call on Hold—voip_hold Argument Argument value Channel Type Virtual Channel Value Type Void Read/Write Mode Write-Only Phys Chans VoIP Telephony Output Virt Chans Mono Event Source Description Setting this parameter places the current call on hold. Polycom, Inc.
  • Page 605 This parameter selects the currently active line. Some parameters (e.g. phone_connect, phone_dial, phone_redial) operate on the currently active line, as specified by this parameter. Setting this parameter is analogous to selecting a line key on the UI of a Polycom VoIP phone. Polycom, Inc.
  • Page 606 Virtual Channel Value Type String Read/Write Mode Read-Only Phys Chans VoIP Telephony Output Virt Chans Mono Indices 1-12 : Line number System Limits Max String Length: 128 Event Source Description This parameter reports the label for the specified line. Polycom, Inc.
  • Page 607 State for the VoIP Line—voip_line_state Argument Argument value Channel Type Virtual Channel Value Type List Read/Write Mode Read-Only Phys Chans VoIP Telephony Output Virt Chans Mono Indices 1-12 : Line number Polycom, Inc.
  • Page 608 Event Source Polycom, Inc.
  • Page 609 Virtual Channel Value Type Boolean Read/Write Mode Read-Only Phys Chans VoIP Telephony Input Virt Chans Mono Event Source Description This parameter indicates whether or not a message is waiting for the VoIP interface on any of the registered lines. Polycom, Inc.
  • Page 610 Value Type String Read/Write Mode Read/Write Phys Chans VoIP Telephony Input Virt Chans Mono System Limits Max String Length : 256 Default Event Source Description This parameter sets the address of the provisioning server for the VoIP interface. Polycom, Inc.
  • Page 611 Virt Chans Mono Values ftp : FTP Server (default tftp : TFTP Server http : HTTP Server https : HTTPS Server ftps : FTPS Server Event Source Description This parameter controls the provisioning server type for the VoIP interface. Polycom, Inc.
  • Page 612 Value Type Void Read/Write Mode Write-Only Phys Chans VoIP Telephony Output Virt Chans Mono Event Source Description Setting this parameter causes the SoundStructure VoIP Interface to reboot. The host SoundStructure device does not reboot when this parameter is used. Polycom, Inc.
  • Page 613 Argument value Channel Type Virtual Channel Value Type Void Read/Write Mode Write-Only Phys Chans VoIP Telephony Output Virt Chans Mono Event Source Description Setting this parameter causes a call to be placed with the digits dialed so far. Polycom, Inc.
  • Page 614 : The VoIP card has booted and is operational Event Source Description This parameter indicates the status of the VoIP plug-in card. The three values correspond to the state of the status LED on the VoIP plug-in card as follows: ok = solid, booting = flashing. Polycom, Inc.
  • Page 615: Equalizer Parameters

    Most physical channel types have 10 bands of graphic equalization. The Conference Link input and output physical channel types only have 5 bands of graphic equalization. The signal generator and AEC reference physical channel types do not support graphic equalization. Polycom, Inc.
  • Page 616 This parameter enables (1) or disables (0) all equalizer processing (peq, geq, etc.) for the specified virtual channel. Examples Command Response Description set eq_en "Amplifier" 1 val eq_en "Amplifier" 1 Enables the equalization processing for the channel "Amplifier". Polycom, Inc.
  • Page 617 Virtual Channel Value Type Boolean Read/Write Mode Read/Write Phys Chans Conferencing Line Output, Sound Reinforcement Line Output Virt Chans Mono, Stereo Default Event Source Description This parameter enables (1) or disables (0) gain compensation for the graphic equalizer. Polycom, Inc.
  • Page 618 Set the gain of the specified band in the graphic equalizer. The index must be between 1 and 10 for 1 octave equalization, between 1 and 15 for 2/3 octave equalization, and between 1 and 31 for 1/3 octave equalization. Polycom, Inc.
  • Page 619 Input, Sound Reinforcement Line Output, Analog Telephony Input, Analog Telephony Output, Submix, ConferenceLink Aux Input, ConferenceLink Aux Output Virt Chans Mono, Stereo Default Event Source Description This parameter enables (1) or disables (0) the high shelving filter for the specified virtual channel. Polycom, Inc.
  • Page 620 Minimum 20.0, Maximum: 20000.0, Resolution: 0.1 Default 500.0 User Limits Supported Event Source Description This parameter sets the cutoff frequency (in Hz) of the high shelving filter. This is the frequency at which the shelving filter's gain is half its maximum gain. Polycom, Inc.
  • Page 621 Input, Sound Reinforcement Line Output, Analog Telephony Input, Analog Telephony Output, Submix, ConferenceLink Aux Input, ConferenceLink Aux Output Virt Chans Mono, Stereo Values 6: 6 dB per octave (default) 12: 12 dB per octave Event Source Description This parameter sets the slope of the high shelving filter. Polycom, Inc.
  • Page 622 Event Source Description This parameter sets the cutoff frequency (in Hz) of the constant directivity horn equalizer. This is the frequency above which the gain increases at 6 dB per octave, and below which the gain is 0 dB. Polycom, Inc.
  • Page 623 Default 160.0 User Limits Supported Event Source Description This parameter sets the frequency (in Hz) of the high-pass filter. For Butterworth filters this is the 3 dB frequency, but for Linkwitz-Riley filters, this is the 6 dB frequency. Polycom, Inc.
  • Page 624 Conferencing Mic/Line Input, Conferencing Line Output, Sound Reinforcement Mic/Line Input, Sound Reinforcement Line Output, Analog Telephony Input, Analog Telephony Output, Submix, ConferenceLink Aux Input, ConferenceLink Aux Output Virt Chans Mono, Stereo Values butterworth : Butterworth filter (default) linkwitz_riley : Linkwitz-Riley filter Event Source Polycom, Inc.
  • Page 625 Conferencing Mic/Line Input, Conferencing Line Output, Sound Reinforcement Mic/Line Input, Sound Reinforcement Line Output, Analog Telephony Input, Analog Telephony Output, Submix, ConferenceLink Aux Input, ConferenceLink Aux Output Virt Chans Mono, Stereo System Limits Minimum: 20.0, Maximum: 20000.0, Resolution: 0.1 Default 500.0 User Limits Supported Event Source Polycom, Inc.
  • Page 626 Submix, ConferenceLink Aux Input, ConferenceLink Aux Output Virt Chans Mono, Stereo System Limits Minimum: -20.0, Maximum: 20.0, Resolution: 0.01 Default User Limits Supported Event Source Description This parameter sets the gain (in dB) of the low shelving filter at DC. Polycom, Inc.
  • Page 627 Input, Sound Reinforcement Line Output, Analog Telephony Input, Analog Telephony Output, Submix, ConferenceLink Aux Input, ConferenceLink Aux Output Virt Chans Mono, Stereo Default Event Source Description This parameter enables (1) or disables (0) the low-pass filter for the specified virtual channel. Polycom, Inc.
  • Page 628 Default 16000.0 User Limits Supported Event Source Description This parameter sets the frequency (in Hz) of the low-pass filter. For Butterworth filters this is the 3 dB frequency, but for Linkwitz-Riley filters, this is the 6 dB frequency. Polycom, Inc.
  • Page 629 Submix, ConferenceLink Aux Input, ConferenceLink Aux Output Virt Chans Mono, Stereo Values butterworth : Butterworth filter (default) linkwitz_riley : Linkwitz-Riley filter Event Source Description This parameter sets the type of analog filter prototype used for the low-pass filter. Polycom, Inc.
  • Page 630 This parameter enables (1) or disables (0) the specified band of the parametric equalizer for the specified virtual channel. For conference link physical channels, the band index must be between 1 and 5. For all other physical channels, the band index must be between 1 and 10. Polycom, Inc.
  • Page 631 3 dB bandwidth. For all-pass filters, this is the bandwidth at which the phase shift is +/- 90 degrees. For conference link physical channels, the band index must be between 1 and 5. For all other physical channels, the band index must be between 1 and 10. Polycom, Inc.
  • Page 632 180 degrees. For conference link physical channels, the band index must be between 1 and 5. For all other physical channels, the band index must be between 1 and 10. Polycom, Inc.
  • Page 633 This parameter sets the gain (in dB) of the specified parametric equalizer band. For conference link physical channels, the band index must be between 1 and 5. For all other physical channels, the band index must be between 1 and 10. Polycom, Inc.
  • Page 634: Dynamics Processing Parameters

    Dynamics processing is available on all physical channels except the signal generator and AEC reference. Dynamics processing includes a compressor, limiter, expander, gate, and peak limiter. An additional input gain parameter is provided to change the gain of the signal before the dynamics processor. Polycom, Inc.
  • Page 635 Conferencing Mic/Line Input, Conferencing Line Output, Sound Reinforcement Mic/Line Input, Sound Reinforcement Line Output, Analog Telephony Input, Analog Telephony Output, Submix, ConferenceLink Aux Input, ConferenceLink Aux Output Virt Chans Mono, Stereo System Limits Minimum: 1, Maximum: 200 Default User Limits Supported Event Source Polycom, Inc.
  • Page 636 This parameter sets the amount of time (in milliseconds) it takes the dynamics processing gate to ramp down to the target gain once the input signal drops below the gate threshold and the gate hold time has expired. This parameter does not affect the automixer processing. Polycom, Inc.
  • Page 637 Conferencing Mic/Line Input, Conferencing Line Output, Sound Reinforcement Mic/Line Input, Sound Reinforcement Line Output, Analog Telephony Input, Analog Telephony Output, Submix, ConferenceLink Aux Input, ConferenceLink Aux Output Virt Chans Mono, Stereo System Limits Minimum: 1, Maximum: 2000 Default User Limits Supported Event Source Polycom, Inc.
  • Page 638 For example, if the dynamics gate ratio is 10 (i.e., 10:1) and the input signal level is 6 dB below the gate threshold, the gate applies -60 dB of gain. This parameter does not affect the automixer processing. Polycom, Inc.
  • Page 639 This parameter sets the RMS level (in dBFS) of the input signal below which the dynamics gate engages. The level must be below this threshold longer than the gate hold time (set by dp_gate_hold) before the gate begins to apply a gain change. This parameter does not affect the automixer processing. Polycom, Inc.
  • Page 640 Default User Limits Supported Event Source Description This parameter sets the amount of time (in milliseconds) it takes the expander to ramp the gain up to the target gain once the input signal level surpasses the expander threshold. Polycom, Inc.
  • Page 641 Read/Write Mode Read/Write Phys Chans Conferencing Mic/Line Input, Conferencing Line Output, Sound Reinforcement Mic/Line Input, Sound Reinforcement Line Output, Analog Telephony Input, Analog Telephony Output, Submix, ConferenceLink Aux Input, ConferenceLink Aux Output Virt Chans Mono, Stereo Default Event Source Polycom, Inc.
  • Page 642 This parameter sets the ratio of the target gain applied by the expander versus the difference between the input signal level and the expander threshold. For example, if the expander ratio is 2 (i.e., 2:1) and the input signal level is 3 dB below the expander threshold, the expander applies -6 dB of gain. Polycom, Inc.
  • Page 643 Submix, ConferenceLink Aux Input, ConferenceLink Aux Output Virt Chans Mono, Stereo System Limits Minimum: -100.0, Maximum: 0.0, Resolution: 0.1 Default -100 User Limits Supported Event Source Description This parameter sets the RMS level (in dBFS) of the input signal below which the expander engages. Polycom, Inc.
  • Page 644 Default User Limits Supported Event Source Description This parameter sets the amount of time (in milliseconds) it takes the compressor to ramp the gain down to the target gain once the input signal level surpasses the compressor threshold. Polycom, Inc.
  • Page 645 Read/Write Mode Read/Write Phys Chans Conferencing Mic/Line Input, Conferencing Line Output, Sound Reinforcement Mic/Line Input, Sound Reinforcement Line Output, Analog Telephony Input, Analog Telephony Output, Submix, ConferenceLink Aux Input, ConferenceLink Aux Output Virt Chans Mono, Stereo Default Event Source Polycom, Inc.
  • Page 646 This parameter sets the ratio of the target gain applied by the compressor versus the difference between compressor threshold and the input signal level. For example, if the compressor ratio is 2 (i.e., 2:1) and the input signal level is 3 dB above the compressor threshold, the compressor applies -1.5 dB of gain. Polycom, Inc.
  • Page 647 Submix, ConferenceLink Aux Input, ConferenceLink Aux Output Virt Chans Mono, Stereo System Limits Minimum: -100.0, Maximum: 0.0, Resolution: 0.1 Default User Limits Supported Event Source Description This parameter sets the RMS level (in dBFS) of the input signal above which the compressor engages. Polycom, Inc.
  • Page 648 Default User Limits Supported Event Source Description This parameter sets the amount of time (in milliseconds) it takes the limiter to ramp the gain down to the target gain once the input signal level surpasses the limiter threshold. Polycom, Inc.
  • Page 649 Read/Write Mode Read/Write Phys Chans Conferencing Mic/Line Input, Conferencing Line Output, Sound Reinforcement Mic/Line Input, Sound Reinforcement Line Output, Analog Telephony Input, Analog Telephony Output, Submix, ConferenceLink Aux Input, ConferenceLink Aux Output Virt Chans Mono, Stereo Default Event Source Polycom, Inc.
  • Page 650 This parameter sets the ratio of the target gain applied by the limiter versus the difference between the limiter threshold and the input signal level. For example, if the limiter ratio is 10 (i.e., 10:1) and the input signal level is 6 dB above the limiter threshold, the limiter applies -5.4 dB of gain. Polycom, Inc.
  • Page 651 Submix, ConferenceLink Aux Input, ConferenceLink Aux Output Virt Chans Mono, Stereo Default Event Source Description This parameter enables (1) or disables (0) the peak limiter function of the dynamics processor. This parameter and dp_en must be enabled for the peak limiter to function. Polycom, Inc.
  • Page 652: Algorithm Parameters

    Argument value Channel Type Virtual Channel Value Type Boolean Read/Write Mode Read/Write Phys Chans Conferencing Mic/Line Input Virt Chans Mono, Stereo Default Event Source Description This parameter enables (1) or disables (0) the acoustic echo cancellation (AEC) algorithm. Polycom, Inc.
  • Page 653 The index is used to specify the left (1) or right (2) reference channels. If neither the left nor the right channel have references specified, then the AEC is disabled. If only the left channel is specified, then the mono AEC algorithm is used. If both the left and right channel are specified, then the stereo AEC algorithm is used. Polycom, Inc.
  • Page 654 Value Type Boolean Read/Write Mode Read/Write Phys Chans Conferencing Mic/Line Input, Sound Reinforcement Mic/Line Input, Analog Telephony Input Virt Chans Mono, Stereo Default Event Source Description This parameter enables (1) or disables (0) the automatic gain control (AGC) algorithm. Polycom, Inc.
  • Page 655 Conferencing Mic/Line Input, Sound Reinforcement Mic/Line Input, Analog Telephony Input Virt Chans Mono, Stereo System Limits Minimum: -20.0, Maximum: 0.0, Resolution: 0.1 Default -6.0 User Limits Supported Event Source Description This parameter sets the minimum gain (in dB) that can be applied by the AGC. Polycom, Inc.
  • Page 656 This parameter sets the amount of delay applied to the audio signal, in samples. The sampling frequency is 48 kHz, which means that a sample is 20.83 microseconds. The maximum delay of 96000 samples is equivalent to 2 seconds. Polycom, Inc.
  • Page 657 Channel Type Virtual Channel Value Type Boolean Read/Write Mode Read/Write Phys Chans Conferencing Mic/Line Input, Sound Reinforcement Mic/Line Input Virt Chans Mono, Stereo Default Event Source Description This parameter enables (1) or disables (0) the feedback reduction algorithm. Polycom, Inc.
  • Page 658 0 dB if no singing is detected at that frequency. This mode is useful in rooms with high noise or where there is a lot of motion. Polycom, Inc.
  • Page 659 Conferencing Mic/Line Input, Sound Reinforcement Mic/Line Input Virt Chans Mono, Stereo System Limits Minimum: -100.0, Maximum: 0.0, Resolution: 0.1 Default -15.0 User Limits Supported Event Source Description This parameter sets the maximum attenuation (in dB) that can be applied for any feedback reduction filter. Polycom, Inc.
  • Page 660 Argument value Channel Type Virtual Channel Value Type Sequence Read/Write Mode Read/Write Phys Chans Conferencing Mic/Line Input, Sound Reinforcement Mic/Line Input Virt Chans Mono, Stereo Indices 1-32 : Physical channel System Limits Minimum: 1, Maximum: 15 Default Event Source Polycom, Inc.
  • Page 661 'Ceiling Mic 2 B' 'Ceiling Mic 2 B' 5 is associated with the virtual channel 'Ceiling Mic 2 B'.Since 'Ceiling Mic 2 B' is the second element of the second digital array microphone, the value 5 (=3+2) is returned. Polycom, Inc.
  • Page 662 Sets the mic_source_type for 'Table Mic 1' to analog. 'Table Mic 1' analog 'Table Mic 1' analog get mic_source_type val mic_source_type Queries the mic_source_type for 'Ceiling Mic 1 A'. 'Ceiling Mic 1 A' 'Ceiling Mic 1 A' clink_mic Polycom, Inc.
  • Page 663 Conferencing Mic/Line Input, Analog Telephony Input Virt Chans Mono, Stereo System Limits Minimum: 0.0, Maximum: 20.0, Resolution: 1.0 Default 10.0 User Limits Supported Event Source Description This parameter sets the amount of cancellation (in dB) applied by the noise cancellation algorithm. Polycom, Inc.
  • Page 664 RMS level as a sine wave at -20 dBFS (the nominal signal level). This means that not all signal types will have the same peak level, and some types may clip before a gain of 20 dB is applied. Polycom, Inc.
  • Page 665 When the signal generator’s sig_gen_type is set to sweep, this parameter sets the frequency (in Hz) at which the sweep generator begins. The direction of the frequency sweep will be up or down depending on whether this parameter is higher or lower than the sig_gen_sweep_stop parameter. Polycom, Inc.
  • Page 666 Signal Generator Sweep Stop Frequency—sig_gen_sweep_stop Argument Argument value Channel Type Virtual Channel Value Type Floating-Point Read/Write Mode Read/Write Phys Chans Signal Generator Virt Chans Mono System Limits Minimum: 20.0, Maximum: 20000.0, Resolution: 0.1 Default 20000.0 User Limits Supported Event Source Polycom, Inc.
  • Page 667 10000 User Limits Supported Event Source Description When the signal generator’s sig_gen_type is set to sweep, this parameter sets the duration (in milliseconds) that the sweep generator takes to sweep from its start frequency to its stop frequency. Polycom, Inc.
  • Page 668 System Limits Minimum: 20.0, Maximum: 20000.0, Resolution: 0.1 Default 1000.0 User Limits Supported Event Source Description This parameter sets the frequency (in Hz) of the sine wave produced by the signal generator when its sig_gen_type is set to tone. Polycom, Inc.
  • Page 669 This parameter sets the type of signal produced by the signal generator. The options are pink noise (pink), white noise (white) a sine wave at a single frequency (tone) and a sine wave swept across a range of frequencies (sweep). Polycom, Inc.
  • Page 670: Input Path Parameters

    Conferencing Mic/Line Input, Sound Reinforcement Mic/Line Input Virt Chans Mono, Stereo Values normal : Normal (default) low_delay : Low Delay Event Source Description This parameter selects the version of signal to use for the sound reinforcement triune signal of the specified virtual channel. Polycom, Inc.
  • Page 671 Read/Write Mode Read/Write Phys Chans Conferencing Mic/Line Input, Sound Reinforcement Mic/Line Input Virt Chans Mono, Stereo Default Event Source Description Delay compensation only applies to the ungated signal, and only when it is using the line or bypass options. Polycom, Inc.
  • Page 672: Automixer Parameters

    This parameter defines how much louder (in dB) the microphone's signal level must be above its measured noise floor before it is eligible to be considered active. Higher settings will make the microphone's gating less sensitive, while lower settings will make it more sensitive. Polycom, Inc.
  • Page 673 Virtual Channel Value Type Boolean Read/Write Mode Read/Write Phys Chans Conferencing Mic/Line Input, Sound Reinforcement Mic/Line Input Virt Chans Mono, Stereo Default Event Source Description When this parameter is set to 1, the microphone is considered a chairman microphone. Polycom, Inc.
  • Page 674 Automixer Decay Time—am_decay_time Argument Argument value Channel Type Global System Value Type Integer Read/Write Mode Read/Write Indices 1-63 : group number Systems Limits Minimum: 10, Maximum: 10000 Default 1000 User Limits Supported Event Source Polycom, Inc.
  • Page 675 0 dB is applied to the channel (so that it is always open). Examples Command Response Description set am_en "Table Mic 1" 1 val am_en "Table Mic 1" 1 Enables the automixer processing for the channel "Table Mic 1". Polycom, Inc.
  • Page 676 2 1 val am_gain_sharing 2 1 Selects the gain sharing automixer for the microphones in automixer group 2. set am_gain_sharing 1 0 val am_gain_sharing 1 0 Selects the gated automixer for the microphones in automixer group 1. Polycom, Inc.
  • Page 677 Description This parameter selects the automixer group in which the microphone is a member. Examples Command Response Description set am_group "Table Mic val am_group "Table Mic Assigns "Table Mic 1" to automixer group 1. 1" 1 1" 1 Polycom, Inc.
  • Page 678 Value Type Boolean Read/Write Mode Read/Write Phys Chans Conferencing Mic/Line Input, Sound Reinforcement Mic/Line Input Virt Chans Mono, Stereo Default Event Source Description When this parameter is set to 1, the last mic mode is enabled on the microphone. Polycom, Inc.
  • Page 679 This parameter defines how much attenuation (in dB) is applied to a gated microphone in the specified group when the microphone is fully gated off. This parameter is only used if the automixer group is in gating mode. If it is gain sharing mode, the parameter is ignored. Polycom, Inc.
  • Page 680 Default User Limits Supported Event Source Description This parameter sets the amount of attenuation (in dB) that is applied to the microphones in the specified automixer group if a higher priority microphone in the group is currently active. Polycom, Inc.
  • Page 681 6.0 dB lower than the loudest mic, and its slope is 2.0, then 12.0 dB of attenuation will be applied to the microphone. This parameter is only used if the automixer group is in gain sharing mode. If the automixer group is in gating mode, the parameter is ignored. Polycom, Inc.
  • Page 682: Gpio Control Parameters

    Returns the analog voltage associated with the analog "Analog Logic Pin" "Analog Logic Pin" 0 logic pin "Analog Logic Pin". The logic pin "Analog Logic Pin" must have been created with a vcdef command. Polycom, Inc.
  • Page 683 This parameter specifies the amount of time (in milliseconds) that a GPIO pin must be held for the first digital_gpio_held status message to be sent. Setting this parameter to 0 indicates that digital_gpio_held messages will not be generated. Polycom, Inc.
  • Page 684 Digital General Purpose I/O Input, Digital General Purpose I/O Output Virt Chans Control Default Event Source Description This parameter gets or sets the value of the digital gpio pin. Writing an input has no effect and returns the current value of the input. Polycom, Inc.
  • Page 685: Control Port Parameters

    Read/Write Mode Write-Only System Limits Max String Length : 128 Event Source Description This parameter sets the authentication password. The default value for this parameter is “456”. The settings are permanently changed immediately after the command has been executed. Polycom, Inc.
  • Page 686 Event Source Description This parameter gets the call active status of a Polycom Video Codec. This is true whenever the Polycom Video Codec has an active video or PSTN call. A status message is generated whenever the call active status is changed by a Polycom Video Codec.
  • Page 687 Event Source Description This parameter gets or sets the volume status of a Polycom Video Codec. This does not actually adjust any gains. It only reflects the settings of the on-screen volume control bar of the Polycom Video Codec. A status message is generated whenever the volume is changed by a Polycom Video Codec.
  • Page 688 The addr attribute specifies the IP address of the interface. The dns attribute specifies the domain name server(s). A single server or multiple servers (separated by spaces) may be specified. The gw attribute specifies the gateway. The nm parameter specifies the netmask. Polycom, Inc.
  • Page 689 192.168.10.63 and returns the full Ethernet 168.10.63',dns='192.168. 168.10.63',dns='192.168. settings. All parameters must be specified even if just 10.1',gw='192.168.10.254 10.1',gw='192.168.10.254 changing one parameter. ',nm='255.255.255.0'" ',nm='255.255.255.0'" get eth_settings 1 val eth_settings 1 Queries the Ethernet settings on device 1. "mode='static',addr='192. 168.10.63',dns='192.168. 10.1',gw='192.168.10.254 ',nm='255.255.255.0'" Polycom, Inc.
  • Page 690 Event Source Description When queried, this parameter returns the keycode value of the last key that was pressed on the IR remote. As an event, a status message is generated whenever a key is pressed on the IR remote. Polycom, Inc.
  • Page 691 This parameter sets the channel ID that the specified IR input will respond to. Polycom IR remotes can be configured to use different channel IDs so that multiple remotes can be used in the same room to control different equipment without interfering with each other. By default, the Polycom IR...
  • Page 692 ID 3. This can be changed by following the instructions in the Administrator’s Guide for Polycom HDX System’s. RS-232 Baud Rate—ser_baud Argument Argument value Channel Type Device-Specific System Value Type List Read/Write Mode Read/Write Values 9600 : 9600 bits per second (default)
  • Page 693 : No flow control (default) hw : Hardware flow control (RTS/CTS) Event Source Description This parameter sets the type of flow control that will be used on the RS-232 port. Hardware flow control is recommended for baud rates over 9600 bps. Polycom, Inc.
  • Page 694 The following escape sequences are supported. ● \\ -- a single backslash character ● \\n -- new line ● \\r -- carriage return ● \\xNN -- byte value in hexadecimal (must contain exactly two digits) Polycom, Inc.
  • Page 695: System Parameters

    Description This parameter returns the bootloader version. Firmware Version—dev_firmware_ver Argument Argument value Channel Type Device-Specific System Value Type String Read/Write Mode Read-Only System Limits Max String Length: 24 Event Source Description This parameter returns the device’s firmware version. Polycom, Inc.
  • Page 696 Argument value Channel Type Device-Specific System Value Type String Read/Write Mode Read-Only System Limits Max String Length: 32 Event Source Description This parameter returns the hardware revision of the device. Typical values are “X1”, “X2”, “X3”, “4”, etc. Polycom, Inc.
  • Page 697 Max String Length: 32 Default pool.ntp.org Event Source Description This parameter gets or sets the name of the network time protocol (NTP) server used to set the system time. A power cycle is required for this parameter to take effect. Polycom, Inc.
  • Page 698 1 is at the back right, underneath the plug-in slot. 2 is near the center of the analog input circuitry. 3 is at the front right, in front of the power supply. Polycom, Inc.
  • Page 699 : Conferencing 16x16 c12 : Conferencing 12x12 c8 : Conferencing 8x8 sr16 : Sound Reinforcement 16x16 sr12 : Sound Reinforcement 12x12 sr8 : Sound Reinforcement 8x8 Event Source Description This parameter returns the type of the device. Polycom, Inc.
  • Page 700 ConferenceLink Supply Voltage—dev_volt_clink Argument Argument value Channel Type Device-Specific System Value Type Floating-Point Read/Write Mode Read-Only System Limits Minimum: 0.0, Maximum: 50.5, Resolution: 0.1 Event Source Description This parameter returns the voltage (in Volts) of the ConferenceLink power supply. Polycom, Inc.
  • Page 701 12x12, and four banks on a 16x16. The voltage will be 0 for supplies that are not present on a device. Index 1 corresponds to the phantom power supply on mic inputs 1-4, index 2 corresponds to the phantom power supply on mic inputs 5-8, and so on. Polycom, Inc.
  • Page 702 This parameter returns the voltage (in Volts) of the +15 V power supply. Enable/disable reporting of cmd/ack in logs—sys_cmd_log_en Argument Argument value Channel Type Global System Value Type Boolean Read/Write Mode Read/Write Default Event Source Description This parameter controls whether commands and acknowledgments are reported in the system logs. Polycom, Inc.
  • Page 703 This parameter returns the name of the last executed full preset. Get Last Executed Partial Preset—sys_last_partial_preset Argument Argument value Channel Type Global System Value Type String Read/Write Mode Read-Only Event Source Description This parameter returns the name of the last executed partial preset. Polycom, Inc.
  • Page 704 Enable/Disable Reporting Of mtrreg/mtrunreg In Logs—sys_mtrreg_log_en Argument Argument value Channel Type Global System Value Type Boolean Read/Write Mode Read/Write Default Event Source Description This parameter controls whether mtrreg and mtrunreg commands and acknowledgments are reported in the system logs. Polycom, Inc.
  • Page 705 Global System Value Type Integer Read/Write Mode Read-only System Limits Minimum: 0, Maximum: 256 Event Source Description This parameter returns the total number of Ethernet connections to the system for which the parameter eth_auth_mode is set to auth. Polycom, Inc.
  • Page 706 Number of Devices—sys_num_devs Argument Argument value Channel Type Global System Value Type Integer Read/Write Mode Read-only System Limits Minimum: 1, Maximum: 8 Event Source Description This parameter returns the total number of devices connected over the OBAM bus. Polycom, Inc.
  • Page 707 This parameter pauses system execution for the specified number of milliseconds. Note that the entire command processor is paused, affecting all communication ports. The typical application for this parameter is inserting pauses between commands in partial preset execution. Polycom, Inc.
  • Page 708 This parameter returns true (1) if the actual plug-in cards in the system match the stored configuration. Reset The Device—sys_reboot Argument Argument value Channel Type Global System Value Type Void Read/Write Mode Write-Only Event Source Description Setting this parameter causes all linked devices to reboot as if a power-cycle has occurred. Polycom, Inc.
  • Page 709: Appendix B: Address Book

    IP address changes over time. The address book is located under the Connect menu item as shown in the following figure. The default address book is empty and will appear as shown in the following figure. Polycom, Inc.
  • Page 710: Address Book Soundstructure System Entries

    SoundStructure Studio connects to may be easily added to the address book. Creating Address Book Entries To create an address book SoundStructure system entry, click the ‘New Entry’ menu item and edit the highlighted system name. Polycom, Inc.
  • Page 711 After an entry has been created, the address book will appears as in the following figure. Adding Connected Systems to the Address Book Once SoundStructure Studio is connected to a system, the system may be added to the address book by right clicking on the system name as shown in the following figure. Polycom, Inc.
  • Page 712 Connect button. If any changes are made to the address book, an attempt to navigate away from the address book prompts the user to save changes to the address book. To preserve changes to the address book, answer Yes. Polycom, Inc.
  • Page 713: Address Book Folders

    Type in the name for the folder to overwrite the default name of New Folder as shown in the following figure. A new folder may also be created by right clicking on the top level folder and selecting a new folder. Select the ‘All Entries’ item to see all the SoundStructure systems in the address book. Polycom, Inc.
  • Page 714 A SoundStructure system may be copied from one folder to another by holding the Control key and clicking and dragging the system from the source folder to the target folder. The cursor will show a “+” symbol to confirm that the system is being copied from one folder to another folder. Polycom, Inc.
  • Page 715: Removing Entries From The Address Book

    It is possible to create an address book on one computer and then use that address book as a master address book for an enterprise by storing the address book on a shared drive and have all users point to that file for their address book. Polycom, Inc.
  • Page 716: Appendix C: Designing Audio Conferencing Systems

    Many of the challenges in audio conferencing arise from microphone selection and placement, loudspeaker placement, and balancing the architectural and aesthetics of the room with the requirements for having the best audio quality. Compromises in audio quality in favor of aesthetics will reduce the quality and intelligibility of meetings. Polycom, Inc.
  • Page 717: Large Room Environments

    Due to the design of electret microphones, these microphones come in a large variety of sizes and shapes and can provide excellent audio quality. Polycom, Inc.
  • Page 718 - should the local talker move out of the narrow pick up pattern, their voice will be significantly attenuated. To the remote listeners, it will sound like the local talker has faded out. Polycom, Inc.
  • Page 719 Improving the acoustics in the room can be done by increasing the absorption of surfaces in the room - acoustic paneling, reduced HVAC airflow speed/noise, carpeted floors, curtains, and other absorptive surfaces wherever possible. Polycom, Inc.
  • Page 720: Microphones For Conferencing

    Tabletop Microphones In many conferencing applications boundary tabletop microphones are used and mounted at locations around the table as shown in the following figure where one microphone is used for each two participants. Polycom, Inc.
  • Page 721 It is common for rooms with movable furniture to not have permanently installed microphones on the tables. To accommodate this, microphones are often moved away from the participants and placed in the ceiling. A consequence of this Polycom, Inc.
  • Page 722: Automatic Microphone Mixers

    The ambient noise in the room caused by HVAC, projectors, computers, and even noise external to the room that is picked up by the microphones will reduce the signal to noise ratio at the microphones. This noise will Polycom, Inc.
  • Page 723: Acoustic Echo Cancellation

    In fact, if the elapsed time between when a word is spoken and when its echo is heard is more than 300 msec, the echo will actually cause most talkers to stutter. In Polycom, Inc.
  • Page 724 Aggressive suppression may also vary the level of the transmit audio signal based on whether both the local and remote talkers are speaking at the same time. With less aggressive suppression Polycom, Inc.
  • Page 725: Aec Reference

    The tail time of an echo canceller is the amount of time the echo canceller can still recognize a signal as an echo from the remote talkers' speech and not interpret that signal as speech from a local talker. Polycom, Inc.
  • Page 726: Transmission Delay

    It is not uncommon for networks to require a hundred milliseconds or more to transfer audio from one site to the other. Polycom, Inc.
  • Page 727: Echo Return Loss

    For some manufacturers of echo cancellers, the term ERL is replaced with an equivalent term of conferencing room gain. The conferencing room gain is the negative of the ERL, or defined as 10 Log (B/A). Lower room gain (equivalently higher ERL) in this case will improve the performance of the echo canceller. Polycom, Inc.
  • Page 728: Multi Channel Vs. Single Channel Aec

    AEC has processed the local microphone's audio signal. This allows the acoustic echo canceller to continue to adapt to changes in the room, keeping the acoustic echo canceller converged even though the microphone is "muted". Polycom, Inc.
  • Page 729: Volume Control

    The next most common source of echoes is that the echo canceller reference does not contain all the remote audio sources, allowing one or more remote audio sources to be interpreted as local speech by the echo canceller and consequently sent to the remote participants. Polycom, Inc.
  • Page 730: Telephone Hybrid

    (and hence causing more side-tone) but it may not completely cancel the signal as the system will be in double-talk, meaning Polycom, Inc.
  • Page 731: Amplifiers

    'transformer tapped' depending on the style of amplifier they will be connected to. Just as microphones are characterized by their pickup pattern, frequency response, and sensitivity to sound, loudspeakers are characterized by their frequency response (80 Hz to 20 kHz typical), power Polycom, Inc.
  • Page 732 In a conference room with 9 foot high ceilings and seated listeners' ears about 3 ½ feet above the floor, this rule of thumb corresponds to a Polycom, Inc.
  • Page 733: Speaker Zoning And Placement

    33x20 feet (approximately 700 sq. ft.) in the following figure. As discussed in an earlier section, the microphones should Polycom, Inc.
  • Page 734 (8 ) Table top microphone (8x) Polycom, Inc.
  • Page 735: Loudspeakers - How Much Power Is Required

    ERL will be reduced and there is a higher chance of residual echo being sent to the remote participants. Typically the configuration software with the audio conferencing product will provide a tool where the ERL can be checked to ensure it is within the recommended operating range for that particular Polycom, Inc.
  • Page 736: In-Room Reinforcement

    20-feet square. A room 20-feet by 40-feet would be 2 zones, one 40-foot square would be 4 zones and so on. Long, narrow boardrooms will often require this type of voice reinforcement application. Polycom, Inc.
  • Page 737 With reinforcement applications, remember that the key to success is setting the appropriate performance expectations with the end user and it is the responsibility of the conference room designer to set that expectation. Polycom, Inc.

This manual is also suitable for:

Soundstructure c8Soundstructure c12Soundstructure sr12

Table of Contents

Save PDF