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

Advertisement

Design Guide
for the Polycom SoundStructure
C16, C12, C8, and SR12
Revision F.1
|
January 2012
|
1725-33186-001

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 for the Polycom SoundStructure C16, C12, C8, and SR12 Revision F.1 January 2012 1725-33186-001...
  • Page 2 Design Guide for SoundStructure C16, C12, C8, and SR12 Polycom, Inc.
  • Page 3 As between the parties, Polycom, Inc., retains title to and ownership of all proprietary rights with respect to the software contained within its products. The software is protected by United States copyright laws and international treaty provision.
  • Page 4 Design Guide for SoundStructure C16, C12, C8, and SR12 Polycom, Inc.
  • Page 5: Table Of Contents

    Contents: Introduction ......... 1–1 SoundStructure Product Family .
  • Page 6 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Step 3 - Device Selection ......... . 4–6 Step 4 - Uploading Or Working Offline .
  • Page 7 Processing On The Signals The Polycom HDX Sends To SoundStructure 6–6 Output Channels To The Polycom HDX ......6–7 Signal Routing Inside The Polycom HDX .
  • Page 8 SoundStructure Logs ..........7–14 Connecting Polycom HDX Microphones ......7–15 Multiple Polycom HDX Video Conferencing Systems .
  • Page 9 Setting up Polycom Touch Control log management ....11–11 Updating Polycom Touch Control Software ......11–12...
  • Page 10 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Using the Polycom Touch Control with SoundStructure ....11–13 Designing a SoundStructure Project with the Polycom Touch Control . 11–13 Using Multiple SoundStructure Telephony Interfaces .
  • Page 11 Controlling The System ......... 13–45 8 Mics With The Polycom HDX Video Conferencing System ... . . 13–46...
  • Page 12 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Matrix Settings ..........13–48 Channels Settings .
  • Page 13 Conference Link2 ..........15–5 OBAM Link .
  • Page 14 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Address Book ........B–1 Introduction .
  • Page 15: Introduction

    Polycom Touch Control™ for the ultimate experience with HD voice, video, content, and ease of use. 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.
  • Page 16 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 • Ethernet port for easy configuration and device management • Event engine for using internal state information such as muting, logic input and logic output ports, and an IR remote for controlling...
  • Page 17 IP addresses and how to view the internal SoundStructure logs, and more. • Chapter 11 provides the steps for using the Polycom Touch Control with a SoundStructure system. See the Users Guide for SoundStructure and the Polycom Touch Control for instructions on how to use the Polycom Touch Control with SoundStructure.
  • Page 18 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 1 - 4...
  • Page 19: Soundstructure Product Family

    SoundStructure Product Family There are two product lines in the SoundStructure product family - the Sound- Structure C-series designed for audio conferencing applications (the “C” stands for conferencing) and the SoundStructure SR-series designed for com- mercial sound applications (the “SR” stands for sound reinforcement). While these two product families share a common design philosophy they have audio processing capabilities that are designed for their respective appli- cations.
  • Page 20 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 the following figure for a SoundStructure device that has N inputs and N out- puts. The specific input and output processing will depend on the product family (C-series or SR-series) and is described later in this chapter.
  • Page 21: Obam™ - One Big Audio Matrix

    SoundStructure Product Family echo cancellation. The processing capabilities will be described in the follow- ing sections. SoundStructure C-Series SR-Series Input Processing ✔ ✔ Up to 8th order highpass and lowpass ✔ ✔ 1st or 2nd order high shelf and low shelf ✔...
  • Page 22 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 • The a/v designer can be more creative as there are no limitations on how signals from multiple devices can be used together • The device linking scheme is completely transparent to the designer - all...
  • Page 23: Soundstructure C-Series Products

    Phantom power is available on all inputs. All outputs have the same processing capability. A single SoundStructure C16, C12, or C8 device supports 16, 12, or 8 micro- phone or line inputs and 16, 12, or 8 line outputs, respectively. Up to eight...
  • Page 24 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Each SoundStructure C-series device may be used with traditional analog microphones, with Polycom's HDX digital microphone arrays . For detailed information on using the Polycom HDX digital microphone arrays, see Chap- ter 6.
  • Page 25: C-Series Input Processing

    SoundStructure Product Family C-Series Input Processing The input processing on the SoundStructure C-series devices is designed to make it easy to create conferencing solutions either with or without sound reinforcement. Each audio input on a SoundStructure C-series device has the processing shown in the following table.
  • Page 26 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 is processed by five different DSP algorithms: parametric equalization, acous- tic echo cancellation, noise cancellation, feedback reduction, and echo suppression (non linear processing). C-Series Input Processing Dynamics Fader Delay...
  • Page 27 SoundStructure Product Family Each analog input signal is processed to create three processed versions that can be used in different ways in the matrix. These three different versions of the input signal mean that, at the same time, an output signal to the loudspeakers can use the sound reinforcement pro- cessed version of an input signal, an output signal to the video conferencing system can use the conferencing processed version of the input signal, and an output signal to the recording system can use the recording processed version...
  • Page 28 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 automatic gain control on the sound reinforcement path from increasing the microphone gain and consequently reducing the potential acoustic gain before the onset of feedback. C-Series Sound Reinforcement Input Processing...
  • Page 29 SoundStructure Product Family on an input signal. This version of the signal has no acoustic echo cancellation processing and will consequently include any acoustic echo signal that may be present at the microphones. UNGATED - Bypass Dynamics Fader Delay Mute Automatic Dynamics Input to...
  • Page 30: C-Series Matrix Crosspoints

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Recording/Ungated - Sound Reinforcement Finally, the sound reinforcement recording input includes the echo and noise cancellation and optional feedback elimination processing as shown in the fol- lowing figure. UNGATED - Sound Reinforcement Processing...
  • Page 31: C-Series Output Processing

    SoundStructure Product Family The following figure highlights how to interpret the matrix crosspoints in the matrix. Arc indicates L/R balance or pan Outputs No arc indicates centered balance/pan Value of crosspoint is the gain in dB Ungated/Recording Bold text Indicates signal is unmuted Conferencing Sound Reinforcement Crosspoint background indicates...
  • Page 32: C-Series Submix Processing

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 C-Series Submix Processing Submixes are outputs from the matrix that can be routed directly back to the input of the matrix as shown in the following figure. Matrix Output...
  • Page 33: C-Series Acoustic Echo Canceller References

    SoundStructure Product Family As shown in the following figure, each submix signal from the matrix can be processed with dynamics processing, parametric equalization, a fader, and up to 1000 milliseconds of delay. Each SoundStructure device has as many sub- mixes as there are inputs. Telco Telco Telco...
  • Page 34: Soundstructure Sr-Series Products

    Chapter 14. An acoustic echo canceller reference can be created 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 can be defined and selected.
  • Page 35 SoundStructure Product Family ment, and broadcasting. The following figure shows an example of using the SoundStructure SR12 to provide additional line level inputs and outputs to a SoundStructure C8 conferencing product. Telephony PSTN Telco Network Microphones Local Audio Loudspeakers Playback Amplifier SoundStructure Video...
  • Page 36 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 SoundStructure C-series device, either the next largest C-series device or addi- tional C-series devices must be used to support the number of microphones required. Telephony PSTN Telco Network Microphones...
  • Page 37: Sr-Series Input Processing

    SoundStructure Product Family SR-Series Input Processing The input processing on the SoundStructure SR-series devices is designed to make it easy to create commercial sound and sound reinforcement solutions. Each audio input on a SoundStructure SR-series device includes the signal processing path shown in the following table. SR-Series Input Processing Up to 8th order highpass and lowpass 1st or 2nd order high shelf and low shelf...
  • Page 38 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 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 analog gain in 0.5 dB incre-...
  • Page 39 SoundStructure Product Family The automixer processing is only applied to the noise cancelled and sound reinforcement signal paths to ensure that there is an 'un'-automixed version of the input signal available for recording/ungated applications SR-Series Input Processing Dynamics Fader Delay Mute Automatic Dynamics...
  • Page 40 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 to paging zones that are not acoustically coupled to the microphone. This is the default processing for microphone inputs when the automixed version of the signal is selected. SR-Series Noise Cancellation Input Processing...
  • Page 41 SoundStructure Product Family Recording/Ungated Version The recording version of the processed input signal is specifically designed to not include any gain sharing or gated-style of automatic microphone mixing processing. The recording/ungated version of the input is used for recording applications or in any application where an un-automixed version of the input signal is required.
  • Page 42 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Recording/Ungated - Line Input The recording - line input version includes equalization, automatic gain con- trol, and the dynamics processing as well as fader gain control, input delay, and input mute as shown in the next figure. This processing path is typically used by line input signals such as program audio, and hence the name line input path.
  • Page 43: Sr-Series Matrix Crosspoints

    SoundStructure Product Family SR-Series Matrix Crosspoints The audio matrix is used to create different mixes of input signals and submix signals to be sent to output signals and submix signals. Matrix crosspoints gain values are shown in dB where 0 dB means that the signal level is unchanged. Matrix crosspoint gains can be adjusted in 0.1 dB steps between -100 and +20 dB and may also be completely muted.
  • Page 44: Sr-Series Submix Processing

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Telco Telco Telco Processing Telco Processing Processing Processing Input Output Processing Processing Input Output Processing Processing Matrix Input Output Processing Processing Submix SubMix Processing Processsing SR-Series Output Processing Parametric...
  • Page 45: Telephony Processing

    SoundStructure Product Family Telco Telco Telco Processing Telco Processing Processing Processing Input Output Processing Processing Input Output Processing Processing Matrix Input Output Processing Processing Submix SubMix Processing Processsing Submix Processing Mute Submix Input Dynamics Parametric Submix output Fader Delay from Matrix Processing Equalization to Matrix...
  • Page 46 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The SoundStructure telephony cards have been designed to meet various regional telephony requirements through the selection of a country code from the user interface. For each telephony interface card, the signal processing is listed in the following table and shown in the following figure.
  • Page 47 SoundStructure Product Family detector that analyzes the telephony input signal and reports if any call prog- ress tones are present (for example, if the telephony line is busy, the phone is ringing, etc.). Telco Telco Telco Processing Telco Processing Processing Processing Input Output...
  • Page 48 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 2 - 30...
  • Page 49: Soundstructure Design Concepts

    SoundStructure Design Concepts Before creating designs for the SoundStructure devices, the concepts of physi- cal channels, virtual channels, and virtual channel groups will be introduced. These concepts form the foundation of SoundStructure audio designs. In addi- tion, the concepts of defining control virtual channels and control array virtual channels from the logic input and output pins will be introduced.
  • Page 50: Physical Channels

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 or outputs are used from one design to the next, this requires changing the control system code programming and spending additional time debugging and testing the new code to ensure the new device identifications and channel numbers are used properly.
  • Page 51: Physical Channel Numbering On A Single Soundstructure Device

    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. This continuation of the sequence of numbers is possible due to the design of the OBAM Link interface.
  • Page 52 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The OBAM link is bidirectional - data flows in both an upstream and down- stream direction meaning that the bus does not need to be looped back to the first device.
  • Page 53 1 through N where N is the number of inputs and outputs on the device (for instance, 16 inputs for a SoundStructure C16 device). 2. The SoundStructure device whose OBAM IN port is connected to the...
  • Page 54 SoundStructure C16 devices shown in the following figure. In this exam- ple the OBAM output of device A is connected to the OBAM input of device B and the OBAM output of device B is connected to the OBAM input of device C.
  • Page 55 SoundStructure Design Concepts Device A's inputs and outputs become the first sixteen physical inputs and six- teen outputs on the system, device B's inputs and outputs become the next sixteen physical inputs and next sixteen physical outputs on the system, and device C's inputs and output become the last sixteen physical inputs and six- teen physical outputs on the system.
  • Page 56 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 finally device B becomes the third device in the link. The result is that the inputs and outputs on device C will become inputs 17-32 and outputs 17-32 on the full system even though device B is physically installed on top of device C.
  • Page 57: Physical Channel Summary

    The first input on the second device will be input 17 (if the first device is a SoundStructure C16). In the next section, the concept of physical channels will be extended as the...
  • Page 58: Virtual Channels

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Virtual Channels A virtual channel can be thought of as a layer that is wrapped around one or more physical channels. A virtual channel can represent either an individual physical channel or it can represent a collection of strongly associated physical channels, such as a stereo pair of signals as shown in the following figure.
  • Page 59: Virtual Channel Summary

    SoundStructure Design Concepts ple, mutes or changes volume) the SoundStructure devices through the virtual channel names, not the underlying physical input and output that a particular audio signal is connected to. 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”.
  • Page 60: Virtual Channel Groups

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Using SoundStructure virtual channels is the only way to configure and con- trol the underlying physical channels with third-party control systems. The physical input and output channel numbering described in section 3.1...
  • Page 61 SoundStructure Design Concepts As an example of a virtual channel group, consider in the next figure the cre- ation of the virtual channel group “Mics” made up of the entire collection of individual microphone virtual channels in a room. Once the virtual channel group “Mics”...
  • Page 62 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 HDX video codec is connected over the digital ConferenceLink interface.
  • Page 63 SoundStructure Design Concepts Virtual channel definitions could be defined as shown in the following figure. Physical Channel Virtual Channel Virtual Channel Groups Inputs “Wireless mic” “Reinforced Mics” “Podium mic” “Table mic 1” “Table mic 2” “All Mics” “Table mic 3” “Table mic 4”...
  • Page 64: Virtual Channel Group Summary

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Virtual Channel Group Summary Virtual channel groups are an easy way to create groups of signals that may be controlled together by sending an API command to the virtual channel group name.
  • Page 65: Physical Logic Pins

    SoundStructure Design Concepts Physical Logic Pins The physical logic pins and their labeling is shown in the following figure. Signal REMOTE CONTRO Logic output 1 Logic output 2 Logic output 3 Pin 13 Pin 1 Logic output 4 Logic output 5 Logic output 6 Logic output 7 Logic output 8...
  • Page 66 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 When multiple devices are OBAM linked as shown in the next figure, the logic inputs and outputs on the first device will be numbered 1 - 22 and the logic inputs and outputs on the second device (device B) will be numbered 23 - 44, and so on.
  • Page 67 SoundStructure Design Concepts Logic Inputs All digital logic inputs (logic inputs 1 - 22) operate as contact closures and may either be connected to ground (closed) or not connected to ground (open). The logic input circuitry is shown in the following figure. The default value for logic inputs is 1 due to the pull up resistor.
  • Page 68: Control Virtual Channels

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Logic Outputs All logic outputs are configured as open-collector circuits and may be used with external positive voltage sources. The maximum voltage that should be used with the logic outputs is 60 V. Each pin may sink up to 60mA. When using the internal 5V power supply, the maximum current that may supplied across all logic outputs on a SoundStructure device is 500 mA.
  • Page 69: Control Array Virtual Channels

    SoundStructure Design Concepts Logic pins can be defined via the command line interface from SoundStructure Studio or a control terminal with the following syntax to define a logic input on logic input pin 1: vcdef “Logic Input Example” control digital_gpio_in 1 which will return the acknowledgement vcdef "Logic Input Example"...
  • Page 70 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The value of the digital control array is the binary sum of the individual logic pins. For example if a control array virtual channel is defined with digital output pins 2, 3, and 4, then the value of the control array channel will be in the range of 0 to 7 with physical logic pin 4 as the most significant bit and phys- ical logic pin 2 as the least significant bit.
  • Page 71: 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 HDX IR transmitter, a command acknowl- edgement of the form: val ir_key_press “IR Input” 58 will be generated by the SoundStructure device when a key that corresponds to code 58 is pressed on the IR remote transmitter.
  • Page 72 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 3 - 24...
  • Page 73: Creating Designs With Soundstructure Studio

    Creating Designs with SoundStructure Studio A SoundStructure configuration file is a binary file that includes the definition of the virtual channels, the virtual channel groups, the appropriate input and output gain settings, echo cancellation settings, equalization, matrix routings, and more. This file may be uploaded to SoundStructure devices or stored on the local PC for later upload.
  • Page 74: Soundstructure Studio

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 SoundStructure Studio The first step to creating a SoundStructure design is to launch the SoundStruc- ture Studio application. If the SoundStructure Studio software is not already installed on the local PC, it may be installed from the CD that was included with the product.
  • Page 75 Creating Designs with SoundStructure Studio Once installed, launch SoundStructure Studio and select New Project from the File menu as shown in following figure. Step 1 - Input Signals Creating a new project will show the 'Create a Project' window as shown in the following figure.
  • Page 76 SoundStructure Best Practices document. The choices for Hybrids/Codecs include the Polycom HDX video codec, the Polycom VSX series, and a generic mono or stereo video codec. When the Poly- com HDX video codec is selected, it is assumed that the Polycom HDX connects to the SoundStructure device over the Conference Link2 interface.
  • Page 77 Creating Designs with SoundStructure Studio When a Polycom HDX video codec is selected, there are multiple audio chan- nels that are created automatically and usable independently in the SoundStructure matrix. See Chapter 6 - Connecting over CLink2 for additional information on the audio channels and the processing that is available on these channels.
  • Page 78: Step 3 - Device Selection

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Step 3 - Device Selection In Step 3, the devices that will be used with the design are selected as shown in the following figure. By default, SoundStructure Studio will display the equipment with the mini-...
  • Page 79 Creating Designs with SoundStructure Studio the file offline, customize settings - including the wiring page as described in the next chapter if the system has already been cabled, and then upload the set- tings to the device for final online adjustments. In this example, the design file will be created offline for offline configuration and later uploaded to the device.
  • Page 80: Online Vs. Offline

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Once the finish button is clicked, the SoundStructure Studio software will create the entire design file including defining all the virtual channels and vir- tual channel groups such as those shown the following figure.
  • Page 81 Creating Designs with SoundStructure Studio to the devices and receiving command acknowledgements from the devices. Every change to the SoundStructure design is made in real-time to the actual devices. There is no requirement to compile any SoundStructure Studio code before the impact can be heard -- all changes happen in real-time. Offline operation means that SoundStructure Studio is working with an emu- lation of the SoundStructure devices and is not communicating with actual SoundStructure devices.
  • Page 82 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 In this example the virtual channel group “Mics” was muted and the console shows the command in blue and the acknowledgements generated in green. When SoundStructure Studio is working offline, the prefix [Offline]: is shown in the console as a reminder that commands are not being sent to actual devices.
  • Page 83: Customizing Soundstructure Designs

    Customizing SoundStructure Designs Once a SoundStructure project file has been created as described in the previ- ous chapter, the SoundStructure Studio software can be used to adjust and customize the design. This section provides in-depth instructions on how to customize the settings by using the Wiring, Channels, Matrix, Telephony, and Automixer pages.
  • Page 84 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 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. If it is necessary to change the wiring from the default wiring, the virtual wiring may be changed by clicking and dragging signals from their current input or output to a new input or output as shown in the following figure.
  • Page 85 Customizing SoundStructure Designs When a virtual channel is moved, SoundStructure Studio redefines the virtual channel to use the new physical inputs or outputs that are specified. Moving a virtual channel does not create any visible changes in the matrix or channels page since SoundStructure Studio operates at the level of the virtual channel and not the physical channels.
  • Page 86: Edit Devices

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Edit Devices When working offline, the Wiring Page includes an “Edit Devices” control for changing the underlying SoundStructure equipment that was selected during the design process as shown in the following figure.
  • Page 87: Channels Page

    Customizing SoundStructure Designs To reduce the equipment on a project that has too many inputs or outputs to fit into the next smaller SoundStructure device requires removing audio chan- nels from the “Edit Channels” control. Channels Page The channels page is the primary area for customizing the signal gains and processing for the input, output, and submix signals.
  • Page 88 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 the output signals have a blue shading and outline to match the rear-panel labeling. The submixes have a purple shading and outline. See the following figures for examples of the different user controls.
  • Page 89: Editing Virtual Channels

    Customizing SoundStructure Designs In addition, groups of virtual channels may be expanded to show the individ- ual members of the group by clicking the Expand All button or may be collapsed to only show the virtual channel groups by clicking the Collapse All button as shown in the following figure.
  • Page 90: Creating Virtual Channel Groups

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The Edit Channels button will open the input and output channel selection window and allow the designer to add or remove virtual channels as shown in the following figure. If virtual channels are added, they will appear on the...
  • Page 91 Customizing SoundStructure Designs 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. To create additional virtual channel groups, click the Edit Groups button on the Channels page to cause the Edit Groups screen to appear as shown in the following figure.
  • Page 92 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 To add a new virtual channel group, enter a group name in the Group Label: field and then click the Add Group button as shown in the following figures.
  • Page 93 Customizing SoundStructure Designs and then shift-clicking on subsequent virtual channels. Once the virtual chan- nels have been selected, click the Add Channel button as shown in the following figure. Any commands that are sent to configure the virtual channel group “Zone 1 Mics”...
  • Page 94 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 If individual members of a group have different values for the same parame- ter, such as the mute state, the value of the group parameter will be shown with a crosshatch pattern as shown in the following figures.
  • Page 95: Step 1 - Input Signals

    Customizing SoundStructure Designs Changing the settings of all members in the group individually to a common value does not cause the virtual channel group to show that common value. Input Signals The settings that can be applied to input channels depend on the type of vir- tual channel created from that physical input.
  • Page 96 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Enable Meters. Another way to enable meters is to right click on the lower right hand corner of the screen and select the desired meter state. Both options are shown in the following figure.
  • Page 97 Customizing SoundStructure Designs Meter Types There are typically two types for meters that are available for each input chan- nel - a level that is before, or pre, any processing known as a level_pre and a level that is after, or post, any input processing known as level_post. The level_pre meter always shows the signal level just after the A/D con- verter.
  • Page 98 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The level_post meter is after any processing as shown in the following figure. In the example above, if the input signal is muted the level_post meter will not show any signal activity.
  • Page 99 Customizing SoundStructure Designs Line Input level_post Line input channels, such as program audio or audio from video codecs that are connected via analog inputs and outputs, will be metered at the Record- ing/Ungated output shown in the following figure. Stereo virtual channels will display two meters - one for each physical channel.
  • Page 100 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Telephony leve_pre and level_post For telephony channels, the level_pre and level_post for the phone input chan- nel and level_post for the phone output channels are shown in the following figure.
  • Page 101: Input Channel Controls

    Dynamics Parametric Fader Delay Video Call In Processing Equalization Inputs from Polycom HDX Matrix over CLINK2 PSTN In UI Audio In level_pre level_post Input Channel Controls This section discusses the input controls in the order that they appear on the channels page.
  • Page 102: Analog Signal Gain

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 on those signal paths. More frequently used controls such as input gain and input fader are always available and are visible even when the control is collapsed. Analog Signal Gain SoundStructure devices have a continuous analog input gain stage that oper- ates on the analog input signal and has a range of -20 dB to +64 dB with 0.5 dB...
  • Page 103: Mute

    Customizing SoundStructure Designs input signal. As a result, 48 dB of gain on a SoundStructure input is equivalent to a gain of 15 dB on a Vortex mic/line input that is in mic mode because of the additional 33 dB of gain on the Vortex when in mic mode. Since there is only one large input range on SoundStructure devices, it is easier to see how much gain is required for each microphone input.
  • Page 104: Ungated Type

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 To enable or disable the phantom power, expand the level control by clicking on the expand graphic in the upper right corner and click the phantom power button which is labeled Phan.
  • Page 105 Customizing SoundStructure Designs Once the ungated signal is selected in the matrix, the decision of which ungated type of the signal is used is made on the channels page on an input by input basis. As described in Chapter 2, there are four different types of ungated signal pro- cessing paths that may be selected for each input.
  • Page 106 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Most applications benefit from the Line Input ungated signal processing path for program audio and other non-microphone audio that is not usually automixed. An example of using the line input processing is shown in the following figure where a program audio source can be processed with parametric equalization, automatic gain control, dynamics processing, fader, delay, and input mute.
  • Page 107: Delay Type

    Customizing SoundStructure Designs UNGATED - Bypass UNGATED - Bypass Dynamics Fader Delay Mute Automatic Dynamics Input to Recording/ Fader Delay Gain Control Processor Matrix Ungated Router Automixer Non Linear Mic or Line Analog Parametric Acoustic Echo Noise Automatic Dynamics Input to Conferencing Automixer Fader...
  • Page 108 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The normal delay type for the Sound Reinforcement ungated type corresponds to the processing paths that have been defined previously and shown in the following figure. UNGATED - Sound Reinforcement Processing...
  • Page 109: Delay Compensation

    Customizing SoundStructure Designs The signal processing associated with the low delay option is shown in the fol- lowing figure for both the ungated sound reinforcement path and automixed sound reinforcement paths. UNGATED - Sound Reinforcement Processing Dynamics Fader Delay Mute Automatic Dynamics Input to...
  • Page 110: Trim

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The option for the delay compensation is shown when the Line Input or Bypass ungated signal type is selected as shown in the following figure. Trim The trim command is used with stereo virtual channels to provide additional gain or attenuation in the analog domain to the underlying left or right physi- cal channels in case the incoming signal levels need to be adjusted separately.
  • Page 111: Equalization

    Customizing SoundStructure Designs The trim gain will be applied in the analog input gain as long as the trim plus the analog input gain do not exceed 64 dB. Additional trim gain beyond a total gain of 64 dB will be added in the digital domain. Equalization The equalization processing that is available for each input consists of dedicated...
  • Page 112 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The equalization page also shows the feedback elimination user controls and a list of frequencies where feedback was found when the processing was enabled. To enable a filter, click the button next to the filter, and then adjust the param- eters for the filter block as shown in the following figure.
  • Page 113: Feedback Elimination

    Customizing SoundStructure Designs • Parametric filter • Notch filter • Allpass filter Parametric filters emphasize or de-emphasize the center frequency with a gain and bandwidth setting. The user can specify the bandwidth (in octaves), center frequency (in Hz), and gain (from 0 to 20 dB). Notch filters eliminate energy (attenuate only) at the center frequency.
  • Page 114 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Selecting the Edit button will open the equalization user control where param- eters for the feedback eliminator may be specified as shown in the following figure. There is a safe mode attenuation that defines the amount of attenuation that can be applied to the signal if the feedback eliminator filters are all engaged and there is still feedback.
  • Page 115: Acoustic Echo Cancellation (Aec)

    Customizing SoundStructure Designs The sound reinforcement signal path is selected at the matrix crosspoint by selecting the Snd Reinforcement option of the gated/automixed as shown in the following figure. Selecting the Snd Reinforcement option will ensure that the proper input processing path is selected for routing microphones to loudspeakers.
  • Page 116: Noise Cancellation

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The AEC references for each input are specified in the pull-down combination boxes for the associated input signal. As described in the section on virtual channel groups, the AEC reference for the entire virtual channel group can be selected and that information will propagate to all the virtual channels of the group.
  • Page 117 Customizing SoundStructure Designs Noise cancellation can be enabled 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). The ungated conferencing signal path is shown in the following figure.
  • Page 118: Automatic Gain Control (Agc)

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Once the conferencing ungated type is selected in the channels page as shown in the following figure, the ungated signal path may be selected in the matrix as shown in the following figure. This selection chooses the conferencing ungated signal path and allows the user to enable noise cancellation on that input signal.
  • Page 119: Dynamics Processing

    Customizing SoundStructure Designs The range of the AGC can be adjusted by expanding the AGC control and adjusting the maximum and minimum gains. By default the maximum and minimum gain are set to 6 and -6 respectively on microphone and telephony signals.
  • Page 120 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 • Gate The SoundStructure Studio user interface for adjusting the dynamics settings are shown in the following figure. The dynamics processing can be turned on or off for a channel by toggling the enable button on either the channels page or on the dynamics control high- lighted on the previous figure.
  • Page 121 Customizing SoundStructure Designs the compressor’s threshold, the compressor applies attenuation so that the output signal increases at a rate of one over the compression ratio past the threshold. Signals below the threshold are not modified, signals above the threshold are “compressed” or scaled by the compression ratio. For example, if the compression ratio is set to 4:1, the threshold is set to -10 dBFS , and the input signal level is -2 dBFS (8 dB above the threshold) the com-...
  • Page 122 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Gates and Expanders Expanders and gates are another form of dynamics processing that attenuate low level signals and leave the high level signals alone. 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)
  • Page 123: Automatic Microphone Mixing

    Customizing SoundStructure Designs The gate decay controls how quickly the gain ramps down once the signal level is lower than the gate threshold and the gate hold time has expired. The expander threshold is the RMS level in dBFS of the input signal that when below this threshold, the expander will engage.
  • Page 124 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Automixer Controls The SoundStructure Studio user controls for configuring the automixers are shown in the following figure. Channels can be added to the automixer group by selecting the Add Channels button and channels can be removed by select- ing the Remove Channels button.
  • Page 125 Customizing SoundStructure Designs Hold Time Hold Time specifies the amount of time a channel will remain active after the last detected significant signal level. This should be set long enough to remain active during short pauses in speech. Camera Activity Time Camera Activity Time specifies how long the microphone must be considered active before a camera indicator is set.
  • Page 126 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Camera activity is similar to channel activity, but has some additional time that the microphone must be gated before the camera gating indicator is made active. The camera gating status is intended to be used with logic outputs or control systems that interface to a camera positioning system that can have various presets according to which microphones are active.
  • Page 127: Delay

    Customizing SoundStructure Designs • If all of the microphones have last mic mode enabled, the last mic to have activity will always be gated on. • If only one microphone has last mic mode enabled, this microphone will turn on when no other microphones are active. An example of this could be with an instructor’s microphone.
  • Page 128: Fader

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Fader The fader control enables the user to add gain or attenuate the input signal from +20 dB to -100 dB in 0.1 dB increments. This gain or attenuation is applied in the digital domain.
  • Page 129: Signal Generator

    Customizing SoundStructure Designs Signal Generator Each SoundStructure device can have a single signal generator defined can generate white noise, pink noise, a sine wave, and a sine sweep. By default, each project will have a signal generator with pink noise at a level of -30dB added to the project.
  • Page 130: Step 2 - Output Signals

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Output Signals This section describes the user interface for configuring output signals. Every output signal has the processing capabilities described in the following section. All output signals have signal meters as shown in the following figure. To enable the signal meters, select the menu item Tools and then Options.
  • Page 131: Dynamics

    Customizing SoundStructure Designs Output Processing Reference Parametric Mute Output from Dynamics Analog Output or Graphic Fader Delay Matrix Processing Converter Gain Signal Equalization level_post Dynamics The output dynamics processing available on the outputs is the same as the input dynamics processing and is described previously in the Dynamics Pro- cessing section of Input Signals in this chapter.
  • Page 132 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 To enable the graphic equalizer, select the Graphic from the Output EQ Type parameter and to enable the parametric equalizer, select Parametric from the Output EQ Type parameter as shown in the following figure.
  • Page 133: Delay

    Customizing SoundStructure Designs The nominal and exact center frequencies of these equalizers are shown in the following table. Center Freq (Hz) 1 octave band 2/3 octave band 1/3 octave band — — — — — — — — — — —...
  • Page 134: Submix Signals

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Submix Signals This section describes the processing that is available for each submix channel. Submixes may be defined as mono virtual channels or stereo virtual channels. When the submix is a stereo virtual channel, the processing is applied equally to both the left and the right physical channels that define the stereo virtual channel.
  • Page 135 Customizing SoundStructure Designs • High Pass, • Low Shelf, • High Shelf, and • 10 parametric equalizers as shown in the following figure. To enable a filter, click the check box next to the filter. This will make the filter the active filter and allow the parameters to be changed as shown next.
  • Page 136: Delay

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Allpass filters do not modify the gain of the signal, but change the phase. For a second order allpass filter, the phase shift is 0 degrees at 0 Hz, 360 degrees at high frequencies, and 180 degrees at the center frequency.
  • Page 137 Customizing SoundStructure Designs 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. Each group of virtual channels has a heading associated with it - the virtual channel group name - that allows the group to be collapsed or expanded.
  • Page 138: Adjusting Crosspoints

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The collapsed view simplifies the configuration and setup of the system as there are fewer crosspoints to manage. Adjusting Crosspoints Any matrix crosspoint may be adjusted over the range of +20 dB to -100 dB in 0.1 dB increments.
  • Page 139 Customizing SoundStructure Designs The matrix also shows the input or output fader control and mute status for the input and output signals as highlighted in the following figure. The faders and mute status may be adjusted on the matrix page or on the channels page. To edit a crosspoint, double left click on the crosspoint to bring up the Edit Crosspoint control.
  • Page 140 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 All the Edit Crosspoint controls allow the user to adjust the crosspoint gain in dB by adjusting the slider or by clicking in the value cell and typing in a gain adjustment directly.
  • Page 141 Customizing SoundStructure Designs forcement version of the crosspoint is selected. Typically when microphones are sent to loudspeakers, the sound reinforcement version of the input pro- cessing should be selected. 5 - 59...
  • Page 142 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 To select the conferencing version of the input processing, select the Gated and Conferencing as shown in the following figure. The crosspoint background will turn blue to indicate the conferencing version of the input processing is selected.
  • Page 143: Matrix Summary

    Customizing SoundStructure Designs A pan value of 1 means that the mono virtual channel is only mapped to the right output physical channel, a value of -1 means that the mono virtual chan- nel is mapped to the left output physical channel. Values between -1 and 1 are shown in the following figure.
  • Page 144: Telephony Channels

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 path on the SR-series), light blue indicates the sound reinforcement path, and white indicates the ungated/recording path. Arc indicates L/R balance or pan Outputs No arc indicates centered balance/pan...
  • Page 145: Input Gain

    Customizing SoundStructure Designs The controls for both the telephone input and output channels will be described in this section. Input Gain The telephone input gain has a range from -20 to +20 dB for adjusting the gain in the analog domain and has a default gain of 0 dB. The gain required will depend on the signal levels received from the telephone line.
  • Page 146: Noise Cancellation

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 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 channel. The input channel level_post meter corresponds to the meter next to the input fader control.
  • Page 147: Dynamics

    Customizing SoundStructure Designs The AGC can be turned on or off with the AGC enable button. When the AGC is enabled, the current AGC gain (or attenuation) can be viewed from the AGC meter and the text box next to the AGC meter. The range of the AGC can be adjusted by expanding the AGC control and adjusting the maximum and minimum gains.
  • Page 148 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 as shown in the following figure. The telephone input and output can be con- figured to have different equalization. To enable a filter, click the check box next to the filter. This will make the filter the active filter and allow the parameters to be changed as shown next.
  • Page 149: Fader

    Customizing SoundStructure Designs Fader The fader control enables the user to add gain or attenuate the telephone signal from +20 dB to -100 dB with a resolution of 0.1 dB. This gain is applied in the digital domain. A maximum and minimum gain range can be specified for the faders to limit the user gain control.
  • Page 150 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The telephony channel controls are shown in the following figure. Phone Connect The telephone interface may be taken off hook by pressing the phone button on the controls page. Once the telephone is off hook, digits may be dialed by pressing the keys on the keypad.
  • Page 151 Customizing SoundStructure Designs Ring Tone Ring tone enabled will cause the SoundStructure device to play ring tones into the local room when the telephone line rings. If Ring Tone is disabled no ring tone will be heard although a phone_ring status message will be generated by the SoundStructure device when the phone is ringing.
  • Page 152 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Line Voltage and Loop Current 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.
  • Page 153: Connecting Over Conference Link2

    Connecting Over Conference Link2 While there are two Conference Link2 interfaces on a SoundStructure device that permit two simultaneous connections to other Polycom devices, only one Polycom HDX video conferencing system may be connected to a SoundStruc- ture device. Physical Connections...
  • Page 154: Polycom Hdx Integration

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The rear-panel of the SoundStructure product with the Conference Link2 con- nections highlighted is shown in the following figure. PIN 2: TXD PIN 3: RXD PIN 5: GROUND PIN 7: CTS...
  • Page 155: Designing With The Polycom Hdx Video Codec

    CLink2 Designing With The Polycom HDX Video Codec Within SoundStructure Studio, the Polycom HDX video system may be selected from the video codec selection category and then clicking Add to add the codec to the list of inputs as shown in the following figure.
  • Page 156: Input Channels From The Polycom Hdx

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Input Channels From The Polycom HDX Once the Polycom HDX video system is selected, four SoundStructure input virtual channels are automatically added to the input channels as shown in the next figure.
  • Page 157 Connecting Over Conference Link2 The input channels from the Polycom HDX are described in the following table. HDX Signal to SoundStructure Description HDX Program Audio In A stereo virtual channel that contains a mix of all non-microphone inputs to the Polycom HDX.
  • Page 158: Processing On The Signals The Polycom Hdx Sends To Soundstructure

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Processing On The Signals The Polycom HDX Sends To SoundStructure Each of the signals that the Polycom HDX video system sends to the Sound- Structure device have processing that can be applied as shown in the following figure.
  • Page 159: Output Channels To The Polycom Hdx

    Output Channels To The Polycom HDX SoundStructure Studio creates several output virtual channels that are sent to the Polycom HDX system as shown in the following figure. The output channels sent to the Polycom HDX are described in the following table. Signal from SoundStructure...
  • Page 160: Signal Routing Inside The Polycom Hdx

    PSTN Mix Out Processing Equalization All the signals that are sent to the Polycom HDX system have signal level meters that are displayed on the Channels page. Signal Routing Inside The Polycom HDX The Polycom HDX system receives the SoundStructure output signals and internal to the HDX mixes the signals it needs to create the transmit signals to the HDX PSTN interface and HDX Video interface.
  • Page 161: Mute Control

    “Mics” 0 depending on whether the HDX system is being muted or unmuted. No audio paths are muted inside the Polycom HDX when an HDX, that is connected to a SoundStructure device over CLink2 interface, receives a mute command.
  • Page 162 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 No audio paths are muted internal to the Polycom HDX system when a mute command is sent to an HDX system that is connected to a SoundStructure device over the CLink2 interface. The muting must occur within the SoundStructure device.
  • Page 163: Volume Control

    SoundStructure system, the Polycom HDX does not receive the volume change event from the SoundStructure device. Only when volume change commands are sent to the Polycom HDX via a con- trol system or infrared remote will the volume event be automatically transmitted to the SoundStructure device.
  • Page 164: Designing With Hdx Digital Microphone Arrays

    HDX. This means that while the user adjusts volume on the Polycom HDX, it will appear as the volume continues to change on the Polycom HDX UI although a volume limit may have already been reached within the SoundStructure system which would prevent the system from get- ting any louder in the room.
  • Page 165: Digital Microphone Cabling Requirements

    SoundStructure model as described in the following figure. 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 SoundStructure C16 POLYCOM POLYCOM POLYCOM POLYCOM 6 - 13...
  • Page 166: Digital Microphone Firmware Updates

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 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 167 PIN 7: CTS PIN 8: RTS REMOTE CONTROL 1 RS-232 OBAM REMOTE CONTROL 2 SoundStructure C16 C-LINK2 Below is an excerpt from the SoundStructure log file: 8 23:16:40 soundstructure cmdd: sts: conference link configured 8 23:16:40 soundstructure cmdd: sts: [0] HDX...
  • Page 168: Detecting Clink2 Devices

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Because microphone arrays may be shipped with a firmware version that may be earlier than version 26, the firmware should be updated once to revision 26 by connecting the microphones directly to the right CLink2 port (the port clos- est to the OBAM interface) on SoundStructure device for 30 seconds.
  • Page 169: Digital Microphone Array Example

    As an example of using the digital microphone arrays, consider a design that uses two ceiling microphone arrays, one wireless analog microphone, a stereo program audio source, a Polycom HDX video conferencing system, a tele- phone line, and a stereo amplifier.
  • Page 170 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 In the third step, the equipment is selected. In this case a C12 is required and will have three additional analog inputs available that can be used once the system has been designed.
  • Page 171: Assigning Digital Microphone Array Channels To Physical Inputs

    Connecting Over Conference Link2 Assigning Digital Microphone Array Channels To Physical Inputs When HDX digital microphone arrays are used within SoundStructure Studio, SoundStructure Studio assigns the processing for each digital microphone input from a physical analog input. SoundStructure Studio will reserve processing by starting with the last analog input channel and working towards the first analog input.
  • Page 172 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 In this example, up to six analog inputs can be used (three analog inputs are presently in use) in addition to the two HDX ceiling microphones. 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 173: Digital Microphone Array Numbering

    PIN 2: TXD PIN 3: RXD PIN 5: GROUND PIN 7: CTS PIN 8: RTS REMOTE CONTROL 1 RS-232 REMOTE CONTROL 2 OBAM SoundStructure C16 C-LINK2 POLYCOM POLYCOM POLYCOM POLYCOM HDX Mic 1 HDX Mic 2 HDX Mic 3 HDX Mic 4...
  • Page 174 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The orientation of the microphone does not affect the sequential numbering as shown in the following figure. PIN 2: TXD PIN 3: RXD PIN 5: GROUND PIN 7: CTS...
  • Page 175: 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. These SKU’s include the...
  • Page 176 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 For reference, the Walta connector is the flat connector that is on the side of the tabletop microphone arrays and the RJ45 connector is compatible with the con- nectors on the rear of the SoundStructure device and on the digital ceiling microphone array.
  • Page 177 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) HDX Mic 1 HDX Mic 2 2215-23810-001/-002 2215-23810-001/-002 2457-24009-001 (25 ft) 2457-24009-001 (25 ft)
  • Page 178: Summary

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 A summary of the cables is shown in the following table. The pin outs for the RJ45 terminated cables 2457-24008-001 and 2457-24009-001 are shown in Chap- ter 14 - Specifications. Both of these cables have the same pin out and differ only in length.
  • Page 179 HDX video codec should be connected to the left CLink2 port as shown in the following figure. POLYCOM POLYCOM POLYCOM POLYCOM 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 SoundStructure C16 6 - 27...
  • Page 180 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 6 - 28...
  • Page 181: Linking Multiple Soundstructure Devices With Obam

    Linking Multiple SoundStructure Devices with OBAM This chapter describes how to • link up to eight SoundStructure devices together with OBAM, • create a configuration file for multiple SoundStructure devices, • upload and confirm that the SoundStructure system is functional, and •...
  • Page 182: Preparing Units For Linking With Obam

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Preparing Units for Linking with OBAM Updating SoundStructure Device Firmware Before linking multiple SoundStructure devices, the firmware in each Sound- Structure device must be updated to version 1.2 or higher. SoundStructure devices with firmware earlier than version 1.2 must be updated one device at...
  • Page 183 Linking Multiple SoundStructure Devices with OBAM A device’s bus ID is automatically assigned to SoundStructure devices based on how the systems are linked. The device that only has a connection on the OBAM Out connector will have a bus ID of 1 and will be referred to as the Master device.
  • Page 184 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 If two telephony cards are required, install the second telephony card in the second SoundStructure device as shown in the following figure. PHONE LINE PIN 2: TXD PIN 3: RXD...
  • Page 185 Linking Multiple SoundStructure Devices with OBAM Under normal operating conditions, the rear panel OBAM Out LED on one SoundStructure device and the OBAM In LED on another SoundStructure device will light solid green when a valid OBAM Out to OBAM In connection is made as shown in the following figure.
  • Page 186 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Combining C-series and SR12 devices C-series devices may be linked with SR12 devices for up to a total of eight SoundStructure devices. When a SoundStructure SR12 is used with C-series...
  • Page 187: Creating A Multi-Device Configuration File

    Linking Multiple SoundStructure Devices with OBAM Creating a Multi-Device Configuration File Once the SoundStructure devices are linked and ready to operate as a multi-device system, the next step is to create a configuration file that can be uploaded into the SoundStructure system. The configuration file for an OBAM-linked system contains information for all the linked SoundStructure devices.
  • Page 188 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 added to the system. To add equipment, select the equipment and click the ‘Add >’ button. When finished changing the equipment, press Next to con- tinue to step 2.
  • Page 189: Creating A New Project

    Linking Multiple SoundStructure Devices with OBAM Creating a New Project A new SoundStructure Studio project may be created for a multi-device system as easily as creating projects for a single SoundStructure device. The steps required to create a file and upload to a collection of SoundStructure devices are listed below.
  • Page 190 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 shown in the following figure where the local input/output numbering on the C12 ranges from 1-12 while the global numbering ranges from 17-28 because the C16, as the first device reserves the numbering 1-16.
  • Page 191: Uploading The Configuration

    Linking Multiple SoundStructure Devices with OBAM Uploading the Configuration To upload a configuration to the SoundStructure system, open the configura- tion file within SoundStructure Studio. Select the ‘Connect to Devices’ option and find the SoundStructure system to receive the configuration file as shown in the following figure.
  • Page 192 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 If the actual SoundStructure target devices do not match the devices in the con- figuration file, SoundStructure Studio will present 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

    Linking Multiple SoundStructure Devices with OBAM 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. To add more devices, follow the steps outlined earlier in this chapter in the Expanding an Existing project section.
  • Page 194: Soundstructure Logs

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 does have an IP connection. In the following example, the IP address of the system is 192.168.1.100 as that is the IP address of the master SoundStructure device. 770 350 4400...
  • Page 195: Connecting Polycom Hdx Microphones

    Linking Multiple SoundStructure Devices with OBAM Connecting Polycom HDX Microphones As described in Chapter 6, up to 4 HDX microphones may be connected to each SoundStructure device depending on the SoundStructure model. With OBAM linked devices, a total of 32 HDX microphones may be added to a system of 8 SoundStructure devices.
  • Page 196 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 with the first four microphones connected to the master SoundStructure device and the next four microphones connected to the slave SoundStructure device. PHONE LINE POLYCOM POLYCOM POLYCOM POLYCOM C-LINK2...
  • Page 197 Linking Multiple SoundStructure Devices with OBAM The Wiring page for this configuration is shown in the following figure with the first four HDX microphones on the SoundStructure C16 (bus id 1) and the remaining four HDX microphones on SoundStructure C12 (bus id 2).
  • Page 198: Multiple Polycom Hdx Video Conferencing Systems

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 in the SoundStructure device with that in the microphone and if the Sound- Structure device contains a newer version of microphone firmware, the HDX microphone will be updated with the new firmware. This process takes less than 10 seconds per microphone and while the microphone firmware is being updated, the LED’s inside the HDX microphone will turn orange.
  • Page 199 HDX 2 HDX 1 As described in Chapter 6, when a Polycom HDX video codec is muted, it will send a command to mute the virtual channel or group with the name "Mics". When using multiple HDX video codecs over Clink2, if any HDX codec is told to mute via a button press on a microphone, an IR key press, or a control system command to the HDX codec, then the channels defined by "Mics"...
  • Page 200 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 submixes to achieve the desired behavior when a particular HDX video codec is muted or has volume adjusted. If the virtual channel names “Mics” and “Amplifier” are not defined, then nothing will be muted and no volume will be adjusted on the SoundStructure when one of the HDX video codecs has its mute status changed or volume adjusted.
  • Page 201: Installing Soundstructure Devices

    Installing SoundStructure Devices This chapter describes how to take the SoundStructure designs created in Chapters 4 and 5 and upload and confirm that the system is fully functional. Once the SoundStructure design has been created, the next steps are to match the physical wiring of the system, upload the settings, make final adjustments to the system, and save the settings to a preset.
  • Page 202: Wiring The Devices

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 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.
  • Page 203 Installing SoundStructure Devices 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. If the system were wired incorrectly and the VSX8000 Out channel and Ampli- fier channel were reversed due to a physical wiring error, then the signals that were routed to the VSX8000 output channel would now be physically con- nected to the amplifier.
  • Page 204 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 There is a wiring report that can be created by clicking the Save Report button on the wiring page as shown in the following figure. The wiring report for this system is shown next.
  • Page 205: Uploading A Configuration File

    Installing SoundStructure Devices Uploading A Configuration File Configuration files are uploaded to a SoundStructure device or downloaded from a SoundStructure device by using the SoundStructure Studio software. To upload a configuration file to the SoundStructure devices, first open the SoundStructure Studio design file and then select the Connect menu and select Connect to Devices as shown in the following figure.
  • Page 206: Downloading A Configuration File

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 If the Serial control is checked, the system will also search for devices over the RS-232 interface as shown in the following figure. Any discovered devices will be displayed and the baud-rate and flow control settings required to connect to those devices will be displayed.
  • Page 207: Updating Firmware

    Installing SoundStructure Devices Updating Firmware Once connected to a SoundStructure device, the SoundStructure firmware may be updated using SoundStructure Studio. As the firmware files are nearly ten megabytes in size, it is recommended that SoundStructure Studio connect to the SoundStructure device over its Ethernet interface to minimize the firm- ware file transfer time.
  • Page 208 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Click on the “Open” button and navigate to the directory that contains the firmware file to upload as shown in the following figure. Select the file by double clicking on the desired file name. Once the file has been selected, the firmware update page will appear as in the following figure.
  • Page 209: Configuring The Signal Gains

    Installing SoundStructure Devices Once the firmware transfer begins, the progress will be updated with a display as shown in the following figure. Upon completion of a successful firmware transfer, the SoundStructure device will reboot and SoundStructure Studio will present the Connect to Devices window to allow SoundStructure Studio to re-connect to the device.
  • Page 210: Signal Meters

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The purpose of the analog input gain is to provide enough gain to get the input signal to the 0 dBu nominal signal level of the SoundStructure devices and have additional headroom for the signal to peak above that level.
  • Page 211 Installing SoundStructure Devices The following figure shows examples of peak signal levels that are too low, just right, and too high during normal conversational speech at the desired distance from the microphone. Good (Too Low) (Too High) If the meter levels are too low for a given microphone and for the desired dis- tance from the microphone, increase the input gain slider to add more gain to the signal in the analog domain.
  • Page 212: Room Gain

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Room Gain Room gain meters are used to measure the relative level of the remote audio that is present at the input to the AEC with the level of the echo that is present at the microphone.
  • Page 213 Installing SoundStructure Devices Negative room gain indicates that the AEC has a good level for the AEC refer- ence and there is not excessive acoustic echo. Positive room gain indicates that the relative levels of the AEC reference to the microphone input should be reviewed and if the level of the reference is too low, the input gains of the remote audio sources may need to be increased while at the same time the in-room amplifier level reduced so that the overall level remains the same.
  • Page 214: Telephony Signal Levels

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The room gain measurements and guidelines for the two reference applica- tions are similar to the single AEC reference example. If either reference shows a high room gain, review the gain settings for the AEC references and audio...
  • Page 215 Installing SoundStructure Devices 8 - 15...
  • Page 216: Output Signal Levels

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Output Signal Levels Output signals from the SoundStructure device are connected to various other devices including audio amplifiers, recorders, and video codecs. For best per- formance, the output signal levels of the SoundStructure devices should match the expected signal levels of the next device that is attached.
  • Page 217 Installing SoundStructure Devices Setting Amplifier Levels It is important to set the proper level of the audio amplifier in the room. This can be done with the following steps using the 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.
  • Page 218 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 2. Set the analog output gain on the amplifier output channel to be either +4, 0, or -10 depending on the nominal signal level required by the audio amplifier. Amplifiers with RCA inputs will require a -10dB setting, most system integration professional amplifiers will require the 0dB setting, and some amplifiers will require the +4dB setting.
  • Page 219 Installing SoundStructure Devices 5. Set the output fader from the SoundStructure device to 0 as shown in the next figure and unmute the signal generator to the loudspeaker output. Pink noise may be heard in the room depending on the amplifier volume settings.
  • Page 220: Presets

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 be performed by adjusting the level of the fader on the “Amplifier” channel within the SoundStructure device. Chapter 14 provides examples of using the “Amplifier” channel for volume control.
  • Page 221: Preset Operation

    Restore Preset Power-On Full Preset SoundStructure full presets operate in a similar fashion to Polycom’s Vortex products where there is a “power on” preset that must be selected for the design when the device powers up. When creating a new design, the last step of the SoundStructure design process will save the settings to a preset called “Power-On”...
  • Page 222: Saving Presets

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Preset Names When presets are stored, the preset name may be customized to any arbitrary string of up to 256 bytes in length. When naming presets, keep in mind the preset name is used in the command syntax to invoke the execution of the pre- set.
  • Page 223 Installing SoundStructure Devices The preset page shows the presets and also the preset contents to make it pos- sible to determine the settings that are in each preset. The column headings may be selected to sort the preset based on the values in the column. Changing sort order does not change the order of execution if the entries are in the preset.
  • Page 224: Creating Partial Presets

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Column Header Description Col Channel For parameters that affect matrix crosspoints, this is the name of the output virtual channel. Index 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.
  • Page 225 Installing SoundStructure Devices • Removing entries from a full preset • Creating new blank partial presets • Using the preset recording tool Creating a Partial Preset from a Full Preset Partial presets consist of a sequence of commands that will be executed in the order they appear in the partial preset.
  • Page 226 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Creating Partial Presets Manually New partial presets may be created by selecting ‘New Partial’ as shown in the following figure. The next step is to enter a name for the partial preset as shown in the following figure.
  • Page 227 Installing SoundStructure Devices Once the empty partial preset has been created, the next step is to add com- mands to the partial preset by clicking the ‘+’ control. This will add an empty line to the partial preset, and allow the designer to select the parameter to adjust with this line as shown in the following figure.
  • Page 228 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The recorder has the following features as shown below. Pause Stop Starting Recording Recording Preset Start Recording Redo last command Number of Last command Undo last commands recorded command...
  • Page 229: Running Presets

    Installing SoundStructure Devices Once entries have been moved, select “Save Selected” to save the new execu- tion order. Running Presets Both full and partial presets may be executed when in SoundStructure Studio by left clicking the preset to execute and then clicking Run Preset. A control system would execute the preset with the command action run as in the following example: run “Power-On”...
  • Page 230: Removing Presets

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 ran “Power-On” Partial Presets Partial presets will generate command acknowledgements for all parameters that are changed during the execution of the preset. The outputs of the system are not muted during a partial preset unless the designer explicitly inserts commands to mute the outputs of the system during the partial preset.
  • Page 231: Using Events, Logic, And Ir

    Using Events, Logic, And IR This chapter introduces the new concept of Events and how events may be cre- ated and used to control the behavior of SoundStructure systems including using the logic input and output capabilities. Events SoundStructure Studio and firmware version 1.3 introduces the concept of Events.
  • Page 232: Triggers

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Digital logic inputs held Digital logic inputs (digital_gpio_state) (digital_gpio_held) IR keypress (ir_key_press) Analog logic input values (digital_gpio_value) IR key held (ir_key_held) Triggers The trigger determines when the information in the source becomes action- able.
  • Page 233 Using Events, Logic, And IR • running a particular command, • running a preset, or • mapping the value of the source parameter to a destination parameter. Running a command allows the event to directly execute a single command to change a SoundStructure parameter via a valid API command.
  • Page 234: Creating Events With Soundstructure Studio

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 age values from the volume knob range from 0 to 255 and are directly mapped to the fader range of -100 to +20dB. Changes in the analog input voltage map...
  • Page 235: Enable And Disable Events

    Using Events, Logic, And IR To create an event, select the source, the trigger, and the type of action and select Add. Once the events are created, the events page will show the entire list of events as shown in the following figure. The events page may be sorted by any of the column headings including the Event Name, Source, Parameter, Trigger, and Action.
  • Page 236: Event Entries In The Logs

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 To permanently store the enable/disable state of an event, save the configura- tion file to disk using File Save or File Save As. When connected online to a SoundStructure system, the File Save or File Save as will force the settings in the device to be written to the flash memory of the device.
  • Page 237: Removing Events With Studio

    Using Events, Logic, And IR Removing Events With Studio Events may be removed by selecting one or more events and choosing the Remove Event button on the events page. SoundStructure Studio Automatically Creates Events When a new project is created, SoundStructure Studio will automatically create events depending on the input and output options selected.
  • Page 238 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The following figure shows that the “Mics” and “Amplifier” names from ear- lier firmware are required until any event is added. At that point, SoundStructure Studio will create all the necessary events to support the inte- gration with events.
  • Page 239 Using Events, Logic, And IR Polycom HDX Call Active Increments the local clink_local_call_active parameter on all SoundStructure devices in the design. When clink_local_call_active >= 1, the status LEDs on the HDX table microphones will illuminate green to indicate an active call is in progress...
  • Page 240 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Push To Talk Microphone Events When adding Push to talk microphones to a project, there are several logic input mode options for what should happen when the button is pressed.
  • Page 241 Using Events, Logic, And IR Table Mic Mute Event This event maps the mute state of the microphone to clink_mute. If the microphone is muted (mute=1), then the value of clink_mute will be set to 1 on SoundStruc- ture device 1. If the microphone is unmuted (mute=0) then the value of clink_mute will be set to 0 on Sound- Structure device 1.
  • Page 242: Hdx Ir Remote

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Activate on Unmute Table Mic LED Event This event maps the mute state of the microphone inversely to the digital_gpio_state of the LED. If the microphone is muted (mute=1) then the LED is turned off (digital_gpio_state=0.
  • Page 243 Near Back Back Home Home Back Home set phone_connect “Phone Out” 0 Directory Directory Directory set phone_connect “Phone Out” 1 Option Option Option set phone_dial “Phone Out” N PQRS WXYZ PQRS PQRS WXYZ WXYZ POLYCOM POLYCOM POLYCOM 9 - 13...
  • Page 244 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 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.
  • Page 245: Hdx Remote Channel Id

    Using Events, Logic, And IR HDX Remote Mute Toggles the state of clink_mute which is used to mute all microphones HDX Remote Preset Press Runs the preset “HDX Remote Preset” The automatically generated events may be customized to suit a particular application and additional events for the other key presses on the HDX IR remote may be added by using the Add Events feature.
  • Page 246: Logic Ports

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The wiring for the typical Xantech receiver is shown in the following figure. 480-00 Series Data +12V Logic Ports Each SoundStructure device has two DB25 connectors where each DB25 con- nector has •...
  • Page 247: Digital Logic Inputs

    Using Events, Logic, And IR The pin out of the rear-panel DB25 connectors is shown in the figure. SoundStructure Logic Signal Signal REMOTE CONTROL 1 Logic input 1 Logic output 1 Logic input 2 Logic output 2 Logic input 3 Logic output 3 Logic input 4 Pin 13...
  • Page 248: Analog Logic Inputs

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The logic inputs will have a default value of 1 (high) when the contact closure is open, and will have a value of 0 (low) when the contact closure is closed and tied to ground.
  • Page 249: Logic Outputs

    Using Events, Logic, And IR knob is turned, the voltage measured will vary between 0 and approximately 5V. The values measured from the analog logic gain input will vary from approximately 0 to 255. Pin 13 : Analog Input Pin 1 : +5V 10K ohm Pin 25 : Ground Remote Control...
  • Page 250: Logic Arrays

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 As shown in the following figure, when the logic output pin is set to 1 the output pin allows current to flow from the logic output pin to the chassis ground, thus completing a signal circuit path.
  • Page 251 Using Events, Logic, And IR The value of a logic input array is read with the digital_gpio_value parameter. If a logic pin is part of an array, it may not also be used as an individual logic input pin. 1 = Switch Open (wall open) 0 = Switch Closed (wall closed) Room 1 Room 2...
  • Page 252: Event Examples

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 When the logic output is set to 1, current will flow and the LED will turn on. When the logic output is set to 0, current will not flow and the LED will turn off.
  • Page 253 Using Events, Logic, And IR 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 exam- ple the pin is called “Combine Switch”.
  • Page 254 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Step 2: Create events for both the split and combined mode The next step is to determine how the logic switch operates – when the switch circuit is closed are the rooms split or combined? This information will deter- mine which preset is called when the switch is open and when the switch is closed.
  • Page 255: Push To Talk Microphones With Leds

    Using Events, Logic, And IR split preset should be called when the switch is open and the combined preset when the switch is closed, then the triggers or the actions may be easily reversed on the events. To edit an event, double click the event. Push To Talk Microphones With LEDs In this example, the push to talk button on a microphone will be used to mute all microphones in room and the status LED on the microphone will be illumi-...
  • Page 256 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Step 1: Add a logic input and output pin for each microphone. Use names for the logic pins that will make sense to you as you build your sys- tem.
  • Page 257 Using Events, Logic, And IR In this event, every time the PTT button is closed, the clink_mute parameter will be toggled. To mute the microphones based on clink_mute, another event is required that will map clink_mute to the mute of the “Mics” group. The Clink_mute to Mics Mute event take the clink_mute state of device 1 and maps that value to the mute state of the Mics group.
  • Page 258: Push And Hold To Temporarily Mute A Microphone

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Step 3: Create LED event based on the Mute state The final event required will map the mute state of the microphone to the LED state. In this example, it is desired to light the LED (logic output = 1) when the microphone is unmuted (mute = 0).
  • Page 259 Using Events, Logic, And IR This example assumes that the microphone is already part of the system and now the logic inputs and outputs will be manually added to the existing sys- tem. 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 associated events when the microphone input is defined.
  • Page 260: Phone Off Hook Drives A Relay

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Step 2: Create the event to map the button press to the mute state of the microphone Since the microphone should be muted (mute = 1) when the button is pressed (logic input = 0), the event should use an action map with the invert option as shown in the following figure.
  • Page 261 Using Events, Logic, And IR 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. Step 2: Create the Event In this example, the phone connect parameter is mapped to the logic output. If the phone is off hook (phone_connect = 1) then the logic output will allow current to flow and the relay will energize.
  • Page 262: Volume Knob Adjusts "Amplifier" Fader

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Volume Knob Adjusts “Amplifier” Fader In this example, a volume knob will be used to control volume of an output named “Amplifier”. Step 1: Add the analog logic input In this example a single Analog Logic Input was created and named this logic input Volume Knob.
  • Page 263: Gating Information Sent To A Control System

    Using Events, Logic, And IR If there are user min and max fader limits set on the “Amplifier” channel, then those limits will be used automatically with the map event. Gating Information Sent To A Control System In this example, a logic output will be used to indicate that a particular micro- phone has gated on.
  • Page 264: Camera Positioning With An Hdx

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Step 2: Create the event Once the logic pin has been defined, an event mapping the microphone gating status to the logic output can be created. In this example, when the Table Mic gates on the automixer, the logic output will be set to 1 and when the microphone gates off, the logic output will be set to 0.
  • Page 265: Events Best Practices

    Using Events, Logic, And IR This example shows that the ser_send command is used to send the serial com- mand from the serial port on the SoundStructure with device ID 1. The command being sent is preset near go 1. The “\r” at the end of the command name represents a carriage return.
  • Page 266 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 4. Test logic inputs and events when working offline with SoundStructure Studio. Logic input pins may be forced to closed or open with set digital_gpio_state “logic pin” 0 command to close a switch or set digital_gpio_state “logic pin”...
  • Page 267: Network Management

    Network Management This chapter describes the network and control aspects of SoundStructure sys- tems including managing the device over IP and configuring the RS-232 port. Connecting To The Device SoundStructure devices have a LAN interface and RS-232 port that may be used to configure, control, and update the system software.
  • Page 268: Dynamic Ip Addresses

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Dynamic IP Addresses By default, the SoundStructure device accepts an IP address from a DHCP server. Once assigned, IP addresses can be determined with the SoundStruc- ture Studio software via the SoundStructure device discovery method. To determine the IP address, connect to the device using the Search for Devices option as shown in the following figure.
  • Page 269: Link-Local Ip Addresses

    Network Management By default the system name is set to “SoundStructure System” as shown in the next figure. The system name is used to easily identify units and can be set with the Sound- Structure Studio as shown in the previous figure by entering the name and pressing the Apply button or by using the sys_name API command as shown below.
  • Page 270: Static Ip Addresses

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Assuming the computer that is running SoundStructure Studio also does not have an IP address provided by a DHCP server, the local computer will also have a link-local address of the form 169.254.abc.def. The computer may be...
  • Page 271 Network Management Assigning A Static IP Address Via Ethernet Over the network interface, first connect the device to the network and accept the dynamic IP address from a DHCP server. Once connected to the device, the static IP address may be set directly from the wiring page within SoundStruc- ture Studio.
  • Page 272 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Field Definition Values Gateway The IP address of the gateway Netmask The netmask defining the subnet Name Server The IP address of the name server used to resolve host names. Multiple DNS...
  • Page 273: Setting The Time Server

    Network Management Setting The Time Server To set the time server, use the command ntp_server as shown in the example below: set dev_ntp_server 1 “pool.ntp.org” val dev_ntp_server 1 “pool.ntp.org” where 1 is the device ID of the SoundStructure. See Appendix A for more information on API commands associated with the Ethernet interface.
  • Page 274: Soundstructure Device Discovery

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The command responses are received back and include the mute status for all virtual channels in the “Mics” virtual channel group. When there are multiple simultaneous control sessions to a SoundStructure system, the control session that sends commands will also receive command acknowledgements for all of its commands.
  • Page 275: Amx Beacon

    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. RS-232 The RS-232 interface is capable of running up to 115,200 bps and has a default rate of 9,600 bps, eight data bits, no parity, one stop bit (8-N-1).
  • Page 276: Configuring And Accessing The Logs

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 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.
  • Page 277: Polycom Touch Control And Soundstructure Systems

    Integrating The Polycom Touch Control with SoundStructure Systems This chapter describes how to integrate the Polycom Touch Control with a SoundStructure system. For information about using the Polycom Touch Con- trol with an HDX system, see the latest version of the Administrator’s Guide for Polycom HDX Systems.
  • Page 278: Polycom Touch Control With Hdx Systems Vs. Soundstructure Systems

    Polycom Touch Control with the SoundStructure system. Polycom Touch Control with HDX Systems vs. 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: •...
  • Page 279: Pairing The Polycom Touch Control With Soundstructure

    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 280 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 3. Plug the Ethernet cable into the wall Ethernet outlet. — If the room provides Power Over Ethernet, connect the Ethernet cable directly to a LAN outlet as shown in the following figure.
  • Page 281 Integrating The Polycom Touch Control with SoundStructure Systems 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. 2. Enter the IP address of the desired SoundStructure system as shown in the following figures.
  • Page 282 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 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.
  • Page 283 If the network connection is lost for any reason, the Polycom Touch Control device automatically attempts to restore the connection. 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 284: Polycom Touch Control Administrative Settings

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 connection between the Polycom Touch Control and that the SoundStructure is powered on. Polycom Touch Control Administrative Settings The Polycom Touch Control device has separate admin settings that allow for updating the Polycom Touch Control software and configuring LAN, regional, and security properties for the Polycom Touch Control.
  • Page 285: Configuring The Polycom Touch Control Lan Properties

    Integrating The Polycom Touch Control with SoundStructure Systems Configuring the Polycom Touch Control LAN Properties To configure Polycom Touch Control LAN settings: 1. From the Home screen, touch Administration. 2. Touch the LAN Properties tab. 3. Configure the following IP Address (IPv4) settings:...
  • Page 286: Configuring Polycom Touch Control Regional Settings

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 4. Configure the following DNS settings: Setting Description Domain Name Displays the domain name currently assigned to the Polycom Touch Control. If the Polycom Touch Control does not automatically obtain a domain name, enter one here.
  • Page 287: Configuring Security Options

    Polycom Touch Control Admin Settings. The password must not contain spaces. The default password is “456”. Setting up Polycom Touch Control log management It is possible to transfer the Polycom Touch Control logs to an external USB storage device. 11 - 11...
  • Page 288: Updating Polycom Touch Control Software

    Updating Polycom Touch Control Software Software updates may be received for the Polycom Touch Control device from the online software server hosted by Polycom or from a USB storage device that you connect to the side of the Polycom Touch Control device.
  • Page 289: Using The Polycom Touch Control With Soundstructure

    Select Yes to All. 5. Connect the USB device to the side of the Polycom Touch Control device. 6. From the Home screen, touch Administration and then Updates.
  • Page 290 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 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 addi- tional three supported Polycom Touch Controls are planned for future use.
  • Page 291 By default, SoundStructure Studio will automatically set 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 292 _SST to Polycom HDX Volume The ‘_SST To Polycom HDX Volume’ event is the companion to the ‘_Polycom HDX to SST Volume’ event and maps the fader parameter of the "Amplifier" channel to the volume level on the Polycom Touch Control. Adjusting the volume of the fader of the "Amplifier"...
  • Page 293: Using Multiple Soundstructure Telephony Interfaces

    Muting any of the individual microphones will set clink_mute to 1 which will then mute all microphones due to the _Clink to Mics Mute event which then causes the Polycom Touch Control to show that the system is muted.
  • Page 294: Using Multiple Polycom Touch Controls With Soundstructure

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Using Multiple Polycom Touch Controls with SoundStructure Once a Polycom Touch Control has been designed in the system and the events created, multiple Polycom Touch Controls may be paired with the Sound- Structure system and used to control the SoundStructure system.
  • Page 295 Polycom Touch Control and the SoundStructure system. Touching the i button will show that the Polycom Touch Control is paired with a system but the connection has been lost as shown in the following figure.
  • Page 296 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 3. If the system is properly paired and the Polycom Touch Control and the SoundStructure system are communicating then the display will appear as shown in the following figure.
  • Page 297 SoundStructure Studio as shown in the following figure. To see SoundStructure command acknowledgements, press the mute button on the Polycom Touch Control. When the system is muted, the console shows text such as: val mute "Table Mic 1 A" 1 val mute "Table Mic 1 B"...
  • Page 298 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 11 - 22...
  • Page 299: The Soundstructure Voip Interface

    The SoundStructure VoIP Interface uses the industry-leading Polycom UC Software that is the foundation of the SoundPoint IP and Sound- Station IP phones. The SoundStructure system can be controlled by a third-party remote control system.
  • Page 300: How To Read This Chapter

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Interface offhook, dial digits, put calls on hold, resume calls, and more. A typ- ical call and control scenario with the user interacting with the touch screen is shown next.
  • Page 301: Soundstructure Voip Interface Overview

    Want to see the new API commands and SoundStructure VoIP Interface API examples Commands Want to learn more about administration Polycom UC Software Administrators of VoIP systems 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 302: Soundstructure System Requirements

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 • Compatible with many SIP call management platforms. • Supports API command set for dialing, onhook, offhook, call hold, call resume, call transfer, call blind transfer, call forward, call hangup, call conference, call split, call join, and do not disturb.
  • Page 303: Upgrading A Project To The Soundstructure Voip Interface

    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 304 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 To get the configuration file, select the Connect menu option in SoundStruc- ture Studio and select the Search for Devices option to find the desired system from the list of discovered systems. If your system is not discovered, enter the IP address of the system or choose a system from the address book.
  • Page 305 The SoundStructure VoIP Interface To change the telephony interfaces in an offline project, select Upgrade Plug-in card from the Tools menu as shown next: or click the Upgrade Plug-in card button from the Wiring page as shown next. Next, the steps required to change your plug-in cards are presented. 1.
  • Page 306 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 card entry for each device. In this example, select the desired card to convert to a different card and click Next. In this example, the TEL1 plug-in card will be changed to a VoIP plug-in card.
  • Page 307 The SoundStructure VoIP Interface 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 Cards Tool window indicates it is necessary to remove one telephony channel from the system based on the number of telephony channels available.
  • Page 308 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 update the number of Unused Channels, and, if no further channels are needed, you may click Next to continue. 3. Decide to continue to work offline or send the project to an online SoundStructure system.
  • Page 309: Creating A New Project With The Soundstructure Voip Interface

    The SoundStructure VoIP Interface Creating a New Project with the SoundStructure VoIP interface While the previous section focuses on converting an existing project, this sec- tion focuses on creating a new project with the SoundStructure VoIP Interface. To create a new project, follow these steps. 1.
  • Page 310 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 3. 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.
  • Page 311 The SoundStructure VoIP Interface 4. In Create a Project - Step 3, select the SoundStructure equipment required to implement this project. By default SoundStructure Studio will select the lowest cost equipment that will meet the design requirements. In this example, the equipment required is a SoundStructure C12 and a SoundStructure VoIP Interface as shown in the following figure.
  • Page 312 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 5. 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 313 The SoundStructure VoIP Interface The resulting project is shown in SoundStructure Studio. Select the Matrix tab to view the matrix as shown next. By default the audio from the VoIP In and Program Audio channels are routed to the Amplifier while the Program Audio and the echo cancelled microphone audio are routed to the VoIP Out channel.
  • Page 314: Upgrading The Firmware In The Soundstructure System

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The wiring page of the new project will show the SoundStructure VoIP Inter- face installed as shown in the following figure. At this point, you have created an offline project that includes the SoundStruc- ture VoIP Interface.
  • Page 315 The SoundStructure VoIP Interface To upgrade the firmware in the SoundStructure system, use the following steps. 1. Select the Connect menu option in SoundStructure Studio and select the Search for Devices option and select the desired system from the list of discovered systems.
  • Page 316 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 3. Once connected to the SoundStructure system, left click on the project name to get to the main system options page and select the Open button on the Firmware update control.
  • Page 317: Installing The New Plugin Cards

    The SoundStructure VoIP Interface 6. Once the firmware has been updated, the SoundStructure system will automatically reboot and SoundStructure Studio will display the Connect to Devices dialog. Close the Connect to Devices dialog and wait for the SoundStructure system to reboot. The SoundStructure front panel light will blink green while the system is booting and will turn solid green when the system has finished rebooting.
  • Page 318: Uploading The Configuration File

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Connect Network to the SoundStructure VoIP Interface Connect the network interface of the SoundStructure VoIP Interface to the appropriate VoIP network as shown in the following figure. 0004F2BF001D OBAM...
  • Page 319: Configuring The Soundstructure Voip Interface

    The SoundStructure VoIP Interface After sending the configuration file to the SoundStructure system, the result- ing system will have t will have a solid green front panel LED to indicate that the configuration file that is loaded matches the hardware and SoundStructure Studio project status will be solid green as shown next.
  • Page 320 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Understanding the Default Network Settings The factory default values for the network settings of the SoundStructure VoIP Interface are: • DHCP enabled which causes the interface to get an IP address from a DHCP server.
  • Page 321 The SoundStructure VoIP Interface To find the IP address of the SoundStructure VoIP Interface, connect to the online SoundStructure device with SoundStructure Studio and navigate to the Wiring page. The IP address of the SoundStructure VoIP Interface is found in the lower right-hand portion of the display as shown in the following figure.
  • Page 322 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Web Configuration Utility login Either click the Web Configuration button to open the default browser on the PC or enter the IP address of the SoundStructure VoIP Interface into your browser to start the Web Configuration Utility.
  • Page 323 The SoundStructure VoIP Interface Setting the Ethernet Address To customize the Ethernet settings of SoundStructure VoIP Interface, navigate to the Ethernet selection from the Settings > Network menu as shown next. 12 - 25...
  • Page 324 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 This will bring you to the Ethernet settings page 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.
  • Page 325 Choose the speed of the network on the Ethernet 10FD, 100HD, 100FD, interface. 1000FD See the Polycom UC Software Administrators Guide 4.0.1 for additional infor- mation about the advanced settings of Ethernet 802.1x and PAC File Info. The VLAN settings are described in the following table. Name...
  • Page 326: Setting The Provisioning Server Settings

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Name Possible Values Description CDP Compatibility Enable (Default) or If enabled, the phone will use CDP-compatible signaling Disable. to communicate with the network switch for certain network parameters. Most often this will be used to set...
  • Page 327 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 328 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 If you don’t have a valid network route to the Web Configuration Utility, use SoundStructure Studio to set the IP address of the SoundStructure VoIP Inter- face as described in Setting an IP address with SoundStructure Studio.
  • Page 329 The SoundStructure VoIP Interface Setting the Provisioning Server Information To configure the provisioning server information, navigate to the Provisioning selection from the Settings menu as shown next. Enter the provisioning server information settings as shown next. These set- tings are a superset of the settings that can be configured directly with SoundStructure Studio on the Wiring page.
  • Page 330 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Setting the provisioning server settings manually requires setting the DHCP server type to Static, otherwise the DHCP server provided provisioning server settings will be used. The fields are described in the following table.
  • Page 331 The SoundStructure VoIP Interface The DHCP boot server settings are only accessible when the DHCP client is enabled. The Boot server parameters are described in the following table. Name Possible Values Description Boot server Static (default) The SoundStructure VoIP Interface will use the boot server/provisioning server configured manually through the Server options.
  • Page 332 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Name Possible Values Description Boot server Option 66 The SoundStructure VoIP Interface will look for Option number 66 (string type) in the response received from the DHCP server. The DHCP server should send address information in Option 66 that matches one of the formats described for Server Address.
  • Page 333: 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 for- matted data will be sent whenever option 60 is sent.
  • Page 334 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 You can locate the MAC address on the rear of the SoundStructure VoIP Inter- face as shown next. In this example, the MAC address is 0004F2BF001D. 0004F2BF001D If the SoundStructure VoIP Interface is already installed in an equipment rack...
  • Page 335 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 336 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Name Possible Values Description Type Private or Shared Choose Private or Shared line identification. If set to Private, standard call signaling is used. If set to Shared, call state subscriptions and notifications are shared with multiple phones.
  • Page 337 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.
  • Page 338: Using The Soundstructure Voip Interface With Soundstructure Studio

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 An example configuration to register a line as extension 1029 to a call server at 172.22.2.203 will look like the figure shown next. Your settings will depend on the particular values required for your installation.
  • Page 339: Using The Phone Settings Control

    The SoundStructure VoIP Interface Using the Phone Settings Control You can use the phone settings control on the Channels Page in SoundStruc- ture Studio to dial new calls, transfer calls, put calls on hold, join calls and split calls. 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 fol- lowing figure.
  • Page 340 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Control Description Line Keys Shows all lines that have been defined with call servers. Up to 12 lines can be shown here. Lines 1-6 are shown on the left side of the...
  • Page 341: Customizing Soundstructure Telephony Settings

    The SoundStructure VoIP Interface Customizing SoundStructure Telephony Settings You can use the telephony settings to customize the behavior of the Sound- Structure VoIP Interface with the following options. Name Possible Values Description Auto Answer Enable or Enables or disables answering the phone Disable (default) automatically after the second ring.
  • Page 342: Soundstructure Voip Interface Settings On The Wiring Page

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 SoundStructure VoIP Interface Settings on the Wiring Page The wiring page has several options for configuring the SoundStructure VoIP Interface that are active only when connected online with a SoundStructure system that has a SoundStructure VoIP Interface.
  • Page 343 The SoundStructure VoIP Interface 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.
  • Page 344 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 These areas display as shown in the following figure. VoIP Network Settings Select either Automatic Configuration (DHCP) or Manual Configuration for configuring the IP address of the SoundStructure VoIP Interface as described in the following table.
  • Page 345 The SoundStructure VoIP Interface If you select the Manual configuration option, you must enter the information for the following fields to properly configure the IP address of the SoundStruc- ture VoIP Interface. Name Possible Values Description IP Address Dotted-decimal IP address Enter the IP address to be used for the SoundStructure VoIP Interface.
  • Page 346 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 server address, username, and password information as shown in the follow- ing table. Name Possible Values Description Type FTP, TFTP, HTTP, The protocol that the SoundStructure VoIP Interface will use...
  • Page 347 The SoundStructure VoIP Interface Using the SoundStructure Studio Console You can use the SoundStructure Studio console to better understand the API commands that are used to control the SoundStructure system for dialing, transferring, putting calls on hold, and more. You can open the SoundStruc- ture Studio console window to see the SoundStructure API commands that are sent to the SoundStructure device while configuring the system, and follow the acknowledgements that are returned.
  • Page 348: Updating Software On The Soundstructure Voip Interface

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 acknowledgment. Depending on your system configuration and programmed events, you may other command acknowledgments as a consequence of taking the phone offhook. You can enter commands by typing text in the white area and pressing Enter or the Send button as shown in the following figure.
  • Page 349: Upgrading Software With A Local Ftp Server

    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...
  • Page 350: Upgrading Software With An Existing Provisioning Server

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 8. Select Add and pick the directory. 9. To allow the phone to upload logs onto the provisioning server, select the Shared Folders > Files >Select Write and Delete checkboxes, and then select Shared Folders >...
  • Page 351 The SoundStructure VoIP Interface 1. In the SoundStructure VoIP Interface Network settings on the Wiring Page, set the DHCP boot server to Static and set the Provisioning Server Settings to use an FTP Server and enter the appropriate server address, username, and password.
  • Page 352 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 <APPLICATION APP_FILE_PATH="sip.ld" CONFIG_FILES="" MISC_FILES="" LOG_FILE_DIRECTORY="" OVERRIDES_DIRECTORY="" CONTACTS_DIRECTORY="" LICENSE_DIRECTORY="" USER_PROFILES_DIRECTORY="" CALL_LISTS_DIRECTORY=""> To select a particular version of software to load to a particular SoundStructure VoIP Interface, create a configuration file with a name <MAC Address>.cfg where <MAC Address>...
  • Page 353: Upgrading Software With The Web Configuration Utility

    A free and popular Web server, Apache Server, is available for 32-bit Windows 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 354 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 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.
  • Page 355 The SoundStructure VoIP Interface </PHONE_IMAGES> where the names UCS_4.0.1_rts30, UCS_4.0.1_rts43, and UCS_4.0.1_rts46 are directory names that store their respective versions of the 3111-33215-001.sip.ld software files. These directories must match the path specified in the XML file and the directories should be located in the main directory that was configured for the web server.
  • Page 356 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 If the web server cannot be found then the system will present an error message of the form shown in the following figure. If you see this message, check that the SoundStructure VoIP Interface and the HTTP or FTP server have a valid network route and that your Windows Firewall is disabled if you are using your local PC’s FTP server or HTTP server.
  • Page 357 The SoundStructure VoIP Interface 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. 9.
  • Page 358: Validating A Soundstructure Voip Interface Installation

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Click Continue when prompted. Finally, you will see a message confirming the server has been cleared. Validating a SoundStructure VoIP Interface Installation Once you have completed your SoundStructure configuration file, have...
  • Page 359 The SoundStructure VoIP Interface Older versions of SoundStructure Studio are not aware of the latest parameters definitions required by the SoundStructure VoIP Interface and will not connect properly to a SoundStructure System that has a SoundStructure VoIP Interface installed. Older versions of SoundStructure Studio may exit prematurely with an error message about undefined parameters when trying to access online systems that use the SoundStructure VoIP Interface.
  • Page 360 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 in the following figure. The SoundStructure VoIP Interface requires approxi- mately 1 to 2 minutes to boot. When you perform a software update, the boot time will increase. If you don’t have a VoIP interface listed on your wiring page, even though you have a SoundStructure VoIP Interface plugged in, ensure that your project includes a SoundStructure VoIP Interface as described in the previous section.
  • Page 361 The SoundStructure VoIP Interface Once you’ve confirmed a SoundStructure VoIP Interface is part of the config- ured devices installed, check the Edit Channels control to ensure you have a SoundStructure VoIP Interface designed into your project. While the channel names may be different in your project, in the following figure, the virtual channels “VoIP In”...
  • Page 362 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Valid IP Address Check that you have a valid IP address for the SoundStructure VoIP Interface on the Wiring page as shown in the following figure. If you don’t have a valid IP address, check whether the network cable for the SoundStructure VoIP Interface is plugged in and connected to the VoIP network.
  • Page 363 The SoundStructure VoIP Interface Confirming Line Registration Navigate to the Channels page and open the Phone Settings dialog by clicking on the dialer control on the Channels page as shown on the left side of the fol- lowing figure. On the phone settings page you should see a registered line icon if the line is properly registered (see right side of the figure).
  • Page 364 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 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 Util- ity is set correctly.
  • Page 365 The SoundStructure VoIP Interface 2. Click in the Dialed digits area as shown below and enter the URL to dial using your PC keyboard. For the ‘dot’ in between the IP address octets, use the ‘.’ on your keyboard. Dialed digits The remote endpoint can be a desktop phone or the IP address of a different SoundStructure VoIP Interface being installed.
  • Page 366: Voip Interface Logs

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 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.
  • Page 367 The SoundStructure VoIP Interface Boot Logs Boot logs show information regarding the boot process of the SoundStructure VoIP Interface including any firmware updates. The boot log shown next depicts a system after it has booted up. App Logs Application logs show information regarding the application running on the SoundStructure VoIP Interface.
  • Page 368: Backing Up And Restoring The Voip Specific Settings

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Backing up and Restoring the VoIP Specific Settings The VoIP settings on the SoundStructure VoIP Interface may be backed up or restored by using Web Configuration Utility Phone Backup & Restore option.
  • Page 369 The SoundStructure VoIP Interface Clicking Save will store the settings in a text file that can be viewed with any text editor. Restore Settings The settings for the SoundStructure VoIP Interface may be restored by clicking the Choose File button as shown in the following figure. Clicking Choose File will prompt you to select the filename to restore as shown in the following figure.
  • Page 370: Importing And Exporting Voip Parameter Settings

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 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.
  • Page 371: Soundstructure Log Information

    The SoundStructure VoIP Interface You can export different settings from the SoundStructure VoIP Interface as shown next. Export Configuration File Description All Configuration Settings (except Exports the configuration from all sources Device Settings) except for the device specific settings including line registration information, codec preferences, and other information that has been configured differently from the default values.
  • Page 372 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Jul 28 05:25:37 lcp: sts: waiting for VoIP plug-in card to boot Jul 28 05:25:38 gcp: sts: parsed 273 parameter definitions from /usr/share/serendipity/params.xml Jul 28 05:25:38 gcp: sts: parsed 24 meter definitions from /usr/share/serendipity/meters.xml...
  • Page 373: 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 regard- ing 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 374: Soundstructure Voip Interface Api Commands

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 questions. For PBX specific integration questions about line registration problems to your local PBX, consult your local IT/Phone specialist who has deployed other VoIP endpoints in that environment. SoundStructure VoIP Interface API Commands The existing SoundStructure API commands have been updated to support the SoundStructure VoIP Interface input and output channels.
  • Page 375 The SoundStructure VoIP Interface voip_dhcp_boot_serv_type When voip_dhcp_boot_serv is set to custom, this parameter specifies the type of the DHCP option in which the plug-in card will look for the boot server. voip_dhcp_option_60_type Specifies the format for the vendor identifying information used with a DHCP server when DHCP option 60 is enabled.
  • Page 376: Using The Soundstructure Api

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 voip_reboot Reboots the SoundStructure VoIP Interface. voip_resume Resumes a call that was on hold. voip_send Causes a call to be placed with the digits dialed. voip_split Splits all calls in a conference into individual calls.
  • Page 377: Hanging Up A Call

    The SoundStructure VoIP Interface # Alternatively, you can now dial the digits first and as # long as you take the phone off hook within 20 seconds of dialing, # the digits will be retained and dialed. set phone_dial "VoIP Out" "2029" val phone_dial “VoIP Out”...
  • Page 378: Forwarding An Incoming Call

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 # 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”...
  • Page 379: Transferring A Call

    The SoundStructure VoIP Interface val voip_line_state "VoIP Out" 1 reg # the local phone stops ringing as the call is forwarded. val phone_ring "VoIP In" 0 Transferring a 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).
  • Page 380: Blind Transfer Of A Call

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Blind Transfer of a Call This example shows how you can dial a call and connect to the remote party (extension 2029 in this example) and then ‘blind transfer’ that call to a different extension (5148 in this example).
  • Page 381: Dialing Two Calls On The Same Line

    The SoundStructure VoIP Interface Dialing Two Calls on the Same Line This example shows how you can dial and bridge together two calls on the same line. # Take the phone offhook set phone_connect “VoIP Out” 1 # Dial the digits of the first call set phone_dial “VoIP Out”...
  • Page 382: Dialing Two Calls On Different Lines

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Dialing Two Calls on Different Lines This example shows how to use two independent lines and to conference together the two lines to form a three-way conference call. This example assumes I have Line 1 and Line 2 registered with call management servers.
  • Page 383: Soundstructure Api Behavior Changes

    The SoundStructure VoIP Interface SoundStructure API Behavior Changes This section reviews changes made to the SoundStructure API as a result of supporting the SoundStructure VoIP Interface. The behavior of the following commands have changed: phone_dial In version 1.5.0 of the SoundStructure firmware, the behavior of the phone_dial command has changed to store the dialed digits when the phone is onhook and to dial those digits once the phone is taken offhook if the phone is taken offhook within 20 seconds of dialing the digits.
  • Page 384: Quick Upgrade Guide

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 ran “My Preset” sys_factory_reset The command sys_factory_reset has been updated to also reset to factory defaults any SoundStructure VoIP Interfaces that may be installed in the SoundStructure system. set sys_factory_reset...
  • Page 385 The SoundStructure VoIP Interface 12 - 87...
  • Page 386 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 12 - 88...
  • Page 387 The SoundStructure VoIP Interface 12 - 89...
  • Page 388 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 12 - 90...
  • Page 389 The SoundStructure VoIP Interface 12 - 91...
  • Page 390 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 12 - 92...
  • Page 391 The SoundStructure VoIP Interface 12 - 93...
  • Page 392 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 12 - 94...
  • Page 393: Advanced Applications

    1 Microphone And Mono Video Conferencing 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 will be 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 394: Soundstructure Studio Steps

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Before proceeding with the design, install SoundStructure Studio software from the CD-ROM supplied with your SoundStructure device or download the latest version from the Polycom website. Launch the SoundStructure Studio software and select New Project from the File menu.
  • Page 395 Advanced Applications 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. Step 3 - Select Equipment Select the equipment required to create this design. By default a SoundStruc- ture C8 is selected.
  • Page 396: Channels Page

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Step 4 - Work Offline Or Online In this step offline operation is selected to create a file for later upload into a SoundStructure C8. Channels Page Once the design has been created, the user is presented with the Channels page where the following virtual channels and virtual channel groups have been defined.
  • Page 397 Advanced Applications nel is set to 0dB, in other words, no gain is applied. It is also assumed that the 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.
  • Page 398: Matrix Settings

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Matrix Settings The matrix page shows how the input signals are mapped to the output sig- nals. In this example, the tabletop microphone is sent to the VSX8000 and the VSX8000 is sent to the local amplifier.
  • Page 399: Controlling The System

    Advanced Applications output 2. If this wiring scheme does not match how the system has been wired, the channels may be moved around on the wiring page to their desired locations. Controlling The System A control system will typically be used to mute the microphone and adjust the volume settings in the local room.
  • Page 400 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Volume Control Volume control in the room can be accomplished by adjusting the fader con- trol on the “Amplifier” virtual channel as follows: inc fader “Amplifier” 1 will increase the gain on the “Amplifier” channel by 1dB and dec fader “Amplifier”...
  • Page 401: Digital Array Microphones And A Soundstation Vtx1000

    The room layout may look similar to the reflected ceiling plan shown in the fol- lowing figure with in-ceiling loudspeakers, a SoundStation VTX1000 on the front of the room, and the digital microphone arrays distributed on the table. POLYCOM POLYCOM POLYCOM...
  • Page 402: Soundstructure Studio Steps

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The block diagram of this system is shown in the following figure. Program Audio VTX1000 Out VTX1000 In Amplifier SoundStructure CLink2 (L) CLink2 (R) HDX Microphones The From VTX1000 and To VTX10000 signals are wired to the VTX1000 power module as shown in the following figure.
  • Page 403 Advanced Applications Step 1 - Select Inputs Select four HDX digital tabletop microphones and a mono program audio source. If the VTX1000 isn’t listed, select the VSX7000 video conferencing system and adjust the labels as shown in the following figure. Step 2 - Select Outputs Select a mono amplifier as the output source.
  • Page 404 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Step 3 - Select Devices Select the equipment required to create this design. By default the SoundStruc- ture C16 is selected. Note that no telephony card is required as the VTX1000 will be the telephony interface.
  • Page 405: Matrix Settings

    Advanced Applications Matrix Settings Once the system has been designed, click the Matrix label in the project window to view the matrix shown in the following figure. The input virtual channels that include remote audio are the “VTX1000 In” and “Program Audio”. These channels are routed to the “Amplifier” channel so they can be heard in the local room.
  • Page 406: Channels Settings

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 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.
  • Page 407 Advanced Applications By default the AEC reference has been set to the mono virtual channel “Ampli- fier” because this audio includes all the remote audio that need to be echo cancelled. 13 - 15...
  • Page 408 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 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.
  • Page 409: Wiring Information

    Advanced Applications 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 pre- sets page and in the following figure to ensure all changes are stored permanently inside the system.
  • Page 410: Controlling The System

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 tion. The digital microphone arrays require the processing of 12 analog inputs and are assigned to inputs 5 - 16 automatically, leaving the first four analog inputs available to be used with analog signals.
  • Page 411: Microphones, Video, And Telephony Application

    Advanced Applications 8 Microphones, Video, And Telephony Application This example creates a typical mono conferencing system with eight table microphones, mono program audio, a mono video codec, and a single audio amplifier zone. 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.
  • Page 412: Soundstructure Studio Steps

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 SoundStructure Studio Steps The steps to create this project are shown in the following figures. The names for the channels are the names that SoundStructure Studio defines. Step 1 - Select Inputs Select eight table microphones, a mono program audio source, a VSX8000 mono video codec, and a telephone interface.
  • Page 413: Matrix Settings

    Advanced Applications Step 3 - Select Devices Select the equipment required to create this design. By default the SoundStruc- ture C12 with a single line telephone card is selected. Step 4 - Work Offline Or Online In this step offline operation is selected to create a file for later upload into a SoundStructure C12 and TEL1 single-line telephony card.
  • Page 414 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The input virtual channels that include remote audio are the “Phone In”, “Pro- gram Audio”, and “VSX8000 In”. These channels are routed to the “Amplifier” channel so they can be heard in the local room.
  • Page 415: Channels Settings

    Advanced Applications 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.
  • Page 416 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 By default the AEC reference has been set to the mono virtual channel “Ampli- fier” because this audio includes all the remote audio that need to be echo cancelled.
  • Page 417: Wiring Information

    Advanced Applications 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.
  • Page 418 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 set mute “Mics” 1 will mute all the microphones in the system and set mute “Mics” 0 will unmute the microphones in the system. Volume Control Volume control in the room can be accomplished by adjusting the fader con- trol on the “Amplifier”...
  • Page 419: Two Pstn Line Positional "Receive" Audio Conferencing

    Advanced Applications Two PSTN Line Positional “Receive” Audio Conferencing This example creates a positional receive audio conferencing system using two telephony lines to represent two remote participants. The system is called “positional receive” because the two remote participants will come from dif- ferent loudspeakers to create a positional experience where one remote talker comes from one loudspeaker and the other remote talker’s audio is associated with the other loudspeaker system.
  • Page 420: Soundstructure Studio Steps

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The block diagram of this system is shown in the next figure. The channel names are labeled with the virtual channel names that are created by default by the SoundStructure Studio software.
  • Page 421 Advanced Applications Step 1 - Select Inputs Select 8 table microphones, a stereo program audio source, and two telephone interfaces. Step 2 - Select Outputs Select two mono amplifiers as the output devices for this example. The tele- phone outputs are automatically defined when their respective inputs are added.
  • Page 422: Matrix Settings

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Step 3 - Select Equipment Select the equipment required to create this design. By default the SoundStruc- ture C12 with a dual-line telephone card is selected. Step 4 - Work Offline or Online In this step offline operation is selected to create a file for later upload into a SoundStructure C12 and dual-line telephony card.
  • Page 423 Advanced Applications By default the two telephone lines are routed to both “Amplifier 1” and “Amplifier 2” and the stereo program audio “Program Audio” channel is routed as a mono signal to both Amplifier 1 and Amplifier 2 as shown in the next figure.
  • Page 424 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 amplifier outputs can be adjusted with the balance control as shown in the fol- lowing figure. The program audio is balanced to the left to “Amplifier 1” and to the right to “Amplifier 2”.
  • Page 425: Channels Settings

    Advanced Applications The matrix may be collapsed by clicking the arrows next to the “Mics” group resulting in the compact matrix representation shown in the following figure. This figure also shows the routing of each telephony interface to the other tele- phony interface so that both callers can hear the other caller.
  • Page 426 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 By default the two AEC references have been set to the two mono amplifiers “Amplifier 1” and “Amplifier 2” and is then shown to be in stereo mode. 13 - 34...
  • Page 427: Wiring Information

    Advanced Applications 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.
  • Page 428 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 will unmute the microphones in the system. Volume Control Volume control in the room can be accomplished by adjusting the fader con- trol on the “Amplifier 1” and “Amplifier 2” virtual channel as follows: inc fader “Amplifier 1”...
  • Page 429 Advanced Applications 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. 13 - 37...
  • Page 430: Microphones And Stereo Video Conferencing

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 8 Microphones And Stereo Video Conferencing This example creates a stereo video conferencing system with eight table microphones, stereo program audio, a VSX8000 stereo video codec, and a stereo audio amplifier. This application is similar to the 8 microphone mono example shown previously with the addition of the stereo video codec that enables both a positional “receive”...
  • Page 431 Advanced Applications Once the design is completed, the matrix looks very similar to the mono con- ferencing 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.
  • Page 432 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The remote participants at site 2 will see the site 1 talker at microphone 1 on the right side of their screen when the remote talkers are looking at the screen because the site 1 talker at microphone 1 is on the “right”...
  • Page 433 Advanced Applications 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. 13 - 41...
  • Page 434 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The other microphones also have relative positions as shown in the following figure. Camera Camera Display Display Display Right Left Reference Point Camera RIGHT LEFT Room Room Left Right...
  • Page 435: Channels Settings

    Advanced Applications By estimating their pan position, the resulting matrix will look like the next fig- ure. As microphones move from right to left relative to the camera, their panning is adjusted from positive to negative. Only the output to the video codec uses the panned output signals because there are two audio channels transmitted to the remote participants.
  • Page 436 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 By default the AEC reference has been set to the stereo virtual channel “Ampli- fier” and is then shown to be in stereo mode. 13 - 44...
  • Page 437: Wiring Information

    Advanced Applications 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 chan- nels 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.
  • Page 438: Mics With The Polycom Hdx Video 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. A drawing of this type of system is shown in the following figure.
  • Page 439 Chapter 6. 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 440: Matrix Settings

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Step 3 - Select Devices Select the equipment required to create this design. By default the SoundStruc- ture C8 is selected. Step 4 - Work Offline Or Online In this step offline operation is selected to create a file for later upload into a SoundStructure C8.
  • Page 441: Channels Settings

    “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 cancelled microphones are routed to the Polycom HDX stereo mics stream so they can be sent to the remote video participants.
  • Page 442 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 By default the AEC reference has been set to the mono virtual channel “Ampli- fier” because this audio includes all the remote audio that need to be echo cancelled.
  • Page 443: Wiring Information

    Advanced Applications 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.
  • Page 444 0dB. When connected to the Polycom HDX system, the Amplifier fader setting on the SoundStructure will be adjusted when the volume on the Polycom HDX is adjusted. As described in Chapter 6, the HDX will send a fader command to the “Amplifier”...
  • Page 445: Mics With Reinforcement Of Wireless And Lectern Mics

    Advanced Applications 8 Mics With Reinforcement Of Wireless And Lectern Mics This example shows how to use the sound reinforcement and conferencing processing to create an audio conferencing solution that includes both a lectern and wireless microphone for in-room reinforcement of the presenters’ micro- phones and use of these microphones for conferencing in addition to tabletop microphones.
  • Page 446: Soundstructure Studio Steps

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 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 447: Matrix Settings

    Advanced Applications Matrix Settings The matrix that is created by SoundStructure Studio is shown in the following figure. 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.
  • Page 448 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 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. The resulting matrix will look like the following figure.
  • Page 449: Channels Settings

    Advanced Applications 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. The feedback processing is enabled for the “Presenter Mics”...
  • Page 450 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 To ensure the wireless microphone will be the active microphone if the pre- senter 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.
  • Page 451 Advanced Applications 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 fol- lowing figure. The AEC reference for the wireless microphone is assigned to the new submix as shown in the next figure.
  • Page 452 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 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.
  • Page 453 Advanced Applications Finally, the reference for the table microphones can be set to include both the lectern and wireless microphone references. Since two references can be con- figured per microphone, the first reference will be set to “WirelessRef” and the second reference will be set to “LecternRef”.
  • Page 454 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The “RemoteAudio” submix will also be routed to the different amplifier zones and remote telephone participants. 13 - 62...
  • Page 455: Wiring Information

    Advanced Applications 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.
  • Page 456 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 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 set matrix_mute “Wireless Mic” “Amplifier 2” 1 set matrix_mute “Wireless Mic”...
  • Page 457: Mics With 6-Zone Sound Reinforcement

    Advanced Applications 16 Mics With 6-Zone Sound Reinforcement This example shows how to use the sound reinforcement and conferencing processing to create an audio conferencing solution that includes a lectern microphone, wireless microphone, and sixteen tabletop microphones that are reinforced into the room. This example includes sixteen table microphones, a lectern microphone, a wireless microphone, stereo program audio, a single telephony interface, and six zones of audio amplifiers for reinforcement.
  • Page 458: Soundstructure Studio Steps

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 SoundStructure Studio Steps Step 1 - Select Inputs The system is designed with 16 table microphones, one lectern mic, one wire- less mic with line level input, one stereo VSX8000 video codec, and a single telephony interface.
  • Page 459 Advanced Applications 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 com- ponents were added to the system in step 1. Step 3 - Select Equipment The default equipment selection will use two C12’s, and a TEL1 telephony card.
  • Page 460 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Step 4 - Work Offline Or Online As there are many matrix settings to change, we’ll work off line and adjust the crosspoints. 13 - 68...
  • Page 461: Matrix Settings

    Advanced Applications Matrix Settings The default matrix with the desired inputs and outputs is shown in the follow- ing figure. 13 - 69...
  • Page 462 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The next step is to create the microphone zone groups that will simplify setting up the reinforcement levels. The designed zones are shown in the following figure. Display Disp...
  • Page 463 Advanced Applications 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. Amplifier Lectern Wireless Zone To create a zoned reinforcement system with the reinforcement levels shown...
  • Page 464 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 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...
  • Page 465: Channels Settings

    Advanced Applications 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 shown in the following figure.
  • Page 466: Wiring Information

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 ences, and Zone 3 and Zone 4 microphones will have Zone 3 and Zone 4 amplifiers selected as shown in the next figure. This figure shows the Zone 1 microphones.
  • Page 467: Controlling The System

    Advanced Applications 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. Controlling The System The system can be controlled in the same manner as the previous examples.
  • Page 468 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 set mute “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 “VSX8000 In” 1 inc fader “Phone In”...
  • Page 469: Room Combining Application With Two Rooms

    PSTN line, a program audio feed, a loudspeaker zone, and one digital micro- phone 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 470 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The room configuration will operate as follows. Combined Mode In the combined mode, the system is configured as follows: • All microphones are routed to both telephone lines •...
  • Page 471: Soundstructure Studio Steps

    SoundStructure to adjust the fader level on the channel “Amplifier”. 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. 13 - 79...
  • Page 472 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 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.
  • Page 473 Advanced Applications Step 4 - Work Offline Or Online As there are many matrix settings to change, we’ll work off line and adjust the crosspoints. 13 - 81...
  • Page 474: Combined Room Settings

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Combined Room Settings The default matrix with the desired inputs and outputs is shown in the follow- ing figure. 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”...
  • Page 475 Advanced Applications The updated matrix is shown in the following figure. 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 video participants and to the “Phone 1 Out”...
  • Page 476 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 On the channels page, set the AEC reference for all the Room 1 microphones as “Amplifier 1” and for the room 2 microphones as “Amplifier 2” as shown in the following figure.
  • Page 477: Split Room Settings

    Advanced Applications 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.
  • Page 478 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The automixer settings for the Room 1 mics is shown in the following figure after the Room 2 microphones have been removed. 13 - 86...
  • Page 479 Advanced Applications 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. No adjustments need to be made to the echo canceller references because the microphones were configured earlier to use their respective room amplifiers as the AEC reference.
  • Page 480: Wiring Information

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 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. Wiring Information The system should be wired according to the information found in the wiring page and shown in the following figure.
  • Page 481: Controlling The System

    Advanced Applications 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 available for the program audio sources.
  • Page 482 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 to increment the gain in the combined 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”...
  • Page 483: Troubleshooting

    TroubleShooting This chapter presents a series of situations and troubleshooting steps to resolve the situation. Troubleshooting is most effective when problems can be isolated, reproduced, and then resolved one at a time. This “divide-and-con- quer” approach will be used in this chapter. Audio Troubleshooting Many audio problems can be traced to the following issues: 1.
  • Page 484 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Is the amplifier turned on? Can other sources of audio be heard in the local room? Add a Signal Generator from the Edit Channels control and route the signal generator to the amplifier virtual channel.
  • Page 485 TroubleShooting Also ensure the sound reinforcement signal path is selected at the matrix crosspoint. There should be a light blue background on the crosspoints routing the microphones to be reinforced to the audio amplifier as shown in the fol- lowing figure where “Table Mic 1” is routed to the “Amplifier” virtual channel.
  • Page 486: Echo Troubleshooting

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Echo Troubleshooting Many echo problems can be traced to: 1. Check loop-back echo. A matrix cross-point may have been inadvertently unmuted, causing a direct replica of the audio to be heard remotely.
  • Page 487 An example of the “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 HDX, the telco audio, the program audio, and the audio from the remaining remote source are all part of the “Amplifier”...
  • Page 488 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 reduce room gain by lowering the audio amplifier level and increasing the input gain on the remote audio coming into the SoundStructure to ensure the signal levels are at a reasonable level.
  • Page 489 TroubleShooting Because the AEC reference is available after the fader as presented in Chapter 3 and shown in the following figure, the result is that the AEC reference is also attenuated and therefore the echo canceller would not be able to remove the echo because the reference level is attenuated too much.
  • Page 490 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 the following figure. The result of this is that the proper signal levels are pre- sented to the echo canceller and the output signal levels are attenuated appropriately. The Local People Hear Echo Of Their Voices From The Remote Room This problem is most likely with the remote room’s acoustic echo canceller.
  • Page 491: Api Troubleshooting

    TroubleShooting API Troubleshooting When using TeraTerm 3.1 and connecting over Telnet, why do I have to select CR-LF termination for commands sent to SoundStructure and not just CR termination? As described in Appendix A, SoundStructure devices accept commands sent to it with either CR or CR-LF terminations. What we noticed is that when using Tera Term in telnet mode, Tera Term terminates commands transmitted to SoundStructure with two bytes - CR and a Null character - even though only the CR termination is selected in the Tera Term user interface.
  • Page 492 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 will cause this error message. Fix this syntax by putting double quotes around the virtual channel name such as with the command set mute “Table Mic 1” 1 and the system will work properly.
  • Page 493 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 494: Rs-232 Troubleshooting

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 RS-232 Troubleshooting I Can’t Connect Over RS-232 To The System, How Do I Connect? Check that the baud rate between the PC or Control system and the Sound- Structure device are set to the same value. Baud rates above 9,600 baud should have hardware flow control enabled on both the SoundStructure device and the control system or local PC.
  • Page 495: Hdx Integration

    1 none where 1 is the device ID. HDX Integration How Do I Know The Polycom HDX System Is Connected Properly To The SoundStructure? The Polycom HDX Diagnostics and System Status screen shows whether the SoundStructure device (labeled as Polycom Mixer) has been detected. A green arrow associated with the Polycom Mixer, as shown in the following figure, indicates the systems have detected each other and are working properly.
  • Page 496: Telco Troubleshooting

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The connection status can also be viewed within the System Information page on the Polycom HDX. If the status shows Polycom Mixer then the system has connected properly to the SoundStructure.
  • Page 497: Ethernet

    TroubleShooting Use SoundStructure Studio and from the Channels Page select the phone Set- tings... button to open a telephone keypad. Click the handset icon to take the phone off hook. Check that the virtual channel name used for the telephone channel matches the name used within SoundStructure Studio to create the telephone channel.
  • Page 498: Hardware Troubleshooting

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 SoundStructure Studio Can’t Find My SoundStructure Device Over Ethernet Depending on network router configurations, SoundStructure Studio may only be able to find devices that are connected to the same subnet as the local PC that is running SoundStructure Studio.
  • Page 499: Obam Troubleshooting

    TroubleShooting If the front-panel LED is green, then the hardware is operating correctly. If there is a yellow LED on the front-panel, there is information in a Sound- Structure system log that should be reviewed. The LED could be yellow for a variety of reasons including the design file expects a specific device configura- tion which is not found.
  • Page 500: Troubleshooting The Ir Interface

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 into the OBAM in and out ports as shown in the following figure. If the Sound- Structure device’s OBAM interface is working properly the LEDs should illuminate. LINK2 OBAM...
  • Page 501: Contacting Technical Support

    TroubleShooting The key press values returned correspond to the mapping on the HDX IR remote controller as specified in the Polycom HDX Integrator’s Reference Manual. 480-00 Series Data +12V Contacting Technical Support Before contacting technical support, make sure you have saved the Sound- Structure Studio design file and also saved your log file to disk as technical support will want to review these files while helping with the system.
  • Page 502 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 14 - 20...
  • Page 503: Specifications

    Specifications Technical Specifications Dimensions • 19" (483 mm) W x 13.5" (343 mm) L x 1.75" (45 mm) H (one rack unit) Weight • 12 lbs. (5.5 kg) dry, 14 lbs. (6.4 kg) shipping Connectors • RS-232: DB9F • OBAM In/Out: IEEE 1394B •...
  • Page 504 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Thermal • Thermal Dissipation (Btu/hr): 266 Btu/hr (C16), 230 Btu/hr (C12), 215 Btu/hr (SR12), 200 Btu/hr (C8) • Operating temperature 0 - 40° C (104° F) Operating temperature ranges for the three thermal sensors located on the SoundStructure device are shown in the following table.
  • Page 505 Specifications System Unless noted, all values are valid for all channels at 0 dB input gain. • Frequency response: 20-22,000 Hz, + 0.1 /- 0.3 dB • Idle channel noise: <-109 dB FS no weighting, 20-20,000 Hz, -60 dB FS, 997 Hz input signal, 0 dB gain •...
  • Page 506: Pin Out Summary

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Pin Out Summary 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 507: Conference Link2

    Specifications Conference Link2 To build a custom Conference Link2 cable, use shielded CAT5e, or better, and terminate both end connectors, P1 and P2, with standard 8P8C plugs (for example, RJ45) using the wiring connections shown in the following figure. The maximum length for this cable is 100 feet (30 m). Note that this cable pro- vides a cross-over connection between pins 1 and 2 and pins 5 and 6.
  • Page 508: Obam Link

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 OBAM Link The OBAM cable is a standard 1394b BETA style cable. The current maximum length of this cable is 12 inches. While OBAM Link uses 1394b cables, the underlying bus protocol is not IEEE1394b compliant which means that external IEE1394b devices will not be compatible with OBAM Link.
  • Page 509: Ir Receiver

    Specifications IR Receiver The IR receiver port on the rear-panel of a SoundStructure device is shown in the next figure. PIN 2: TXD PIN 3: RXD PIN 5: GRO PIN 7: CTS PIN 8: RTS The IR receiver port accepts a standard 3.5 mm terminal block which should be terminated to the IR receiver as shown in the following figures.
  • Page 510: Logic Interface

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 SoundStructure Control System Signal Signal Ground Ground Logic Interface Pin 13 Pin 1 Pin 25 Pin 14 REMOTE CONTROL 1 Pin 13 Pin 1 Pin 25 Pin 14 REMOTE CONTROL 2...
  • Page 511: Audio Connections

    Specifications Logic Output 10 Logic Input 11 Logic Output 11 Ground Analog Gain 1 Remote Control 2 Signal Signal +5 V Logic Input 12 Logic Output 12 Logic Input 13 Logic Output 13 Logic Input 14 Logic Output 14 Logic Input 15 Logic Output 15 Logic Input 16 Logic Output 16...
  • Page 512 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Structure device's audio input and output to other balanced or unbalanced audio equipment, follow the wiring convention in the unbalanced audio con- nections in the following figure. XLR Female...
  • Page 513: Using Soundstructure Studio Controls

    Using SoundStructure Studio Controls The SoundStructure Studio software environment includes various user inter- face controls for adjusting the parameters of virtual channels. This section summarizes how to use these controls. Adjusting Knobs There are three ways to change the value associated with a knob control: 1.
  • Page 514: Adjusting Matrix Crosspoints

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Adjusting Matrix Crosspoints Individual crosspoints can be adjusted by double clicking the crosspoint. This will bring up the matrix control that allows the crosspoint gain, mute status, or which of the three flavors of the input signal to select for this matrix crosspoint.
  • Page 515 Using SoundStructure Studio Controls 13 - 3...
  • Page 516 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 13 - 4...
  • Page 517 PIN 7: CTS PIN 8: RTS REMOTE CONTROL 1 RS-232 REMOTE CONTROL 2 SoundStructure C16 C-LINK2 OBAM The SoundStructure control protocol has been designed so that all features are available over all interfaces. Some features will only be practical over the...
  • Page 518: Rs-232

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 RS-232 A SoundStructure device’s RS-232 port is a female DB9 DCE supporting a fixed data format of eight data bits, no parity, and one stop bit. The supported flow control options are hardware (RTS/CTS) and none. The supported baud rates are 9600, 19200, 38400, 57600, and 115200 with a default baud rate of 9600.
  • Page 519: Ethernet

    Command Protocol Reference Guide Ethernet Each SoundStructure device has a rear-panel Ethernet interface for connecting to the local area network as shown in the following figure. Connect to the SoundStructure device using port 52774 and telnet communication. There is no user login required to interface to SoundStructure devices over this port. PIN 2: TXD PIN 3: RXD PIN 5: GROUND...
  • Page 520: Virtual Channels

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 the SoundStructure devices to more than one network. Multiple network con- nections can be on the same network or on different subnets as shown in the following figure. SoundStructure C16 .100...
  • Page 521 Command Protocol Reference Guide The motivation for using virtual channels is both to allow the control system programming to start before the physical wiring may be known and to make the control system programming re-usable across different installations regardless of how the system is wired. Virtual channels allow third-party con- trol system code to be easily re-used because the controller code controls the SoundStructure devices through the virtual channel names, not the underly- ing physical input and output that a particular channel is connected to.
  • Page 522: Virtual Channel Types

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Virtual Channel Types Virtual channels are operated on by the command set which can apply param- eter 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.
  • Page 523: Soundstructure Command Syntax

    Command Protocol Reference Guide As an example of a virtual channel group, consider in the following figure the creation of the virtual channel group “Mics” made up of the entire collection of individual microphone virtual channels in a room. Once the virtual channel group “Mics”...
  • Page 524: Controlling Soundstructure Parameters

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Controlling SoundStructure Parameters The SoundStructure command and control functions allow an external con- troller to set, query, and monitor parameters of one or more linked SoundStructure devices. There are three types of parameters that can be controlled: •...
  • Page 525 Command Protocol Reference Guide void Void commands take no argument, and must be write-only. For example, the sys_reboot parameter is a write-only void parameter that reboots the Sound- Structure device when the command is executed. boolean Boolean parameters take one of two values: 0 or 1. integer Integer parameters represent an integer value.
  • Page 526: Command Format

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Command Format Referring to the command hierarchy below, each sub-category of command inherits the syntax of its parent and adds further syntax requirements. Starting at the root of the hierarchy, all commands have the following syntax: <action>...
  • Page 527: Control Commands

    Command Protocol Reference Guide Command Length All commands must be less than or equal to 2048 bytes in length, including the terminator. Control Commands Most of the commands in the SoundStructure control protocol fall under the category of control commands. All control commands have the following syntax: <action>...
  • Page 528 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Floating-Point Arguments Floating-point arguments represent a floating-point value. They are repre- sented using a string of digits (0030-0039), an optional decimal point symbol (002E), an optional E (0045) or e (0065) for indicating an exponent, and optional plus symbols (002B) or minus symbols (002D) for indicating the sign of the mantissa or exponent.
  • Page 529: Virtual Channel Definition Commands

    Command Protocol Reference Guide Virtual Channel Definition Commands Virtual channel definition commands are a type of control command that pro- vide methods for defining virtual channels and mapping them to physical channels. The SoundStructure Studio software will create the virtual channel definitions based on the input and output selections the designer has chosen.
  • Page 530 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Virtual channel type Description stereo A stereo virtual channel control A control channel such as logic input or output or IR receiver control_array A collection of control pins, in other words a group of logic input or output pins <pctype>...
  • Page 531 “ir receiver” control ir_in 1 This creates the virtual channel name “ir receiver” that will report back any IR key presses that are received using the standard Polycom HDX IR receiver that has been set to a device ID of 3.
  • Page 532 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 vcdef Acknowledgements When a virtual channel definition command with the vcdef action is success- fully executed, SoundStructure will send an acknowledgement in the same format as the command. The acknowledgement will be sent to all interfaces.
  • Page 533 Command Protocol Reference Guide The <pctype> argument defines the physical channel type of the physical channels in the virtual channel. The <pctype> argument is a system defined text argument that must be one of the pctypes listed in the vcdef section. <num>...
  • Page 534: Virtual Channel Group Definition Commands

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The <label> argument is a user-defined text argument that specifies the name of the virtual channel to be renamed. If no virtual channel exists with the given label, then the SoundStructure device will respond with an error message.
  • Page 535 Command Protocol Reference Guide Each of the command arguments is described below. <label> The <label> argument is a user-defined text argument that defines the name for the new virtual channel group. If a virtual channel group or virtual chan- nel already exists with the same label, the SoundStructure device will respond with an error message.
  • Page 536 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 vcgrename <label> <new-label><term> Each of the command arguments is described below. <label> The <label> argument is a user-defined text argument that specifies the name of the virtual channel group to be renamed. If no virtual channel group exists with the given label, then the SoundStructure device will respond with an error message.
  • Page 537 Command Protocol Reference Guide vcgadd Acknowledgements When a virtual channel group definition command with the vcgadd action is successfully executed, the SoundStructure device will send an acknowledge- ment in the same format as the command. The acknowledgement will be sent to all control interfaces.
  • Page 538: Adjusting Parameters

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The <label> argument is a user-defined text argument that specifies the name of the virtual channel group that will have its members listed. If no virtual channel group exists with the given label, then SoundStructure will respond with an error message.
  • Page 539 Command Protocol Reference Guide Some examples of parameter commands are given below. get sys_sw_ver 1 set mic_in_gain "DVD Audio" 10 set fader max "DVD Audio" 10 inc fader "DVD Audio" 2 tog aec_en "Mic 1" set eq_en "Speaker 1" 1 set peq_gain "Speaker 2"...
  • Page 540 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Limit Description operate on the minimum limit for the parameter operate on the maximum limit for the parameter The behavior of a command when it reaches its minimum or maximum is determined by the parameter type as described previously.
  • Page 541 Command Protocol Reference Guide Thus, read-write commands support the get and set actions and support the inc, dec, or tog actions depending on the parameter type. Read-only com- mands support the get action, but do not support the set, inc, dec, or tog actions.
  • Page 542 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Float parameter commands support the get, set, inc and dec actions according to the command’s read-write mode. When performing increment and decre- ment actions on float parameters, the parameter saturates at the minimum or maximum value rather than wrapping.
  • Page 543 Command Protocol Reference Guide Acknowledgements 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 acknowledgement is only sent to the control interface that the parameter command was received from. When a parameter command is executed with the get action, the acknowledgement is only sent to the control interface that the parameter command was received from.
  • Page 544: Command List

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Command List The complete system parameter command reference is found in the file sound- structure-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.
  • Page 545 (used with the SR12), telephony input and output channels, submix channels, and the ConferenceLink channels to and from the Polycom HDX video system. The Virt Chans entry indicates that the command can operate on both mono and stereo virtual channels.
  • Page 546: Soundstructure Parameters

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Fader Examples Examples of using the fader commands and their acknowledgements are shown below: set fader "Amplifier" 1 val fader "Amplifier" 1.0 set fader "Amplifier" 10 val fader "Amplifier" 10.0 set fader max "Amplifier"...
  • Page 547 Command Protocol Reference Guide Argument Argument value Conferencing Mic/Line Input, Conferencing Line Output, Sound Reinforcement Mic/Line Input, Sound Reinforcement Phys Chans Line Output, Analog Telephony Input, Analog Telephony Output, Submix, ConferenceLink Aux Input, ConferenceLink Aux Output Virt Chans Mono, Stereo System Limits Minimum: -100.0, Maximum: 20.0, Resolution: 0.1 Default...
  • Page 548 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Line Output Gain line_out_gain Argument 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...
  • Page 549 Command Protocol Reference Guide Description This parameter defines the peak hold behavior of all of the peak meters in the system. If the infinite peak hold mode is selected, the peaks can be reset using the meter_peak_reset parameter. Meter Peak Reset meter_peak_reset Argument Argument value...
  • Page 550 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Digital Mute mute Argument Argument value Channel Type Virtual Channel Value Type Boolean Read/Write Mode Read/Write Phys Chans Conferencing Mic/Line Input, Conferencing Line Output, Sound Reinforcement Mic/Line Input, Sound Reinforcement...
  • Page 551 Command Protocol Reference Guide Argument Argument value Phys Chans 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. Examples Command Response...
  • Page 552 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Signal Activity Threshold signal_activity_thresh Argument Argument value Channel Type Global System Value Type Floating-Point Read/Write Mode Read/Write System Limits Minimum: -100.0, Maximum: 20.0, Resolution: 0.1 Default -20.0 User Limits...
  • Page 553: Matrix Parameters

    Command Protocol Reference Guide Examples Command Response Description set trim "Program Audio" val trim "Program Audio" Sets the trim value of the left channel (channel 1) of the stereo virtual channel "Program Audio" to 2dB. set trim "Program Audio" val trim "Program Audio" Sets the trim value of the right channel (channel 2) of the 2 -3 2 -3...
  • Page 554 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 set matrix_balance val matrix_balance Sends only the right channel of the stereo program audio "Program Audio" "HDX "Program Audio" "HDX "Program Audio" source to both stereo audio outputs Line Mix Out" 1 Line Mix Out"...
  • Page 555 Command Protocol Reference Guide get matrix_gain "Table val matrix_gain "Table Queries the matrix crosspoint gain from input "Table Mic Mic 1" "Phone Out" Mic 1" "Phone Out" 3 1" to output "Phone Out". Enable Gated Signal At Crosspoint matrix_gate Argument Argument value Channel Type Matrix...
  • Page 556 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Select Gating Type matrix_gate_type Argument Argument value Channel Type Matrix Value Type List Read/Write Mode Read/Write Row Phys Chans Conferencing Mic/Line Input Row Virt Chans Mono, Stereo Conferencing Line Output, Sound Reinforcement Line...
  • Page 557 Command Protocol Reference Guide Argument Argument value Conferencing Mic/Line Input, Sound Reinforcement Mic/Line Row Phys Chans Input, Analog Telephony Input, Signal Generator, Submix, ConferenceLink Aux Input, ConferenceLink Raw Input Row Virt Chans Mono, Stereo Conferencing Line Output, Sound Reinforcement Line Col Phys Chans Output, Analog Telephony Output, Submix, ConferenceLink Aux Output...
  • Page 558 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Examples Command Response Description set matrix_mute "Table val matrix_mute "Table Mutes the crosspoint from input "Table Mic 1" to the Mic 1" "Phone Out" 1 Mic 1" "Phone Out" 1 output "Phone Out"...
  • Page 559: Telephony Parameters

    Command Protocol Reference Guide set matrix_pan "Phone In" val matrix_pan "Phone In" Sends the mono virtual channel "Phone In" to only the left "Amplifier" -1 "Amplifier" -1.000 channel of the stereo virtual channel "Amplifier". set matrix_pan "Phone In" val matrix_pan "Phone In" Sends the mono virtual channel "Phone In"...
  • Page 560 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Command Input channel Output channel ✔ pstn_auto_hangup_loop_en ✔ pstn_country ✔ pstn_flash_delay_override ✔ pstn_in_gain ✔ pstn_line_voltage ✔ pstn_loop_current ✔ pstn_out_gain Enable Auto-Answer For Telephony Interface phone_auto_answer_en Argument Argument value Channel Type...
  • Page 561 Command Protocol Reference Guide Connect Or Disconnect Telephony Interface phone_connect Argument Argument value Channel Type Virtual Channel Value Type Boolean Read/Write Mode Read/Write Phys Chans Analog Telephony Output, VoIP Telephony Output Virt Chans Mono Default Event Source Description This parameter sets the connection status of the telephony interface. Setting the phone_connect status to 1 connects the call, while setting it to 0 disconnects the call.
  • Page 562 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Description This command dials the specified string of digits on the telephony interface. This parameter can be used to dial one digit at a time or many digits all at once.
  • Page 563 Command Protocol Reference Guide Dial Tone Gain phone_dial_tone_gain Argument Argument value Channel Type Virtual Channel Value Type Floating-Point Read/Write Mode Read/Write Phys Chans Analog Telephony Input Virt Chans Mono System Limits Minimum: -100.0, Maximum: 20.0, Resolution: 0.1 Default User Limits Supported Event Source Description...
  • Page 564 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Argument Argument value Default User Limits Supported Event Source Description 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.
  • Page 565 Command Protocol Reference Guide Enable Exit Tones For Telephony Interface phone_exit_tone_en Argument Argument value Channel Type Virtual Channel Value Type Boolean Read/Write Mode Read/Write Phys Chans Analog Telephony Input, VoIP Telephony Input Virt Chans Mono Default Event Source Description This parameter enables or disables exit tone generation for the telephony inter- face.
  • Page 566 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 set phone_flash "Phone val phone_flash "Phone Flashes the phone interface associated with the virtual Out" Out" channel "Phone Out" to -6dB. Note that the phone out virtual channel name must be used, not the phone in virtual channel name.
  • Page 567 Command Protocol Reference Guide Description This parameter causes the incoming call to be ignored. The incoming ring tones will be silenced on the local side, but the remote caller will still hear ring- ing. Taking the phone offhook when there is an incoming ignored call will cause the incoming call to be answered.
  • Page 568 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 answering it, then immediately hanging up. The audio paths remain muted so that the conference is not interrupted and so that no local conference audio is sent to the incoming caller.
  • Page 569 Command Protocol Reference Guide Argument Argument value System Limits Minimum: 1, Maximum: 14 Default Event Source Description This parameter selects the type of ring tone to be generated for the telephony interface. If ring tones are enabled, the selected tone is played whenever there is an incoming ring signal on the telephony interface.
  • Page 570 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Argument Argument value Virt Chans Mono Default 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.
  • Page 571 Command Protocol Reference Guide Argument Argument value 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 fea- ture for the PSTN interface. Enable Auto-Hangup On Call pstn_auto_hangup_call_prog_en Progress For PSTN Interface Argument...
  • Page 572 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Argument Argument value Values argentina : Argentina australia : Australia austria : Austria bahrain : Bahrain belgium : Belgium brazil : Brazil bulgaria : Bulgaria canada : Canada chile : Chile...
  • Page 573 Command Protocol Reference Guide Argument Argument value Values italy : Italy japan : Japan jordan : Jordan kazakhstan : Kazakhstan kuwait : Kuwait latvia : Latvia lebanon : Lebanon luxembourg : Luxembourg macao: Macao malaysia : Malaysia malta : Malta mexico : Mexico morocco : Morocco netherlands : Netherlands...
  • Page 574 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Argument Argument value Event Source Description This parameter configures the PSTN interface for operation in a specific country. Tone duration for DTMF Tones pstn_dtmf_tone_duration Argument Argument value Channel Type...
  • Page 575 Command Protocol Reference Guide 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). PSTN Input Gain pstn_in_gain Argument Argument value Channel Type Virtual Channel Value Type Floating-Point Read/Write Mode...
  • Page 576 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Argument Argument value Virt Chans Mono System Limits Minimum: -128, Maximum: 128 Event Source Description This parameter indicates the line voltage (in Volts) of the PSTN interface. The value is valid in both on-hook and off-hook modes. The value can be positive or negative, indicating the polarity of the tip/ring voltage.
  • Page 577 Command Protocol Reference Guide PSTN Output Gain pstn_out_gain Argument Argument value Channel Type Virtual Channel Value Type Floating-Point Read/Write Mode Read/Write 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...
  • Page 578 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Argument Argument value Phys Chans VoIP Telephony Output Virt Chans Mono Event Source Description This parameter is used along with voip_transfer to make a blind transfer. VoIP Board Info...
  • Page 579 (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. A - 63...
  • Page 580 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Call Appearance Info voip_call_appearance_info Argument Argument value Channel Type Virtual Channel Value Type String Read/Write Mode Read-Only Phys Chans VoIP Telephony Output Virt Chans Mono Indices 1-24: Call appearance index...
  • Page 581 Command Protocol Reference Guide Call Appearance State voip_call_appearance_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-24 : Call appearance index Values free : Free dialtone : Dialtone setup : Setup overlap : Overlap proceeding : Proceeding...
  • Page 582 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Cancel a Transfer or Conference voip_cancel 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 cancel a transfer or conference.
  • Page 583 Command Protocol Reference Guide Argument Argument value Virt Chans Mono Values option66 : Option 66 custom : Custom static : Static (default) custom_opt66 : Custom + Option 66 Event Source Description This parameter controls the boot server option for the VoIP interface. Set Boot Server Option Numberl voip_dhcp_boot_serv_opt Argument...
  • Page 584 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Argument Argument value Virt Chans Mono Values ip_address : IP Address (default) string : string Event Source Description When voip_dhcp_boot_serv is set to custom, this parameter specifies the type of the DHCP option in which the VoIP card will look for the boot server.
  • Page 585 Command Protocol Reference Guide Argument Argument value Virt Chans Mono Values number : Number (digit) dialing (default) url : SIP URL dialing Event Source Description This parameter is used to select between number dialing and SIP URL dialing. Whenever the phone_connect parameter for a voip_out channel changes from 1 to 0, the voip_dial_mode parameter shall be reset back to number.
  • Page 586 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Argument Argument value System Limits Max String Length: 256 Default mode=’dhcp’ Event Source Description This parameter gets or sets the Ethernet settings for the VoIP interface. The system must be rebooted for the Ethernet settings to take effect.
  • Page 587 Command Protocol Reference Guide Argument Argument value Phys Chans VoIP Telephony Input Virt Chans Mono System Limits Minimum: -1, Maximum : 4096 Default User Limits Supported Event Source Description This parameter sets the VLAN ID for the VoIP card. A value of -1 corresponds to "disabled."...
  • Page 588 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Argument Argument value Phys Chans VoIP Telephony Output Virt Chans Mono Event Source Description This parameter is used to forward a call. Place Current Call on Holdl voip_hold Argument...
  • Page 589 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. Label for the Line Keyl voip_line_label...
  • Page 590 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 State for the VoIP Linel 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 A - 74...
  • Page 591 Command Protocol Reference Guide Argument Argument value Indices 1-12 : Line number Values none messages do_not_disturb line_not_registered line_registered in_conference call_active call_on_hold shared_line speed_dial_indicator forward_all_calls acd_online acd_offline acd_not_logged_in acd_available remote_active secure_rtp remote_hold hd_audio offering proceed dial_tone held disconnect feat_enabled feat_disabled cma_presence_available cma_presence_busy cma_presence_available_in_a_call cma_presence_unavailable...
  • Page 592 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Argument Argument value Event Source Description This parameter reports the state for the specified line. Reset Local Configuration Parametersl voip_local_reset Argument Argument value Channel Type Virtual Channel Value Type...
  • Page 593 Command Protocol Reference Guide Save VoIP Network Settingsl voip_net_cfg_save 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 causes the VoIP network settings to be written to the flash on the VoIP card.
  • Page 594 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Argument Argument value Virt Chans Mono System Limits Max String Length : 256 Default Event Source Description This parameter sets the password for the provisioning server used by the VoIP interface.
  • Page 595 Command Protocol Reference Guide Argument Argument value Virt Chans Mono Default Event Source Description This parameter sets the username for the provisioning server used by the VoIP interface. Reboot VoIP Interfacel voip_reboot Argument Argument value Channel Type Virtual Channel Value Type Void Read/Write Mode Write-Only...
  • Page 596 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Send Call that can’t be Auto-dialedl voip_send 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 causes a call to be placed with the digits dialed so far.
  • Page 597 Command Protocol Reference Guide Argument Argument value Virt Chans Mono Values booting : The VoIP card is booting ok : 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.
  • Page 598: Equalizer Parameters

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Description This parameter returns the UC software version of the VoIP plug-in card. Equalizer Parameters Description The line outputs (both conferencing and sound reinforcement) each have a graphic equalizer that can have either 10 bands (1 octave), 15 bands (2/3 octave), or 31 bands (1/3 octave).
  • Page 599 Command Protocol Reference Guide Select Graphic or Parametric Equalizer eq_type Argument Argument value Channel Type Virtual Channel Value Type List Read/Write Mode Read/Write Phys Chans Conferencing Line Output, Sound Reinforcement Line Output Virt Chans Mono, Stereo Values geq: Graphic Equalizer (default) peq: Parametric Equalizer Event Source Description...
  • Page 600 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Enable Graphic Equalizer geq_en Argument Argument value Channel Type Virtual Channel Value Type Boolean Read/Write Mode Read/Write Phys Chans Conferencing Line Output, Sound Reinforcement Line Output Virt Chans Mono, Stereo...
  • Page 601 Command Protocol Reference Guide Graphic Equalizer Type geq_type Argument Argument value Channel Type Virtual Channel Value Type List Read/Write Mode Read/Write Phys Chans Conferencing Line Output, Sound Reinforcement Line Output Virt Chans Mono, Stereo 1 : octave (10 band) Values 2/3 : 2/3 octave (15 band) 1/3 : 1/3 octave (31 band) (default) Event Source...
  • Page 602 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Frequency Of High Shelving Filter high_shelf_frequency Argument Argument value Channel Type Virtual Channel Value Type Floating-Point Read/Write Mode Read/Write Conferencing Mic/Line Input, Conferencing Line Output, Sound Reinforcement Mic/Line Input, Sound Reinforcement...
  • Page 603 Command Protocol Reference Guide Description This parameter sets the gain (in dB) of the high shelving filter at DC. Slope Of High Shelving Filter high_shelf_slope Argument Argument value Channel Type Virtual Channel Value Type List Read/Write Mode Read/Write Conferencing Mic/Line Input, Conferencing Line Output, Sound Reinforcement Mic/Line Input, Sound Reinforcement Phys Chans Line Output, Analog Telephony Input, Analog Telephony...
  • Page 604 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Frequency of Horn Equalizer horn_frequency Argument 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...
  • Page 605 Command Protocol Reference Guide Frequency Of High-Pass Filter hpf_frequency Argument Argument value Channel Type Virtual Channel Value Type Floating-Point Read/Write Mode Read/Write Conferencing Mic/Line Input, Conferencing Line Output, Sound Reinforcement Mic/Line Input, Sound Reinforcement Phys Chans Line Output, Analog Telephony Input, Analog Telephony Output, Submix, ConferenceLink Aux Input, ConferenceLink Aux Output Virt Chans...
  • Page 606 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Argument Argument value Default User Limits Supported Event Source Description This parameter sets the order of the high-pass filter. Linkwitz-Riley filters only support even orders. If an odd order is specified for a Linkwitz-Riley filter, it will be internally rounded up to an even number.
  • Page 607 Command Protocol Reference Guide Argument Argument value Conferencing Mic/Line Input, Conferencing Line Output, Sound Reinforcement Mic/Line Input, Sound Reinforcement Phys Chans Line Output, Analog Telephony Input, Analog Telephony Output, Submix, ConferenceLink Aux Input, ConferenceLink Aux Output Virt Chans Mono, Stereo Default Event Source Description...
  • Page 608 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Gain Of Low Shelving Filter low_shelf_gain Argument Argument value Channel Type Virtual Channel Value Type Floating-Point Read/Write Mode Read/Write Conferencing Mic/Line Input, Conferencing Line Output, Sound Reinforcement Mic/Line Input, Sound Reinforcement...
  • Page 609 Command Protocol Reference Guide Enable Low-Pass Filter lpf_en Argument Argument value Channel Type Virtual Channel Value Type Boolean Read/Write Mode Read/Write Conferencing Mic/Line Input, Conferencing Line Output, Sound Reinforcement Mic/Line Input, Sound Reinforcement Phys Chans Line Output, Analog Telephony Input, Analog Telephony Output, Submix, ConferenceLink Aux Input, ConferenceLink Aux Output Virt Chans...
  • Page 610 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Description This parameter sets the frequency (in Hz) of the low-pass filter. For Butter- worth filters this is the 3 dB frequency, but for Linkwitz-Riley filters, this is the 6 dB frequency.
  • Page 611 Command Protocol Reference Guide Argument Argument value 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. Enable Parametric Equalizer Band peq_band_en Argument Argument value...
  • Page 612 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Argument Argument value Conferencing Mic/Line Input, Conferencing Line Output, Sound Reinforcement Mic/Line Input, Sound Reinforcement Phys Chans Line Output, Analog Telephony Input, Analog Telephony Output, Submix, ConferenceLink Aux Input, ConferenceLink...
  • Page 613 Command Protocol Reference Guide Argument Argument value Default 1000.0 User Limits Supported Event Source Description This parameter sets the frequency (in Hz) of the specified parametric equalizer band. In the case of peaking and notch types, this is the frequency at which the filter applies maximum (or minimum) gain.
  • Page 614: Dynamics Processing Parameters

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Type Of parametric Equalizer Band peq_type Argument Argument value Channel Type Virtual Channel Value Type List Read/Write Mode Read/Write Conferencing Mic/Line Input, Conferencing Line Output, Sound Reinforcement Mic/Line Input, Sound Reinforcement...
  • Page 615 Command Protocol Reference Guide Argument Argument value Conferencing Mic/Line Input, Conferencing Line Output, Sound Reinforcement Mic/Line Input, Sound Reinforcement Phys Chans Line Output, Analog Telephony Input, Analog Telephony Output, Submix, ConferenceLink Aux Input, ConferenceLink Aux Output Virt Chans Mono, Stereo Default Event Source Description...
  • Page 616 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Dynamics ‘Gate’ Decay Time dp_gate_decay Argument Argument value Channel Type Virtual Channel Value Type Integer Read/Write Mode Read/Write Conferencing Mic/Line Input, Conferencing Line Output, Sound Reinforcement Mic/Line Input, Sound Reinforcement...
  • Page 617 Command Protocol Reference Guide Description This parameter enables (1) or disables (0) the gate function of the dynamics processor. This parameter and dp_en must be enabled for the gate to function. This parameter does not affect the automixer processing. Gate Hold Time dp_gate_hold Argument Argument value...
  • Page 618 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Argument Argument value System Limits Minimum: 1.0, Maximum:100.0, Resolution: 0.1 Default 100.0 User Limits Supported Event Source Description This parameter sets the ratio of the target gain applied by the dynamics gate versus the difference between the input signal level and the gate threshold.
  • Page 619 Command Protocol Reference Guide Expander Attack Time dp_exp_attack Argument Argument value Channel Type Virtual Channel Value Type Integer Read/Write Mode Read/Write Conferencing Mic/Line Input, Conferencing Line Output, Sound Reinforcement Mic/Line Input, Sound Reinforcement Phys Chans Line Output, Analog Telephony Input, Analog Telephony Output, Submix, ConferenceLink Aux Input, ConferenceLink Aux Output Virt Chans...
  • Page 620 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Argument Argument value Default User Limits Supported Event Source Description This parameter sets the amount of time (in milliseconds) it takes the expander to ramp down to the target gain once the input signal drops below the expander threshold.
  • Page 621 Command Protocol Reference Guide Argument Argument value Conferencing Mic/Line Input, Conferencing Line Output, Sound Reinforcement Mic/Line Input, Sound Reinforcement Phys Chans Line Output, Analog Telephony Input, Analog Telephony Output, Submix, ConferenceLink Aux Input, ConferenceLink Aux Output Virt Chans Mono, Stereo System Limits Minimum: 1.0, Maximum: 100.0, Resolution: 0.1 Default...
  • Page 622 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Description This parameter sets the RMS level (in dBFS) of the input signal below which the expander engages. Compressor Attack time dp_comp_attack Argument Argument value Channel Type Virtual Channel...
  • Page 623 Command Protocol Reference Guide Argument Argument value System Limits Minimum: 1, Maximum: 2000 Default User Limits Supported Event Source Description This parameter sets the amount of time (in milliseconds) it takes the compres- sor to ramp the gain up to the target gain once the input signal level drops below the compressor threshold.
  • Page 624 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Argument Argument value Conferencing Mic/Line Input, Conferencing Line Output, Sound Reinforcement Mic/Line Input, Sound Reinforcement Phys Chans Line Output, Analog Telephony Input, Analog Telephony Output, Submix, ConferenceLink Aux Input, ConferenceLink...
  • Page 625 Command Protocol Reference Guide Description This parameter sets the RMS level (in dBFS) of the input signal above which the compressor engages. Limiter Attack Time dp_lim_attack Argument Argument value Channel Type Virtual Channel Value Type Integer Read/Write Mode Read/Write Conferencing Mic/Line Input, Conferencing Line Output, Sound Reinforcement Mic/Line Input, Sound Reinforcement Phys Chans Line Output, Analog Telephony Input, Analog Telephony...
  • Page 626 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Argument Argument value System Limits Minimum: 1, Maximum: 2000 Default User Limits Supported Event Source Description This parameter sets the amount of time (in milliseconds) it takes the limiter to ramp the gain up to the target gain once the input signal level drops below the limiter threshold.
  • Page 627 Command Protocol Reference Guide Argument Argument value Conferencing Mic/Line Input, Conferencing Line Output, Sound Reinforcement Mic/Line Input, Sound Reinforcement Phys Chans Line Output, Analog Telephony Input, Analog Telephony Output, Submix, ConferenceLink Aux Input, ConferenceLink Aux Output Virt Chans Mono, Stereo System Limits Minimum: 1.0, Maximum: 100.0, Resolution: 0.1 Default...
  • Page 628 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Description This parameter sets the RMS level (in dBFS) of the input signal above which the limiter engages. Enable Peak Limiter dp_peak_en Argument Argument value Channel Type Virtual Channel...
  • Page 629: Algorithm Parameters

    Command Protocol Reference Guide Argument Argument value Default User Limits Supported Event Source Description This parameter sets the RMS level (in dBFS) of the input signal above which the peak limiter engages. The peak limiter will ensure that the peak level never exceeds this threshold.
  • Page 630 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Argument Argument value Virt Chans Mono, Stereo Default Event Source Description This parameter enables (1) or disables (0) the noise fill algorithm in the AEC. AEC Reference aec_ref Argument...
  • Page 631 Command Protocol Reference Guide Enable Automatic Gain Control agc_en Argument Argument value Channel Type Virtual Channel 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.
  • Page 632 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 AGC Minimum Gain agc_min_gain Argument Argument value Channel Type Virtual Channel Value Type Floating-Point Read/Write Mode Read/Write Phys Chans Conferencing Mic/Line Input, Sound Reinforcement Mic/Line Input, Analog Telephony Input...
  • Page 633 Command Protocol Reference Guide Description This parameter sets the amount of delay applied to the audio signal, in sam- ples. 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.
  • Page 634 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Feedback Reduction filter Bandwidth fb_filter_bandwidth Argument Argument value Channel Type Virtual Channel Value Type Floating-Point Read/Write Mode Read/Write Phys Chans Conferencing Mic/Line Input, Sound Reinforcement Mic/Line Input Virt Chans...
  • Page 635 Command Protocol Reference Guide Reset One Of The Feedback Reduction Filters fb_filter_reset Argument Argument value Channel Type Virtual Channel Value Type Void Read/Write Mode Write-Only Phys Chans Conferencing Mic/Line Input, Sound Reinforcement Mic/Line Input Virt Chans Mono, Stereo Indices 1-10 : Filter number Event Source Description Setting this parameter resets the specified filter in the feedback reduction algo-...
  • Page 636 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Safe Mode Attenuation For Feedback Reduction fb_safe_mode_atten Argument Argument value Channel Type Virtual Channel Value Type Floating-Point Read/Write Mode Read/Write Phys Chans Conferencing Mic/Line Input, Sound Reinforcement Mic/Line Input...
  • Page 637 Command Protocol Reference Guide Description This parameter selects the index of the audio source for the corresponding cr_mic_in or sr_mic_in physical channels. The index required for this parame- ter indicates to which physical channel of the virtual channel this parameter will be applied.
  • Page 638 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Argument Argument value Phys Chans Conferencing Mic/Line Input, Sound Reinforcement Mic/Line Input Virt Chans Mono, Stereo Values analog : Analog Mic Input (default) clink_mic : ConferenceLink Mic Input Event Source...
  • Page 639 Command Protocol Reference Guide Noise Cancellation Level nc_level Argument Argument value Channel Type Virtual Channel Value Type Floating-Point Read/Write Mode Read/Write Phys Chans 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...
  • Page 640 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Description This parameter sets the gain of the signal produced by the signal generator, in dB. A gain of 0 dB will produce a signal that has the same RMS level as a sine wave at -20 dBFS (the nominal signal level).
  • Page 641 Command Protocol Reference Guide Argument Argument value Virt Chans Mono continuous : Continuous (default) 1/24 : 1/24 Octave 1/12 : 1/12 Octave Values 1/6 : 1/6 Octave 1/3 : 1/3 Octave 1 : 1 Octave Event Source Description When the signal generator’s sig_gen_type is set to sweep, this parameter sets the step size of the sweep generator.
  • Page 642 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Signal Generator Sweep Time sig_gen_sweep_time Argument Argument value Channel Type Virtual Channel Value Type Integer Read/Write Mode Read/Write Phys Chans Signal Generator Virt Chans Mono System Limits Minimum: 10, Maximum: 60000...
  • Page 643: Input Path Parameters

    Command Protocol Reference Guide Signal Generator Type sig_gen_type Argument Argument value Channel Type Virtual Channel Value Type List Read/Write Mode Read/Write Phys Chans Signal Generator Virt Chans Mono pink : Pink Noise (default) white : White Noise Values tone : Sine Wave sweep : Sine Wave Sweep Event Source Description...
  • Page 644 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Description This parameter selects the version of signal to use for the ungated triune signal of the specified virtual channel. Select Delay for Sound Reinforcement Signal sr_delay_type Argument Argument value...
  • Page 645: Automixer Parameters

    Command Protocol Reference Guide Enable Delay Compensation For Triune Signals ungated_delay_comp_en Argument Argument value 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 Delay compensation only applies to the ungated signal, and only when it is using the line or bypass options.
  • Page 646 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Description 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.
  • Page 647 Command Protocol Reference Guide Description When this parameter is set to 1, the microphone is considered a chairman microphone. Automixer Channel Bias am_chan_bias Argument Argument value Channel Type Virtual Channel Value Type Floating-Point Read/Write Mode Read/Write Phys Chans Conferencing Mic/Line Input, Sound Reinforcement Mic/Line Input Virt Chans Mono, Stereo...
  • Page 648 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Description This parameter defines how long (in ms) the gain of a gated microphone in the specified automixer group takes to transition between fully open and its off attenuation value when it is time for the microphone to gate off.
  • Page 649 Command Protocol Reference Guide Description This parameter selects gain-sharing mode for the specified automixer group when set to 1. Otherwise, the microphones in the automixer group are in gating mode. Examples Command Response Description set am_gain_sharing 2 1 val am_gain_sharing 2 1 Selects the gain sharing automixer for the microphones in automixer group 2.
  • Page 650 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Automixer Hold Time am_hold_time Argument Argument value Channel Type Global Systems Value Type Integer Read/Write Mode Read/Write Indices 1-63 : group number Systems Limits Minimum: 100, Maximum: 10000 Default...
  • Page 651 Command Protocol Reference Guide NOM Limit am_nom_limit Argument Argument value Channel Type Global System Value Type Integer Read/Write Mode Read/Write Indices 1-63 : group number System Limits Minimum: 0, Maximum: 128 Default User Limits Supported Event Source Description This parameter sets the NOM limit for the microphone with respect to its auto- mixer group.
  • Page 652 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Automixer Microphone Priority am_priority Argument Argument value Channel Type Virtual Channel Value Type Integer Read/Write Mode Read/Write Phys Chans Conferencing Mic/Line Input, Sound Reinforcement Mic/Line Input Virt Chans Mono, Stereo...
  • Page 653: Gpio Control Parameters

    Command Protocol Reference Guide Gain Sharing Automixer Slope am_slope Argument Argument value Channel Type Global System Value Type Floating-Point Read/Write Mode Read/Write Indices 1-63 : group number System Limits Minimum: 0.0, Maximum: 10.0, Resolution: 0.1 Default User Limits Supported Event Source Description This parameter defines how much attenuation (in dB) is applied to micro- phones in the specified automixer group when they don't have the highest...
  • Page 654 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Description This parameter gets or sets the value of the analog gpio pin. Writing an input has no effect and returns the current value of the input. The value for this parameter is an integer between analog_gpio_min and analog_gpio_max, inclu- sive.
  • Page 655 Command Protocol Reference Guide Argument Argument value System Limits Minimum: 0, Maximum: 10000 Default User Limits Supported Event Source Description 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.
  • Page 656 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Argument Argument value Phys Chans 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.
  • Page 657: Control Port Parameters

    Command Protocol Reference Guide Control Port Parameters Clink2 Call Active Status clink_call_active Argument Argument value Channel Type Device-Specific System Value Type Boolean Read/Write Mode Read-Only Event Source Description This parameter gets the call active status of an HDX. This is true whenever the HDX has an active video or PSTN call.
  • Page 658 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Clink2 Mute Status clink_mute Argument Argument value Channel Type Device-Specific System Value Type Boolean Read/Write Mode Read/Write Default Event Source Description This parameter gets or sets the mute status of an HDX or HDX Microphone Array attached to the indicated device.
  • Page 659 Command Protocol Reference Guide Ethernet Settings eth_settings Argument Argument value Channel Type Device-Specific System Value Type String Read/Write Mode Read/Write System Limits Max String Length: 256 Default mode=’dhcp’ Event Source Description This parameter gets or sets the Ethernet settings. When this parameter is set, the Ethernet interface is automatically restarted with the new settings.
  • Page 660 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 set eth_settings 1 val eth_settings 1 Sets the ethernet settings on device 1 to dhcp and "mode='dhcp'" "mode='dhcp',addr='172. returns the full ethernet settings. 22.2.129',dns='172.22.1.1 172.22.1.2',gw='172.22.2. 254',nm='255.255.255.0'" set eth_settings 1...
  • Page 661 Command Protocol Reference Guide Key Pressed On IR Remote ir_key_press Argument Argument value Channel Type Virtual Channel Value Type Integer Read/Write Mode Read-Only Phys Chans Infrared Remote Input Virt Chans Control System Limits Minimum: 0, Maximum: 255 Event Source Description When queried, this parameter returns the keycode value of the last key that was pressed on the IR remote.
  • Page 662 This parameter sets the channel ID that the specified IR input will respond to. Polycom HDX IR remotes can be configured to use different channel IDs so that multiple remotes can be used in the same room to control different equip- ment without interfering with each other.
  • Page 663 Command Protocol Reference Guide Examples Command Response Description set ser_baud 1 9600 val ser_baud 1 9600 Sets the serial port baud rate on device 1 (the first device) to 9600. Set RS-232 Control Mode ser_control_mode Argument Argument value Channel Type Device-Specific System Value Type List...
  • Page 664 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 set ser_flow 1 hw val ser_flow 1 hw Sets the serial port flow control on device 1 (the first device) to 'hw'. set ser_flow 1 none val ser_flow 1 none Disables the serial port flow control on device 1 (the first device) by setting the flow control to 'none'.
  • Page 665: System Parameters

    Command Protocol Reference Guide System Parameters Bootloader Version dev_bootloader_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 bootloader version. Firmware Version dev_firmware_ver Argument Argument value Channel Type...
  • Page 666 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Hardware ECO Number dev_hw_eco Argument Argument value Channel Type Device-Specific System Value Type Integer Read/Write Mode Read-Only System Limits Minimum: 0, Maximum: 255 Event Source Description This parameter returns the hardware ECO number for the board. The number does not track the actual ECO number, but rather indicates major ECO changes that we may need to account for in software.
  • Page 667 Command Protocol Reference Guide Description This parameter causes the front panel LED of the specified device to cycle through its colors (yellow-red-green-off) for the specified number of seconds. NTP Server dev_ntp_server Argument Argument value Channel Type Device-Specific System Value Type String Read/Write Mode Read/Write...
  • Page 668 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Internal Temperature dev_temp Argument Argument value Channel Type Device-Specific System Value Type Floating-Point Read/Write Mode Read-Only Indices 1-3 : Temperature sensor index System Limits Minimum: -40.0, Maximum: 125.0, Resolution: 0.1...
  • Page 669 Command Protocol Reference Guide Device Type dev_type Argument Argument value Channel Type Device-Specific System Value Type List Read/Write Mode Read-Only c16 : Conferencing 16x16 c12 : Conferencing 12x12 c8 : Conferencing 8x8 Values sr16 : Sound Reinforcement 16x16 sr12 : Sound Reinforcement 12x12 sr8 : Sound Reinforcement 8x8 Event Source Description...
  • Page 670 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Argument Argument value 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.
  • Page 671 Command Protocol Reference Guide 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 +15 V Supply Voltage dev_volt_pos_15 Argument Argument value Channel Type Device-Specific System Value Type Floating-Point...
  • Page 672 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Description Setting this parameter restores the device to its factory settings, erasing all user data but retaining the current version of firmware. A sys_factory_reset can also be performed by powering up the SoundStruc- ture device with RS-232 pins 8 and 9 shorted together.
  • Page 673 Command Protocol Reference Guide Description This parameter returns the name of the last executed preset (either partial or full preset). Enable/Disable Reporting Of mtrreg/mtrunreg In sys_mtrreg_log_en Logs Argument Argument value Channel Type Global System Value Type Boolean Read/Write Mode Read/Write Default Event Source Description...
  • Page 674 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Argument Argument value Read/Write Mode Write-Only System Limits Minimum: 1, Maximum: 5000 Event Source Description This parameter pauses system execution for the specified number of millisec- onds. Note that the entire command processor is paused, affecting all communication ports.
  • Page 675: Introduction

    Address Book Introduction This chapter describes the SoundStructure Studio address book that can be used to organize and store IP addresses of SoundStructure systems. For SoundStructure systems that are not on the same subnet as the computer running SoundStructure Studio, the address book is a convenient way to store information about SoundStructure systems and provides an easy way to connect to SoundStructure systems.
  • Page 676: Address Book Soundstructure System Entries

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The default address book is empty and will appear as shown in the following figure. There is an item in the left pane called “All Entries” that shows all entries in the address book.
  • Page 677 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. Once the system name has been added, you may either press Tab to go to the IP address field or single left click on the Address field associated with the system name and type in an IP address.
  • Page 678 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 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.
  • Page 679: Address Book Folders

    Address Book 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. Address Book Folders When an organization has multiple SoundStructure systems, it is useful to organize the systems with address book folders.
  • Page 680 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 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.
  • Page 681: Removing Entries From The Address Book

    Address Book Moving systems from one folder to another folder A SoundStructure system may be moved from one folder to another folder by clicking and dragging the system from the source folder to the target folder as shown in the following figure. In this example the system from a source folder was clicked and dragged to move it into the London folder.
  • Page 682: Changing The Location Of The Address Book

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Changing the Location of the Address Book By default the address book is stored on the local computer in a directory that may be found under the Tools -> Options ->Address Book option. The default location on the local drive may be changed by selecting the ‘Specify Location’...
  • Page 683 Designing Audio Conferencing Systems Reprinted from the BICSI AV Design Reference Manual, the following audio conferencing design material is authored by Craig H. Richardson, copyright 2006. The goal of audio conferencing is to enable two geographically separated groups of people, referred to as the local and remote talkers respectively, to communicate as if they are in the same room together with fast interation and allowing both parties to speak and be heard at the same time.
  • Page 684: Large Room Environments

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 The challenge in audio conferencing is that the loudspeaker audio is not only heard by the local participants, but it is also heard by the local microphones and, in the absence of an acoustic echo canceller, will be sent back to the remote participants causing the remote participants to hear a delayed echo of their voice.
  • Page 685: Microphone Selection And Placement

    Designing Audio Conferencing Systems Microphone Selection And Placement The type of microphones used and their location will have the largest impact on the audio conferencing quality. Microphones translate the acoustic signals from the local talkers into electrical signals that can be processed and sent to the remote participants.
  • Page 686 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Directional microphones are most often used in conferencing systems due to the rejection of the background noise, reduction of the reverberation, and the rejection of the audio from the loudspeakers. Directional microphones also...
  • Page 687 Designing Audio Conferencing Systems audio signal. When this happens, a noticeable beeping or chipping sound that sounds modulated such as if it were Morse code, will be heard at the remote locations. If this problem is present, the solutions are to move cellular telephones away from the microphones, turn off cellular telephones, or to use microphones that have improved noise immunity to these high frequencies.
  • Page 688: Microphones For Conferencing

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 moving microphones closer to the talkers, moving noise sources away from the microphones, lowering the level of the noise, and improving the acoustics in the room to reduce the amount of reverberation. Improving the acoustics in...
  • Page 689 Designing Audio Conferencing Systems 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. All participants that are seated at the table are well within the microphones pick-up ranges as shown in the next figure.
  • Page 690 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Wireless Microphones Wireless microphones are also commonly used in conferencing applications, particularly for presenters. The advantage of wireless microphones is that they may be used anywhere within the room (depending on whether in-room...
  • Page 691: Automatic Microphone Mixers

    Designing Audio Conferencing Systems installed. With the use of a microphone amplifier and powered loudspeaker, it is a simple matter to have the customer listen to the audio quality and agree that it is acceptable before additional work is performed. This will save costly re-installation work.
  • Page 692: Noise Cancellation

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 Noise Cancellation 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 then be...
  • Page 693: Acoustic Echo Cancellation

    Designing Audio Conferencing Systems However, if ceiling microphones are swaying due to the air flow from nearby HVAC ducts, noise cancellation may not be able to completely remove that noise. Acoustic Echo Cancellation In audio conferencing applications, acoustic echoes occur because an open-air acoustic path exists between the local loudspeaker and the local microphone.
  • Page 694 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 around. The following figure illustrates the block diagram of an AEC system and shows the adaptive filter at its center. It is common to refer to the signals associated with an echo canceller as follows: the Near In signal consists of the...
  • Page 695: Aec Reference

    Designing Audio Conferencing Systems AEC Reference The AEC reference provides the AEC with the information of what signals it should cancel from the room (see the following figure). The echo canceller reference is usually a combination of audio from the remote sites including telephone and video conferencing audio and also any program audio sources.
  • Page 696: Transmission Delay

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 200 msec for larger rooms. As shown in the following figure, if the room is lively, the length of an echo path may be longer than expected making the room appear acoustically larger than it is physically.
  • Page 697: Echo Return Loss

    Designing Audio Conferencing Systems may occur in the data as it is transmitted through the network. It is not uncommon for networks to require a hundred milliseconds or more to transfer audio from one site to the other. While the delay in the network will increase the perception of echoes, it does not affect the performance of the acoustic echo canceller in either the local or remote rooms.
  • Page 698: Multi Channel Vs. Single Channel Aec

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 would be the ratio of 10 Log (B/C) which, due to the acoustic echo canceller, should be a larger number than the ERL. Typical values for ERLE are 15 - 25...
  • Page 699: Muting Microphones

    Designing Audio Conferencing Systems left side of the following figure), each local talkers' voice will be processed by the same noise reduction algorithm to remove noise regardless of whether that noise was incident on that particular microphone. Similarly with respect to the acoustic echo canceller, it is also better to process the signals independently as each microphone has its own acoustic view of the room and sees an acoustic echo that is different from the other microphones.
  • Page 700: Volume Control

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 If the microphones are muted in the signal chain before the acoustic echo canceller, then while the microphones are muted, the AEC will not be able to adapt as there will be no signal present. Once the microphones are unmuted, the AEC may have to reconverge to any new echo paths.
  • Page 701: Telephone Hybrid

    Designing Audio Conferencing Systems The most common reason for acoustic echo is that the echo return loss of the room is not high enough to allow the acoustic echo canceller to properly adapt to the remote audio. This is usually solved by reviewing the gain structure and turning down the amplifier and bringing up the signals that make up the echo canceller reference.
  • Page 702 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 While side-tone is desirable while talking on a handset, it is not desirable in a conferencing application. As the line echo (or side-tone) is mixed together with the audio from the remote telephone talkers' speech, the line echo will be played into the room over the same loudspeakers in the local room used to hear the remote talkers.
  • Page 703: Amplifiers

    Designing Audio Conferencing Systems Amplifiers There are two broad classes of amplifiers - low impedance and constant voltage. The low impedance amplifiers are the type of amplifier used in consumer applications and the constant voltage amplifiers are used in larger, professionally installed systems.
  • Page 704 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 the following figure, not only are listener 2 and listener 3 farther away from the loudspeaker than listener 1 and receive less audio due to the inverse square relationship, but they also receive less audio from the loudspeaker due to the inherent 6 dB difference between the off-axis response from the on-axis response of the loudspeaker.
  • Page 705: Speaker Zoning And Placement

    Designing Audio Conferencing Systems Another rule of thumb about loudspeaker positioning with listeners is to distribute the loudspeakers no greater than twice the distance from the ceiling to the listener's ear level. In a conference room with 9 foot high ceilings and seated listeners' ears about 3 ½...
  • Page 706 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 following figure. As discussed in an earlier section, the microphones should be placed as close to the local participants as possible to minimize the amount of background noise and reverberation.
  • Page 707: Loudspeakers - How Much Power Is Required

    Designing Audio Conferencing Systems Loudspeakers - How Much Power Is Required Once the locations of the loudspeakers have been determined, the next step is to determine how much power is required to drive each loudspeaker to achieve the required level at the listeners. Loudspeakers have a power rating that is expressed in dB SPL @ 1 meter.
  • Page 708: Microphone And Loudspeaker Placement Considerations

    Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 device, the reinforcement of the ceiling loudspeakers can be delayed slightly (1 msec for each foot of separation) from the front loudspeakers and can be attenuated by approximately 6 - 10 dB from the level sent to the front of room loudspeakers.
  • Page 709 Designing Audio Conferencing Systems intelligibility. If they do, then the system is set correctly. The reinforced levels should never exceed conversational speech levels (approximately 70 dBA SPL typical at the listener's ear) or the result may become unstable, creating residual echoes to the remote listeners due to low ERL and worse may generate very loud acoustic feedback in the room with loudspeaker audio coupling into the local microphones.
  • Page 710 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 the reinforcement system - zones twice as far away will typically have 6 dB more level). To support zoning, a multi-channel amplifier must be used so that each loudspeaker zone can receive separate loudspeaker signals.
  • Page 711 Designing Audio Conferencing Systems In a room that has sound-reinforcement with inappropriately high gain settings, there is no longer any such thing as a "side conversation". Everyone in the room will likely be able to hear all conversations, making it impossible to have side comments that are private.
  • Page 712 Design Guide for the Polycom SoundStructure C16, C12, C8, and SR12 C - 30...

Table of Contents