Epiphan Pearl User Guide

Epiphan Pearl User Guide
User Guide
Epiphan Pearl
Release 3.15.2
July 23, 2015
UG100-009
Terms and Conditions
This document, the Epiphan web site, and the information contained therein, including but not limited to the
text, videos and images as well as Epiphan System Inc.’s trademarks, trade names and logos are the property
of Epiphan Systems Inc. and its affiliates and licensors, and are protected from unauthorized copying and
dissemination by Canadian copyright law, United States copyright law, trademark law, international
conventions and other intellectual property laws.
Epiphan, Epiphan Video, Epiphan Systems, Epiphan Systems Inc., and Epiphan logos are trademarks or
registered trademarks of Epiphan Systems Inc., in certain countries. All Epiphan product names and logos are
trademarks or registered trademarks of Epiphan. All other company and product names and logos may be
trademarks or registered trademarks of their respective owners in certain countries.
Copyright © 2015 Epiphan Systems Inc. All Rights Reserved.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN
THE INFORMATION PACKET OR PRODUCT INSTALLATION SOFTWARE PACKAGE THAT SHIPPED WITH THE
PRODUCT AND ARE INCORPORATED HEREIN BY REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE
LICENSES OR LIMITED WARRANTY, CONTACT YOUR EPIPHAN REPRESENTATIVE FOR A COPY.
PRODUCT DESCRIPTIONS AND SPECIFICATIONS REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT
TO CHANGE WITHOUT NOTICE. EPIPHAN PERIODICALLY ADDS OR UPDATES THE INFORMATION AND
DOCUMENTS ON ITS WEB SITE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION AND
RECOMMENDATIONS ARE BELIEVED TO BE ACCURATE AT TIME OF WRITING BUT ARE PRESENTED WITHOUT
WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR
APPLICATION OF ANY PRODUCTS.
LIMITATION OF LIABILITY
UNDER NO CIRCUMSTANCES SHALL EPIPHAN BE LIABLE FOR ANY INCIDENTAL, SPECIAL, CONSEQUENTIAL,
EXEMPLARY OR OTHER INDIRECT DAMAGES THAT RESULT FROM THE USE OF, OR THE INABILITY TO USE,
THIS PRODUCT OR THE INFORMATION CONTAINED IN THIS DOCUMENT OR PROVIDED ON EPIPHAN’S WEB
SITE, EVEN IF EPIPHAN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. IN NO EVENT SHALL
EPIPHAN’S TOTAL LIABILITY TO YOU FOR ALL DAMAGES, LOSSES, AND CAUSES OF ACTION RESULTING FROM
YOUR USE OF THIS PRODUCT, WHETHER IN CONTRACT, TORT (INCLUDING, BUT NOT LIMITED TO,
NEGLIGENCE) OR OTHERWISE, EXCEED THE AMOUNTS YOU PAID TO EPIPHAN DURING THE MOST RECENT
THREE-MONTH PERIOD IN CONNECTION WITH AMOUNTS WHICH YOU PAID FOR USING THIS PRODUCT.
INFORMATION AND DOCUMENTS, INCLUDING PRODUCT SPECIFICATIONS, PROVIDED IN THIS DOCUMENT
OR THE EPIPHAN WEB SITE ARE PROVIDED “AS IS”. SPECIFICALLY, BUT NOT WITHOUT LIMITATION, EPIPHAN
DOES NOT WARRANT THAT: (i) THE INFORMATION IS CORRECT, ACCURATE, RELIABLE OR COMPLETE; (ii) THE
FUNCTIONS CONTAINED ON THE EPIPHAN WEB SITE WILL BE UNINTERRUPTED OR ERROR-FREE; (iii) DEFECTS
WILL BE CORRECTED, OR (iv) THIS WEB SITE OR THE SERVER(S) THAT MAKES IT AVAILABLE ARE FREE OF
VIRUSES OR OTHER HARMFUL COMPONENTS. EPIPHAN SPECIFICALLY DISCLAIMS ALL REPRESENTATIONS,
WARRANTIES, AND CONDITIONS, EITHER EXPRESS, IMPLIED, STATUTORY, BY USAGE OF TRADE OR
OTHERWISE INCLUDING BUT NOT LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT, TITLE, SATISFACTORY QUALITY OR FITNESS FOR A PARTICULAR PURPOSE.
For additional terms and conditions, please refer to additional sections in this document.
Thank You for Choosing Epiphan!
At Epiphan Video (“Epiphan”), product function and quality are our top priority. We make every effort to make
sure that our products exceed your expectations.
Product Feedback
Your feedback is important! We regularly contact our customers to ensure our products meet your
performance and reliability requirements. We strive to continually enhance our products to accommodate
your needs. Please let us know how you think we can improve our products by emailing your suggestions to
[email protected]
Specifications
Go to the Recording and Streaming Systems page of the Epiphan website to get the most recent product
specifications and additional information about Epiphan Pearl.
Warranty
All Epiphan Systems products are provided with a 100% return to depot warranty for one year from the date
of purchase.
Technical Support
Epiphan’s products are backed by our professional support team. If you are having issues with your product,
please gather details about your system and contact our team by:
l Emailing [email protected]
l Live chat via the link on our support site http://www.epiphan.com/support/
l Phone toll free at 1-877-599-6581 or call +1-613-599-6581
Be sure to include as much information about your problem as possible. Including:
l Problem description
l Details of the video or audio source (type, connection, resolution, refresh rate, etc.)
l Product serial number
l Product firmware version (if applicable, from web admin interface)
Copyright © 2015 Epiphan Systems Inc. All Rights Reserved.
What's New in Release 3.15.2?
Firmware release 3.15.2 is a maintenance release with bug fixes and improvements to the way Pearl's web
interface works.
Visual layout editor
Layout items can be re-ordered
Release 3.15.1 introduced the visual layout editor with video sources, images and text items added to layouts.
Starting with release 3.15.2, layout items can now be re-ordered so you are free to add items in any order and
drag and drop them above or below one another.
Finer position control
You can now use the keyboard arrow keys to nudge layout items into position. See the note on positioning
items in Add an image (custom channel)Add a video source (custom channel)
Remote control
Video switching via RS-232 and HTTP APIs
The HTTP and RS-232 APIs are augmented to allow remote control over which layout is the currently active
layout in a channel. See Third party integration for details.
Firmware update to 3.15.2
If you have already updated to firmware release 3.15.1, there are no special firmware update instructions to
follow.
For systems with firmware release 3.14.4 or older, read these special notes.
Firmware release 3.15.1 introduced the terrific new visual channel layout editor which adds the ability to have
multiple layouts per channel and simplifies custom channel components like text overlays, images, and picture
in picture layouts.
The firmware update process preserves your channel's encoding, streaming and recording settings, merges
your previous visual channel setup in out a new channel layout. We have tested this process carefully, but in
some circumstances you may still need to do some small manual adjustments to get the best possible results.
Before you do a firmware update, take notes or a snapshot of your channel's layout. It is also a good idea
to note your current release version make a configuration backup for the rare case you choose to return to
your current release. After the firmware update, go to the sources page for your channel and review the
created layout for your channel. If needed, make adjustments using the procedures described in Create a
custom channel.
Please note these other two important changes:
1. No signal images are not supported in 3.15.1 and 3.15.2. If they are present during the firmware
upgrade process, they are propagated forward, but there is no way to edit or modify the no signal
image through the channel layout editor. To delete the no signal image you must delete the layout and
recreate it.
2. The text overlay channel name shortcut (%c symbol) is not supported in 3.15.1 or 3.15.2. To work
around this issue, manually enter your channel's name in the text overlay box (in the channel layout
editor) instead of using the %c symbol.
Limitations and known issues
This section includes known issues or limitations that affect functionality or usability and ways that you can
work around these limitations.
Affecting encoding
l Limitation: When Pearl is overloaded, video frames or audio samples can be dropped causing variable
frame rate and audio cracks.
Workaround: Pearl is a powerful system capable of many simultaneous tasks, but like any other
computing device, it has finite resources. If this problem is observed, check the CPU load from your
system's Info page. To reduce system load, delete unused channels and unused layouts, or reduce the
complexity of layouts by scaling at the source instead of having the system scale, or reduce the number
of sources in layouts.
l Limitation: When audio is enabled on an SDI source where video is already being captured, it takes up
to 15 seconds for the system to detect the audio. Once detected, the audio is properly synchronized
with the video.
Workaround: Start the SDI signal with audio enabled, or check to ensure audio is detected before
streaming or recording.
l Auto sources (Auto-A and Auto-B) do not have an audio source in firmware release 3.15.2.
Workaround: Add your desired audio source to your channel's layout using the layout editor on the
channel's Sources page.
l Encoding with MPEG-4 sometimes results in poor quality.
Workaround: From the channel's stream setup, increase the video bitrate to improve picture quality.
l Video bitrate for MJPEG streams is larger than the configured value.
Workaround: Verify the actual bitrate on the channel's channel status page when there are connected
viewers. If lower bitrates are important, select another codec.
l For VGA sources only, some wide-mode resolutions are not correctly identified and result in a slightly
squished image (e.g. for a 1360x768 source, the detected resolution may be 1024x768).
Workaround: This issue is related to the video output hardware. Test your source to see if it exhibits
the issue. If possible, avoid using wide-mode for VGA displays that exhibit this issue.
l Some cameras are sensitive to EDIDs and are not captured at optimal settings. When capturing from
these cameras, the HD signal may be down-sampled by the camera to an SD signal because the
Epiphan system doesn't share the EDID the camera expects for its HD signal.
Workaround: Contact Epiphan customer support for a custom EDID to resolve this issue.
l Encoding video at 60 fps with either 16 mHz or 22 mHz AAC audio can result in some dropped video
frames.
Workaround: Select another video frame rate, a different audio sampling rate, or choose MP3 audio.
l The automatically calculated frame size for HD VGA sources is occasionally incorrect.
Workaround: This problem is caused due to cable degradation or poor cable connection. Re-seat or
exchange your VGA cable. If the problem is still not resolved, visit the Epiphan Pearl support page for a
custom EDID to resolve the issue.
Affecting streaming and recording
l Output from the Auto-A and Auto-B sources (in the auto channels or in channels using these inputs on
a layout) can sometimes flicker to another source plugged into the same row (e.g. from HDMI-A to
VGA-A and back to HDMI-A).
Workaround: Use specific sources in your layouts, or keep only one item plugged into row A and one
item plugged into row B.
l When switching layouts while streaming or recording it's possible to have a small number of frames
(approximately 100ms worth) repeated in the stream or recording file, and over the same time period a
small number of frames from the new layout skipped.
Workaround: If dropped frames are problematic for your application, avoid the layout switching
feature.
l CPU is under high load when rotating a source through the sources configuration menu.
Workaround: If possible, manually or programatically rotate the source image (e.g. rotate the camera
or use the source's software settings) instead of rotating via the streaming system's configuration
pages.
l If the hard drive runs out of space when recording a video, recording may fail.
Workaround: Use Automatic File Upload to configure your system to automatically offload and erase
recordings as they are made. See File and recording transfer for more details.
Affecting the web interface
l It is possible to name two or more channels with the same value. Use of automatic file transfer and
UPnP is unpredictable if this occurs.
Workaround: Ensure each channel has a unique name.
l The automatic file upload (AFU) file queue shows a maximum of 15 files, Newer 15 and Top of the list
buttons do not work. All files are transfered, even though they are not lists.
Workaround: Wait for the queue to have fewer files in the list.
Affecting other areas
l Pearl fails to restart after improper shutdown (power cable removed or rapid power cycle). LED and
touch screen blink.
Workaround: Restart Pearl by removing the power cable for 20 seconds, then reattaching the cable
and powering the system back on.
l Due to changes in the way channel layouts are created, some HTTP and RS-232 remote layout
commands no longer available 3.15.1 and 3.15.2. These include values for setting the text overlay,
logo, logo positioning, keep aspect ratio and no signal image.
Workaround: Update your scripts to avoid using these commands. See the manual for a full list,
affected API keys are listed as deprecated.
l Custom No Signal images are not available in 3.15.2.
Workaround: If possible in your application, use layouts to create a full-screen image that depicts the
desired no signal message and switch to the live feed when it comes online. Otherwise, use the default
no signal image.
l Text overlays in 3.15.2 do not support the %c variable to show the channel name.
Workaround: If channel name is desired in the text overlay, type in the name manually into text
overlay box in the layout editor.
l When using Internet Explorer to view the web admin interface, cached versions of pages can be
displayed instead of the most recent version of a page. This affects the Sources configuration page
most and may cause the user to think a new layout or changed layout has gone missing.
Workaround: Refresh the page by pressing Ctrl-F5.
Table Of Contents
Thank You for Choosing Epiphan!
iii
Firmware update to 3.15.2
iv
Limitations and known issues
v
Table Of Contents
Start here
viii
1
About this Guide
1
What is Pearl?
3
AV inputs
3
What's in the Box?
4
Front and back view
5
Tech specs
7
Quick start
What’s Next?
PART 1: Setup
The admin interface
11
16
17
18
Connect to the admin interface
18
User administration
23
Pearl's touch screen
36
Touchscreen overview
36
View system information
38
Channel monitoring
40
Pearl's audio jack
42
Control recording
43
Configure the touch screen
45
View system information
52
Configure network settings
53
Verify IP Address and MAC address via the touch screen
53
Verify IP Address and MAC address via the web interface
54
Configure DHCP
55
viii
Configure a static IP address
57
Tether to a mobile network
60
Perform network diagnostics
62
Configuration presets
64
Configuration presets overview
64
Configuration groups
67
Create a configuration preset
68
Apply a configuration preset from the web interface
69
Apply a configuration preset using the touch screen
71
Apply the Factory default configuration preset
74
Update a configuration preset
75
Delete a configuration preset
76
Configuration preset considerations
77
Configure date and time
82
Verify date and time via the touch screen
82
Verify date and time settings
83
Configure synchronized time (NTP, PTP v1, and RDATE)
84
Configure the date and time manually
85
Change the time zone
86
Configure a Local NTP Server
86
PART 2: Capture
What is a channel?
87
88
Use the automatic channels Auto A and Auto B
89
Create a simple channel
92
Create a custom channel
95
Configure encoding
124
Add channel metadata
134
Preview a channel
135
Preview all channels at once
137
Rename a channel
138
ix
Delete a channel
138
Live video mixing / switching
140
What is a source?
144
Connect a source
145
Preview a source
146
Configure a source
146
Rename a source
150
Control audio volume
151
Confirm audio levels (via the touch screen)
152
Troubleshoot capture
153
Remove black bars (matte) from the video
153
Force the capture card to use a specific EDID
156
Unstretch the output video
159
Video not centered (VGA sources only)
160
Remove the combing effect on images
161
Video looks squished (VGA sources only)
162
Video too bright, too dark or washed out (VGA sources only)
163
PART 3: Stream
What is streaming?
165
166
Choose a streaming option
166
Supported streaming formats
167
Stream to viewers
168
Stream content using HTTP or RTSP
168
Configure HTTP and RTSP streaming ports
170
Stream content using HLS (HTTP Live Streaming)
171
Send stream URLs to viewers
172
View the Flash stream
173
Viewing with a web browser
176
Viewing with a media player (RTSP)
177
Disable (and enable) streams for viewers
178
Restrict access to streams for viewers
179
x
Restrict viewers by IP address
181
IP Restriction Examples
182
Stream to a server
185
Stream to a CDN
187
Stream content using multicast
198
Stream to a media player
203
Stream content using multicast
203
Stream content using UPnP
210
Samples of stream settings
217
Streaming video content
217
Streaming slide content
218
PART 4: Record
219
What is a recording?
220
Recording basics
220
Record a channel via the web interface
221
Record a channel via the touch screen
223
Configure recording file size
225
Restart recording
227
Recorders
228
Add a recorder
228
Change the channels recorded by a recorder
229
Record with a recorder
230
Rename recorded files
232
Delete recorded files manually
232
Recorded files
235
View list of recorded files
235
Download recorded files manually
236
Extract tracks from a recording
237
Rename recorded files
239
Delete recorded files manually
239
File and recording transfer
241
xi
Automatic file upload (AFU) overview
241
Choose files to include in AFU
242
Enable and set timing for AFU
243
AFU to an FTP server
246
AFU using RSync
247
AFU using CIFS
249
AFU to a secure FTP server
250
AFU using SCP
252
AFU or copy to USB drive
254
View the AFU log
261
Manage the AFU queue
261
Local FTP server
264
Configure the local FTP server
264
Using the local FTP Server
266
PART 5: Maintenance
Mobile / tablet operator interface
268
269
Connect to the tablet interface
269
Confidence monitoring using the tablet interface
271
Verify disk space via the tablet interface
273
Control recording via the tablet interface
273
Switch to the full admin interface
274
Power down and system restart
275
Restarting the device via the web interface
275
Shutting down the Device via the Web Interface
276
Shutting down the device manually
276
Save and restore device configuration
277
Save device configuration
277
Load a saved device configuration
278
Perform factory reset
Restore factory configuration via the web interface
Firmware upgrade
280
280
282
xii
Check for Firmware Updates
282
Install firmware
283
Support
287
Download logs and "allinfo"
287
Configure remote support
289
Disable Remote Support
290
Storage disk maintenance
292
Check disk storage space
292
Check disk storage space via the touch screen
293
Schedule disk check
293
Perform disk check
294
Third party integration
295
Control with RS-232 / serial port
296
Control with HTTP commands
302
Configuration keys for third party APIs
306
Troubleshooting
319
Releases and Features
321
Software and Documentation License
323
xiii
Pearl User Guide
Start here
Start here
Welcome, and thank you for buying Epiphan’s Pearl™. This guide will help you configure your new system.
To get started, review the What is Pearl? and What's in the Box? sections. Next, a Quick start guide walks you
through the basic steps to get a single video (and optional audio) source configured as a streamable,
recordable output from Pearl.
Following the quick start section, a set of task-based procedures help you to tweak the system exactly how
you want it. These procedures are broken into five categories: Setup, Capture, Stream, Record and
Maintenance.
About this Guide
Warnings are depicted as follows.
This is a warning.
Tips and Notes are depicted as follows.
This is a tip.
1
Pearl User Guide
About this Guide
Throughout this guide there are situations where more than one solution will complete a task. In those cases
the guide describes the simplest or most common variation first.
2
Pearl User Guide
What is Pearl?
What is Pearl?
Pearl is a small, silent, portable live video production switcher. It supports live video streaming and recording,
capturing and streaming audio and HD video sources with resolutions up to 2048×2048. Using Pearl, you can
capture, record and stream computer monitors, radar displays, or anything that outputs to SDI, HDMI, DVI-I (single link), VGA or component. Accompanying audio is supported via SDI, HDMI and TRS.
Simultaneously capture four audio visual sources and choose how you want to record and stream them. Keep
them separate, configure them in multi-source layouts for live switching, or do both!
The resulting streams can be viewed a number of ways through media players, browsers, on mobile devices
and through Content Distribution Networks (CDNs). Recorded files can be downloaded via FTP or set to
automatically upload via FTP, RSYNC, or CIFS and can be integrated into your Content Management System
(CMS).
Pearl does not capture from HDCP encrypted sources.
AV inputs
Pearl supports the following AV inputs directly. Nearly every other AV input is supported provided you have
the correct converter or adapter.
When using Pearl it is recommended you use a maximum of four simultaneous input sources.
3
Pearl User Guide
What's in the Box?
Table 1 Inputs for Pearl
HDMI SDI SDI
Audio
(Linear PCM)
2
HDMI™ /
Audio
DVI-I (single link)
(Linear
ü
Left/Right TRS
VGA
PCM)
2
ü
Audio
(Balanced or
Unbalanced)
2
2
* Pearl only captures video and audio from HDMI sources if the content is not HDCP-protected.
What's in the Box?
Pearl is a compact, portable system weighing only 3.4 lbs ( 1.54 kg) and measuring 187 mm (D) × 270 mm (W)
× 82 mm (H) (7.4” × 10.6” × 3.25”).
Pearl is shipped in a hard shell case that you can re-use for storing or moving Pearl between jobs.
Inside the hard shell case, under the foam tray you'll find the power cable and the following items:
1. One SDI cable
2. One HDMI cable
3. One VGA cable
4. One DVI (male) to HDMI (female) adapter
5. One Ethernet cable
4
Pearl User Guide
Front and back view
Table 2 Description of Included Cables (images for identification only, color and appearance may vary)
Image
Name
SDI cable
HDMI cable
Description
Connects SDI sources to Pearl's SDI
ports.
Connects HDMI or DVI sources to
Pearl's HDMI ports.
Connects VGA (or Component, if used
VGA Cable
with a converter) signals to Pearl's VGA
ports.
Connects DVI sources to Pearl. Connect
the adapter to the output on your
DVI (male) to HDMI (female)
screen or device, then connect the
adapter
provided HDMI cable to the adapter
and one of the HDMI ports on Pearl's
back panel.
RJ-45 Ethernet cable
Connects the system to your network.
Front and back view
Pearl's front panel has the power indicator light, audio monitor jack and touch screen display for confidence
monitoring and simple configuration. The rear has an array of familiar computer connections. See below for a
complete listing of Pearl's physical features.
5
Pearl User Guide
Front and back view
Table 3 Pearl Front and Back Panel Descriptions
Label Name
Description
Touch screen front panel
Used for confidence monitoring and simple configuration such as
display
obtaining system information and starting/stopping recordings.
3.5 mm audio jack
Power light
Power Button
Power jack
For audio confidence monitoring. Plays the audio for the currently visible channel
Glows when the system is powered on.
Press to turn on; press and release to initiate a graceful system shutdown.
The power supply is plugged in here. The port requires a 19 V centerpositive DC power source. Alway use the provided power supply.
6
Pearl User Guide
Tech specs
Label Name
Description
For connection of external hard drives, flash drives, or control inter-
USB 2.0 Ports
faces.
RJ-45 Ethernet
Auto-sensing gigabit Ethernet 10/100/1000 Base-T network port.
SDI in
Connects SDI signals to Pearl.
VGA in
Connects VGA and other analog video signals to Pearl.
HDMI in
Connects HDMI and DVI signals to Pearl.
TRS Audio in
Connects balanced or unbalanced (line) left/right TRS audio to Pearl.
Allows Pearl to be locked to a desk or surface using a laptop lock
Lock
cable.
Row A/B designators
This manual and Pearl's web admin interface refer to row A and row B.
Ports above the line are part of row A, ports below form row B.
Tech specs
This table outlines the technical specifications for Pearl. Go to www.epiphan.com/pearl to get the most recent
product specifications and additional information about Pearl.
Table 4 Specifications for Pearl
(2) SDI
Connectors
(2) HDMI™ / DVI¹
(2) VGA / Component²
Video Inputs
Resolutions
VESA modes: 640×480 to 2048×2048 (or 2650×1600);
Custom HDMI/VGA/DVI/SDI modes up to 1920x1200
3G-SDI; HD-SDI; SD-SDI;
HD Video Format
Options
DVI single link;
HDMI;
R, G, B plus separate HSync and VSync signals;
R, G, B plus CSYNC signal;
7
Pearl User Guide
Tech specs
R, G, B with Sync-on-Green synchronization
(2) ¼" left/right TRS audio (balanced; or line/unbalanced)
Audio Input
Connectors
SDI audio
HDMI audio
Connectors
(2) Displayport (software selectable content)*
(to be implemented in a future release)
Video Output
Built-In Display
Audio Output
Built-in Display
3.5 mm audio
Front touch screen display used for system information,
confidence monitoring and recording control
Front-mounted jack for confidence monitoring
Front touch screen display for live switching, confidence monitoring, quick configuration, system information and recording control
Video Codecs
H.264, MPEG-4, Motion JPEG
Video Bit Rates
100 - 9,999 kbit/sec
Key Frame Intervals
Programmable
Color Resolution
4:2:0
Output Frame Size
Configurable up to 3840x2160
Video Encoding
60 fps at 1920×1080 capturing and streaming 2 sources
Frame Rates
simultaneously
(per output stream)
30 fps at 1920×1080 capturing and streaming 4 sources
simultaneously
Audio Encoding
Encoder
Bitrate
Sample Frequencies
MP3
64-192 kbps
22 kHz, 44 kHz, 48 kHz
PCM
-
22 kHz, 44 kHz, 48 kHz
AAC
64-192 kbps
16 kHz, 22 kHz, 44 kHz, 48 kHz
Audio Codecs
8
Pearl User Guide
Tech specs
Connector
10/100/1000 Ethernet RJ45
Streams
MPEG-TS, FLV, ASF and MJPEG
RTSP over TCP/UDP
Publish to Streaming Server / CDN (RTSP, RTMP)
IP Network Interfaces
Multicast Streams
Network Discovery /
Announce
HLS - Native Apple HTTP stream for iPad, iPhone and iPod
Touch
RTP, MPEG-TS & RTP and MPEG-TS over UDP
UPnP, SAP
1 TB³
Internal Storage
Automatically removes oldest recordings from internal
storage as space is required.
File maintenance through admin interface (Web UI)
Video / Audio Recording
Local Storage
and File Management
Network Storage
Playback and Recorded Formats
Automatic or manual copy to local USB drives via the (2)
USB 2.0 ports
FTP server and FTP client capabilities (automatic and
manual)
Download recorded videos (AVI, MOV, MP4or MPEG-TS)
using the Web UI and playback through any compatible
player.
Web UI for full administration. On-screen display and mobile UI for confidence
monitoring and simple administration.
Administration
Multiple user accounts/passwords.
Included API for integration into existing environments (executed via HTTP or
RS-232). RS-232 API integration requires a USB to RS-232 adapter (not
included).
Time Synchronization
NTP, TIME (RFC 868), PTP v1 (IEEE-1588-2002 V1)
Product Dimensions
10⅝" x 3¼" x 7⅜" (270mm x 82mm x 187mm)
Product Weight
3.4 lbs (1.54kg)
9
Pearl User Guide
Country of Origin
Tech specs
Made in North America (Canada)
¹Using HDMI port, with the supplied adapter
²Requires component to VGA adapter (not included)
³The Internal 1TB HDD provides approximately 900GB of space for recording. Recording space can be
virtually unlimited with the use of networked storage.
10
Pearl User Guide
Quick start
Quick start
This section helps you get up and running quickly with your Pearl.
Before you get started, make sure you have:
l a video source (i.e. a camera, a computer, a tablet, or a phone) (for SDI and HDMI, the source must not
be HDCP protected)
l for SDI or HDMI sources, accompanying audio over the same source cable
l the appropriate cables or adapters to convert the output to SDI, HDMI or VGA (if needed)
l optionally, a separate TRS audio source such as a microphone
l ideally, a network with Dynamic Host Configuration Protocol (DHCP)
l a computer with a web browser connected to the same network (this is referred to as the “admin”
computer in the steps below)
These instructions include steps for setting up and configuring audio. Skip these optional steps if
you do not want to configure an audio source at this time.
Pearl is pre-configured with two plug and play channels: Auto A and Auto B. This quick start uses these
channels to get you streaming and recording as soon as possible.
Get started quickly with auto channels:
1. Turn on your HD source and connect the output cable to a port in Row A on the back of Pearl (if
needed, use an adapter such as the DVI to HDMI adapter).
2. If desired, plug a second source into one of the Row B inputs on the back of the system.
3. (optional) Attach a set of left/right TRS audio cables from your audio source to the TRS audio input
ports on the back of Pearl.
4. Connect the Ethernet cable to the Pearl. Connect the Ethernet cable to your network.
5. Attach the power cable to the system and plug it into a power source.
6. Press the power button on the back panel to turn on the system.
7. Wait for the Pearl to complete the power up sequence. The system is ready a few moments after the
power LED illuminates.
8. (optional) Plug speakers or headphones into the 3.5 mm audio jack at the front of Pearl.
The system automatically configures the channel's frame size to match the source resolution and calculates
the best bit rate for the default frame rate of 30 fps.
11
Pearl User Guide
Quick start
Pearl's front screen, if enabled (it is enabled by default, see Configure the touch screen), updates to show you
previews of your channel(s) for confidence monitoring. Use your speakers or headphones to verify audio
quality and levels.
In release 3.15.1 your channel will not automatically have audio. Audio is added in the following
steps.
To view the auto channels:
If you don't want to add audio to your channel, you're done with configuration!
You can start viewing the channel(s) immediately by using a browser on a computer on the same network.
1. Find the system’s IP address: from a single channel view or grid view, touch the system settings (gear)
button then touch System Status.
2. Open a browser window on a computer on the same LAN or network
3. Browse to one of the following URLs:
For Auto A: http://<IP Address for Pearl>/preview.cgi?channel=1
For Auto B: http://<IP Address for Pearl>/preview.cgi?channel=2
For example:http://192.168.0.183/preview.cgi?channel=2
12
Pearl User Guide
Quick start
You'll find alternate connection streams (i.e. RTSP or MPEG-TS) for these channels by logging into the admin
interface and accessing Auto A and Auto B by the links under the Channels menu. See What is streaming?
Configure audio
Pearl is managed from a web interface. This interface acts as a configuration utility and system monitor.
You can access the web interface via either the device's IP address on your network, via DNS-based discovery
if you have Bonjour services installed, or via a static recovery IP address. This quickstart uses the IP address
method. You can follow other discovery methods described in the section Connect to the admin interface.
Connect to the admin interface:
1. Find the system’s IP Address:
l from a single channel view or grid view, touch the system settings (gear) icon then touch
System Status; or
l if your system doesn't have any channels showing, touch the screen anywhere to move to the
system settings screen then touch System Status.
2. Type the following string into the address bar of your web browser on your admin computer (where <ip
address> is the ip address of your Pearl):
http://<IP address of Pearl>/admin
For example: http://192.168.0.183/admin
3. Enter the user name and password then click OK. The administrative user is ‘admin’. Initially no
password is set. To set a password follow the procedure outlined in User administration.
13
Pearl User Guide
Quick start
Add audio to the channel's sources list
Channels expose your sources to your streaming users and prepare the sources for recording. Your auto
channel already has the video source added - you need only add the audio source of your choice.
To add audio to your channel:
1. In the web interface, click the Auto A channel; the channel expands.
2. Click Sources; the sources configuration page opens.
3. You're automatically editing the Default layout in the channel layout editor. The Auto-A source is
previewed in the layout area.
4. Scroll down and choose an audio source from the displayed list.
5. Scroll down and click Save at the bottom right of the screen to save your changes.
6. Click Status for your channel.
7. Notice the Stream Info section has an item named Video that reflects your channel's settings (the
frame rate is specified as <resolution size>@30 for 30 frames per second). It also provides an indication
of the current actual frame rate.
14
Pearl User Guide
Quick start
Record the Channel
The channel is set up and streaming. This may be all you need, but if you like, you can also record the stream.
You can choose to initiate and control channel recording from either the touch screen or the web interface.
To control recording from the touch screen:
1. If viewing the grid view, touch the channel for which you wish to control recording; the channel view is
displayed.
2. If necessary, touch the screen once to display the controls for the channel.
3. Touch the recording control button; the touch screen will start a timer to indicate the length of the
recording. Touch the control again to stop recording. (If the button is not visible, recording control via
the touch screen is not enabled; see Configure the touch screen.)
To control recording from the web interface:
1. From the web interface, scroll to the Channels section.
2. Click Recording for your channel; the Recording page is displayed.
3. Click the red Start button; the text at the top of the screen changes to indicate the recording is
starting, then indicates the length of time since the recording started.
4. Click the black Stop button; the recorder stops.
15
Pearl User Guide
What’s Next?
5. Refresh the page by clicking Recording again; the page reloads and a file list appears that shows your
newly recorded stream snippet.
6. Click the file name to download and view your recording.
What’s Next?
Now that you have a source setup and ready to stream, you can fine-tune the system to your exact
requirements. You can look at topics such as:
l Create a simple channel
l Create a custom channel
l Live video mixing / switching
l What is streaming?
l File and recording transfer
l User administration
When you have completed system tuning, make sure to back up the system configuration using the
procedure described in:
l Save and restore device configuration
Refer to the table of contents for a complete list of the topics covered.
16
PART 1: Setup
If you followed through the quick start guide, you already have a basic configuration and possibly a recording
of an input. Before you tweak the channel or configure more, this part of the manual helps you to get your
Pearl properly configured for your network.
Topics covered:
l Connect to the admin interface
l Configure the touch screen
l User administration
l View system information
l Configure network settings
l Configure date and time
l Configuration presets
l Restrict viewers by IP address
17
Pearl User Guide
The admin interface
The admin interface
Pearl is managed from a web interface. This means to perform administrative tasks with Pearl you use an
internet browser on a PC (or laptop, or tablet) connected to the same local Ethernet network.
Connect to the admin interface
If you know the IP address of the system you may type it into the address bar of your web browser.
http://<IP Address of Pearl>/admin
However if this is the first time you access your system, you likely don't know the IP address, so you can use
one of the following connection methods:
For networks with DHCP use one of the following procedures:
l Connect using the touch screen
l Connect via DNS-based service discovery
l Connect via the Epiphan discovery utility
For networks without DHCP, use the following procedure:
l Connect via persistent static IP address
You can also connect to a reduced Operator tablet interface. See Connect to the tablet
interface.
Connect using the touch screen
To connect to the web admin interface, you need to know your Pearl's IP address. There are a number of ways
to determine the IP addreds, but the simplest way is to use the touch screen, if it is enabled.
To connect to the web admin interface using the touch screen to determine the IP address:
1. Obtain the IP address using the touch screen:
l from a single channel view or grid view, touch the system settings (gears) button then touch
System Status; or
l if your system doesn't have any channels showing, touch the screen anywhere to move to the
system settings screen then touch System Status.
18
Pearl User Guide
Connect to the admin interface
2. Type the following string into the address bar of your web browser on your admin computer (where <ip
address> is the ip address of your Pearl)
http://<ip address>/admin
For example: http://192.168.1.163/admin
3. Enter the user name and password then click OK. The administrative user is ‘admin’. Initially no
password is set. To set a password follow the procedure outlined in User administration.
Connect via DNS-based service discovery
Pearl uses DNS-based messages to advertise details about itself, including its host name. With a compatible
utility installed on your computer, you can access the system simply by typing its serial number and the suffix
“.local” into the address bar of your browser.
To ensure you have compatible software, refer to the following table.
Table 5 Installing Bonjour Print Services
System
Action Needed
You must install Bonjour Print Services:
1. Use the following URL - http://support.apple.com/kb/DL999
Microsoft Windows
2. Click Download.
3. Follow the system prompts to download and install the application.
19
Pearl User Guide
System
Connect to the admin interface
Action Needed
The Bonjour software used for service discovery is built into the Mac OS. No special
Mac OS X
actions are needed.
The Avahi implementation used for DNS-based discovery is shipped with most Linux
Linux
distributions. If necessary, check with your administrator to ensure you have the
Avahi package installed.
To access Pearl's web interface via DNS service discovery:
1. Find the system’s serial number. It is printed on a sticker on the back of the system, or available on the
system information display on the touch screen. To access the serial number:
l from the "no channels" screen, touch the screen anywhere to move to the system information
screen;
l from a single channel view, touch the system information button; or
l from the grid view, select a channel, then touch the system information button.
2. Type the following string into the address bar of your web browser on your admin computer (where
<serial> is the serial number of your Pearl):
http://<serial>.local/admin
For example: http://95dd40d5.local/admin
3. Enter the user name and password then click OK. The administrative user is ‘admin’. Initially no
password is set. To set a password follow the procedure outlined in User administration.
20
Pearl User Guide
Connect to the admin interface
4. Optionally, navigate to the Network link under the Configuration heading and note the IP address of
the system.
Connect via the Epiphan discovery utility
Epiphan provides a utility for discovering Epiphan systems on your network. The Epiphan network discovery
utility is a 32-bit Windows executable that works on most 32-bit and 64-bit Windows operating systems.
Download and install the utility via this link: http://www.epiphan.com/downloads/NetworkDiscovery.exe.
To access the Pearl's web interface via the Epiphan discovery utility:
1. Launch the discovery utility.
2. Click Search to find all the Epiphan systems on the network; a list similar to the following appears.
3. If more than one system appears, select the one you wish to configure by matching the serial number
listed with the serial number marked on the back of the system.
4. Optionally, note the IP Address shown in the stream properties. Use this for quicker access to the
system on future configuration sessions.
5. Click the Web config button; your browser will open and point to the web interface page.
http://<IP Address for Pearl>/admin
21
Pearl User Guide
Connect to the admin interface
6. Enter the user name and password then click OK. The administrative user is ‘admin’. Initially no
password is set. To set a password follow the procedure outlined in User administration.
Connect via persistent static IP address
Your Pearl has a default persistent static IP address, also known as the recovery IP address. If ever you need
to set it up on a network that does not support DHCP, or you need to recover from a previous static IP
address setting, you can use this method to connect directly to the system for configuration.
To perform this procedure you will need a workstation computer for which you are able to modify network
settings.
Pearl is pre-configured with the following static address defaults:
l IP Address:
192.168.255.250
l Netmask:
255.255.255.252
l Username:
admin
l Password:
your admin password (by default set to no password)
To access Pearl's web interface via the persistent static IP address:
1. Establish an Ethernet connection between Pearl and the workstation by one of the following methods:
a. Connect the system to a local Ethernet network shared with the workstation.
b. Connect the system directly to the workstation’s Ethernet port using either a regular or a
crossover Ethernet cable.
2. Record the network settings of the workstation being used to connect to Pearl so that they can be
restored later.
3. Temporarily change the network configuration on the workstation to the following:
a. Use Static IP assignment
b. IP address: 192.168.255.249
c. Subnet mask: 255.255.255.252
22
Pearl User Guide
User administration
4. Start a web browser on the workstation and browse to: http://192.168.255.250/admin/
5. Log in as the administrator user with the user name admin and the admin password (by default there is
no password); the web interface page opens.
6. Click the Networking link in the Configuration menu.
7. Select the radio button to use a static address and configure the system with a static IP address and
network settings relevant to the network being used. For specific details about the settings presented,
see Configure network settings.
8. Restore the previously saved network configurations on the workstation.
User administration
Pearl has three configured users:
l admin
l operator
l viewer
By default, none of these users have passwords. For security purposes you should add passwords to the
admin and operator accounts.
This section describes the following user administration topics:
l User types and privileges
l Set or change user passwords
l Remove user passwords
l Overcome lost passwords
l Configure LDAP
l Change the logged-in user
l Restrict viewers by IP address
User types and privileges
Pearl's three user accounts are admin, operator and viewer. The user account names cannot be changed and
the accounts cannot be disabled. By default, none of the accounts have passwords.
Admin
The admin account is the main operator used for all system configuration. This user has access to all options
in the web interface.
23
Pearl User Guide
User administration
Operator
The operator account is a subclass of the admin account. The operator can log in and view all configuration
items but may only make changes to a small number of options. This account is intended for an operator to
start and stop recordings, download recordings, or perform network diagnostics.
Viewer
The viewer account is for all end-users who are permitted to view the streamed channels. By default, when
there is no password, users are not prompted for a username and password when viewing a channel. The
viewer username and password prompt appears only when there is a viewer password set.
In addition to the global viewer account, each channel can set a viewer password that overrides the global
value. See What is streaming?.
Current User
When logged in to the web interface, the current username is displayed at the top right corner of the screen.
User Privileges
The following table outlines the privileges for each user:
Table 6 User Privileges in the Web Interface
Action or Menu Option
View channel output
viewer
operator
admin
ü
ü
ü
ü
ü
Channel Operations
View Channel Configuration
Rename a Channel
ü
Configure Stream Channel
ü
Configure Stream Sources
ü
Publish a Stream
ü
Configure Branding for a Channel
ü
Start the Stream Recorder
ü
ü
24
Pearl User Guide
User administration
Action or Menu Option
viewer
operator
admin
Stop the Stream Recorder
ü
ü
View Recorded Files List
ü
ü
Download Recorded Files
ü
ü
Delete Recorded Files
ü
ü
ü
ü
Source Operations
View Source Configuration
Rename Source
ü
Configure Source
ü
ü
View Source Snapshot
ü
ü
ü
ü
System Configuration Operations
View System Configuration
Configure Automatic File Upload
ü
Select External USB Drive Behavior
ü
Configure FTP Server
ü
Configure UPnP Sharing
ü
Configure Network Address
ü
Configure USB Tethering
ü
Perform Network Diagnostics
ü
ü
Configure Date and Time preferences
ü
Set or Change User Passwords
ü
Configure the Touch Screen
ü
Configure Serial Port Flow Control
ü
Upload Branding Images
ü
Upload Branding Templates
ü
25
Pearl User Guide
Action or Menu Option
User administration
viewer
operator
admin
Select Branding Template
ü
Enable Remote Support
ü
Backup Device Configuration
ü
Restore Device Configuration
ü
Restore Factory Configuration
ü
Reboot Device (via Web Interface)
ü
Shutdown Device (via Web Interface)
ü
Configure Time Until Next Disk Check
ü
Perform Disk Check
ü
View Disk Information
ü
ü
Upgrade Firmware
ü
View System Information
ü
ü
Set or change user passwords
By default, admin, operator and viewer have no assigned passwords. Both the admin and the operator user
have access to the web admin interface, so you should always set a password for both admin and operator
accounts. Refer to your system administrator for your organization’s specific password requirements.
In addition to setting global passwords for viewers, you can also set access passwords and IP restrictions on a
per-channel basis from the channel's Streaming page. See What is streaming?Restrict viewers by IP address.
Passwords are case sensitive and can use all alpha-numeric keys in the ASCII range. Your password can be up
to 255 characters long, but should not include any spaces.
Setting a user’s password causes the user to be logged out. Be ready to log back in with the new
admin password or have operators and viewers log in with the appropriate new password.
Viewers may need to refresh their browser window or press play in their media player.
If you lose the admin password, refer to the section Set or change user passwords.
To set a user password:
26
Pearl User Guide
User administration
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Access passwords link in the Configuration menu; the password configuration page opens.
4. Highlight and delete the current password for your selected user (the password is currently masked
as dots).
For security reasons, the current password appears as eight dots regardless of password
length, and even if there is no password set.
5. Highlight and delete the confirmation password for the selected user.
6. Select the user’s password field and type a new password for the user.
The new password must have between 1-255 alpha-numeric characters or special
characters with no spaces. Passwords are case sensitive.
7. Select the user’s password confirmation field and confirm the new password.
8. Click Apply.
9. If you were logged in as the user whose password you just changed, you are logged out and must log
back in with the new password. If you added or changed the viewer’s password, all viewer’s stream will
pause until they log in with the new password.
If desired, you may specify multiple account passwords on the same page before clicking Apply.
Remove user passwords
If you want to remove passwords for one or more user accounts, you may do so via the web interface. If you
don’t remember the admin password, refer to the section Overcoming Lost Passwords.
Note that viewer passwords can be set on a per-channel basis.
Clearing a user’s password will cause that user to be logged out. Be ready to log back in with the
new admin password. If viewers are watching the broadcast when the viewer password is cleared
they will be logged out. Viewers may need to refresh their browser window or press play in their
media player to trigger the login prompt.
To clear a user’s password:
27
Pearl User Guide
User administration
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Access passwords link in the Configuration menu; the password configuration page opens.
4. Highlight and delete the current password for your selected user (the password is currently masked as
dots).
For security purposes, the current password appears as eight dots regardless of password
length, and even if there is no password set.
5. Highlight and delete the confirmation password for the selected user.
6. Click Apply.
7. If you were logged in as the user whose password you just cleared, you are logged out and must log
back in without a password. If you cleared the viewer’s password, all viewers’ stream will pause until
they log in without a password.
To clear a user’s password on a specific channel:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Click the Streaming link for the channel; the channel's Streaming configuration page opens.
4. From the Access control section do one of the two following things:
a. clear the viewer password field; or
b. select Use global settings from the access control drop down.
5. Click Apply.
Overcome lost passwords
If you have lost the password for the operator or viewer account, you can log in to the web interface as admin
and reset the password using the procedure described in Overcome lost passwords.
If you have lost the admin password and you have remote support enabled on the system, you can contact
Epiphan support to request a remote password change. See Support. If remote support is disabled, you will
need to return the system to Epiphan for password recovery. Contact Epiphan support to discuss this option.
28
Pearl User Guide
User administration
Configure LDAP
You can use the Lightweight Directory Access Protocol (LDAP) for authentication into the system. Specify user
roles by using group DNs for users who log in as the administrator, operator, or as a viewer.
The system has only one admin user and one operator: LDAP users log in as either the admin or
operator, they do not have their own private profiles.
When enabled, LDAP authentication is an alternative to the regular system usernames and
passwords. You may still login as admin, operator or viewer using the passwords for those
accounts. Furthermore, any LDAP users with the name admin, operator or viewer are ignored. The
local accounts are used instead.
For security reasons, you should configure passwords for the local accounts. See Configure
LDAP.
These instructions assume you have a pre-configured LDAP server. The server must support anonymous
binding or have a special bind account with search access priveleges. (Note that Active Directory does not
support anonymous binding.)
LDAP referrals, restrictions and failovers are not supported.
To configure LDAP authentication for your Pearl:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Access passwords link in the Configuration menu; the password configuration page opens.
4. Scroll to the LDAP authentication section.
29
Pearl User Guide
User administration
5. Click the Enable LDAP authentication checkbox to enable LDAP authentication (or uncheck to
disable).
6. Specify the server IP address and (optional) port for your LDAP server (i.e. 192.168.1.101:389) in the
Server address[:port] field.
7. Use the Connection encryption drop-down to specify the type of encryption, if any used by your
LDAP server.
Connection
encryption
Description/Default port used
No Encryption
No encryption is used to connect to the LDAP server. The default port is 389.
SSL
SSL encryption is used to connect to the LDAP server. The default port is 636.
TLS/STARTTLS
The connection is initially unencrypted then upgraded to TLS encryption is
used. The default port is 389.
8. Specify the fully qualified DN and password for LDAP bind in the Bind DN and Bind password fields.
(The password masked as dots on the screen.) These fields are only needed if your LDAP server does
not support anonymous binding.
9. In Base DN, specify the baseObject in which to search for entries. The system will search this object
and the whole subtree starting at the base DN.
10. By default the search attribute is uid, which is suitable for a unix environment. Specify a different value
in the Search attribute field, if needed. For Active Directory environments, specify
userPrincipalName. The value of this attribute must be unique in the Base DN.
11. In the Administrators (group DN) field, specify the distinguished name of the group users must be
part of to be logged in as the administrator. Users must have the member or unqueMember attribute
for the specified group to be granted Administrator access.
If left blank, LDAP is not supported for Administrators (but can still be used for Operators and Viewers).
30
Pearl User Guide
User administration
12. In the Operators (group DN) field, specify the distinguished name of the group users must be part of
to be logged in as the operator. Users must have the member or unqueMember attribute for the
specified group to be granted Operator access.
If left blank, LDAP is not supported for Operators (but can still be used for Administrators and Viewers).
13. In the Viewers (group DN) field, specify the distinguished name of the group users must be part of to
be logged in as a viewer. Users must have the member or unqueMember attribute for the specified
group to be granted Viewer access.
If left blank, LDAP is not supported for Viewers (but can still be used for Administrators and Operators).
14. Click Apply.
When a user of the LDAP server next visits the admin or viewer page for the system, the system prompts for
use the username and password. For ActiveDirectory servers, the user needs to enter his fully qualified
username (i.e. [email protected]) in addition to his LDAP password.
Users are required to authenticate once to the system and one time per channel they view.
Therefore users see a prompt to log in to the system (the system name is shown) and a second
time to log in to the channel (the channel name is shown).
In one case, LDAP replaces the local viewer account instead of working side-by-side with it.
When LDAP is enabled and the viewer account has no password (either there is no global viewer
password or the channel overrides the global password with a blank password), the viewer must
authentication with LDAP, he may not alternatively use the viewer account with a blank
password.
Change the logged-in user
When you log in to the web interface as admin or operator, your browser remembers this configuration and
automatically logs you in as the same user when you go back to the site.
Sometimes you need to change from operator to admin, or vice versa.
To change the logged-in user:
1. Exit your browser completely, open an incognito/private window in your browser, or open a different
browser (i.e. Internet Explorer, Chrome, and Safari are different browsers).
2. Connect to the admin interface using your preferred connection mechanism. SeeConnect to the admin
interface.
3. You are prompted for a username and password.
31
Pearl User Guide
User administration
Restrict viewers by IP address
Pearl permits you to restrict which computers can access broadcasts by building a list of allowed and/or
denied IP addresses. You can do this at a global level for the system and can also override these settings on a
per-channel basis. Both global and per-channel configuration procedures are described below.
IP address restriction is valid for the viewer only and does not affect the web admin interface or
the mobile configuration interface.
If your viewer account has a password, your viewers must connect to the system from a computer (or
gateway) with a permitted IP address and must also supply the username (viewer) and password before they
can view the broadcast.
To restrict access by IP address you need to know the IP addresses, or range of addresses for your viewers. By
default all IP addresses are allowed to connect to the broadcast.
If you’re not familiar with creating allow/deny lists, refer to the examples below this procedure for assistance
with crafting your lists.
To restrict viewers by IP address:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Access passwords link in the Configuration menu; the password configuration page opens.
4. Type allowed IP addresses or address ranges in the Allow IP’s field. Separate addresses with a comma.
5. Type denied IP addresses or address ranges in the Deny IP’s field. Separate addresses with a comma.
6. Click Apply.
To restrict viewers of a specific channel by IP address:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Streaming link for the desired channel; the streaming configuration page opens.
4. From the Access Control drop-down, select Use these Settings; local password and Allow/Deny IP
lists are enabled.
5. If desired, type a password for the viewer in the Viewer Password field.
6. Type allowed IP addresses or address ranges in the Allow IP’s field. Separate addresses with a comma.
32
Pearl User Guide
User administration
7. Type denied IP addresses or address ranges in the Deny IP’s field. Separate addresses with a comma.
8. Click Apply.
If a user attempts to connect to the stream from a disallowed IP address, access is denied. If connecting by
internet browser, the message "IP address rejected." is displayed.
The following table describes the applicable fields.
Table 7 IP Based Restriction Fields
Label
Description/Options
Enter individual IP Addresses or IP Address ranges, separated by commas. To specify a
range, use a hyphen (-). Optional spaces improve readability.
Users connecting from addresses in this list are permitted to view broadcasts from the
Allow IP's
system, provided their IP address is not in the Deny IP’s list.
To allow all (except IP addresses in the deny list, if any), leave the field blank.
You can use the Allow list by itself, or in conjunction with the Deny IP’s list as an exception
to a rule in the allow list.
Enter individual IP Addresses or IP Address ranges, separated by commas. To specify a
range, use a hyphen (-). Optional spaces improve readability.
Users connecting from addresses in this list are not allowed to view broadcasts from the
Deny IP's
system, unless their IP address is in the Allow IP’s list. If a specific IP address is in both lists,
access to the stream is denied.
You can use the Deny list by itself, or in conjunction with the Allow IP’s list as an exception
to a rule in the allow list.
IP Restriction Examples
Allow List with Distinct IP Addresses
The simplest allow/deny list is to use the list of known IP addresses to craft a list of allowed IP addresses. All
other addresses are denied access to the broadcast.
For example if your system is accessible on your local area network (LAN) and you want to make sure only the
CEO’s specific desktop, laptop and tablet computers (with IP Addresses 192.168.1.50, 192.168.1.51, and
192.165.1.75, respectively) can connect to the broadcast, construct the following allow list:
Allow: 192.168.1.50, 192.168.1.51, 192.168.1.75
33
Pearl User Guide
User administration
Allow List with a Range of IP Addresses
Sometimes you’ll want a range of computer IP addresses to connect to your system. This may happen when
you have one range of IP addresses assigned to desktop computers (i.e. in the range 192.168.1.1 to
192.168.1.100) and another range assigned to boardroom computers (i.e. the range 192.168.1.200 to
192.168.1.250). If you only want the boardroom computers to connect to broadcasts from the system you
can specify the range of boardroom IP addresses rather than needing to type in each individual address. The
allow list looks as follows:
Allow: 192.168.1.200-192.168.1.250
Note that we could have specified two of the IP addresses in the previous example as a range.
Allow List with a Range of IP Addresses and One or More Specific IP Addresses
Putting the first two examples together, we want to permit access to IP addresses in the range of boardroom
computers (192.168.1.200-192.168.1.250) and also want to add the desktop, laptop and tablet computers
of the CEO (IP addresses 192.168.1.50, 192.168.1.51, and 192.168.1.75, respectively). Note the first two IP
addresses are consecutive, so they can be added as a second range. Add these IP addresses to the list as
follows:
Allow: 192.168.1.200-192.168.1.250, 192.168.1.50-192.168.1.51, 192.168.1.75
Your list can have multiple ranges and multiple distinct IP addresses, provided they are separated by commas.
Deny List with Distinct IP Addresses
Another simple allow/deny list is to use the list of known IP addresses to list specific denied IP addresses. All
other addresses are allowed access to the broadcast.
For example imagine your system is accessible on your local area network (LAN) and you want to allow any
computer on the LAN can access the stream except your publicly-accessible boardroom (with IP address
192.168.1.211). You can use the following deny list (leave the allow list empty) to permit all computers except
the boardroom computer:
Deny: 192.168.1.211
As with Allow lists, your deny list can specify a range of IP addresses, and can specify multiple ranges or
distinct IP addresses in a comma-separated list.
34
Pearl User Guide
User administration
Allow List with a Range of IP Addresses, Distinct IP Addresses, and an Exception
Building on the previous examples, consider the situation where you want the CEO’s computers
(192.168.1.50, 192.168.1.51, 192.168.75) and all boardroom computers (192.168.1.200-192.168.1.250)
to access the broadcast, with the exception of the public boardroom computer (192.168.1.211). Use both
allow and deny lists to create the rule as follows:
Allow: 192.168.1.200-192.168.1.250, 192.168.1.50-192.168.1.51, 192.168.1.75
Deny: 192.168.1.211
Both lists can have multiple ranges and multiple distinct IP addresses, provided they are separated by
commas.
Deny List with a Range of IP Addresses
Converse to the previous examples, consider the situation where you want every computer on the network to
access the broadcast, with the exception of the CEO’s desktop, laptop, and tablet computers. Additionally,
boardroom computers should not be permitted with the exception of the cafeteria computer (IP address
192.168.1.222).
The deny list is an "exception" list for the allow list. So to craft the rule described above we need to allow all the
computers in the local subnet, then deny specific sub-ranges including two groups of boardroom computers
ensuring the cafeteria computer's IP address is not in the deny list:
Allow: 192.168.1.1-192.168.1.250
Deny: 192.168.1.200-192.168.1.221, 192.168.1.223-192.168.1.250, 192.168.1.50-192.168.1.51,
192.168.1.75
35
Pearl User Guide
Pearl's touch screen
Pearl's touch screen
Pearl's front panel includes a touch screen display used for confidence monitoring and basic configuration.
Use the touch screen to view system information, configure network settings, load configuration presets, view
configured channels, review audio levels, and control channel recording.
By default, the screen and all its features are enabled. You can configure whether or not the touch screen is
active and which features are enabled. See Configure the touch screen.
Pearl's touch screen is capacitive. Use your finger or a specially designed soft-tipped capacitive
stylus with firm but gentle pressure. Pressing too hard or using something other than a fingertip
or capacitive stylus can result in damage to the screen.
This section describes how to use the touch screen and provides an overview of the functionality available
through the screen.
l Touchscreen overview
l View system information
l Channel monitoring
l Pearl's audio jack
l Control recording
l Configure the touch screen
Touchscreen overview
While Pearl is booting, the following image appears on the touch screen (if the screen is enabled).
After boot up is complete, Pearl displays a grid view providing an overview of all configured channels.
36
Pearl User Guide
Touchscreen overview
If you have no sources plugged in, or if no plugged in source is sending a signal, the grid view shows the two
auto channels with no signal (see Use the automatic channels Auto A and Auto B for more details on auto
channels):
With sources plugged into at least one input of row A and row B, the grid view looks more like this:
From this screen, touch either channel to go to the individual channel screen, or touch the gear symbol to go
to the system settings screen. From the single channel screen touch the gear to go to system settings or
touch the button with four squares to return to the grid..
If you delete the automatic channels Auto A or Auto B, and have no other channels configured, Pearl shows
a no channels screen. Touch anywhere on this screen to go to the system settings screen.
37
Pearl User Guide
View system information
If the touch screen is configured not to show channel previews, the screen shows the following preview
disabled message. Touch anywhere to on this screen to go to the system settings screen.
View system information
Useful when first setting up Pearl, for finding the system serial number or to check the installed firmware
version, the touch screen shows you basic information about your Pearl. If desired, you can choose to disable
this screen. See Configure the touch screen.
Label
Description
Device Information
l Serial number
l video grabber number
38
Pearl User Guide
View system information
Label
Description
l Firmware version
Network Information
l IP Address
l MAC Address
Device Status
l System date
l System time
l Uptime
l Temperature in degrees Celsius
Storage Information (when available)
l Disk space available
l Pictogram of available disk space To show system information on the touch screen:
1. If the system settings button (gear) is not on the screen, tap the screen once to turn on the control
buttons.
2. If the system settings button is still not visible, it is disabled in the system's Touch screen configuration.
See Configure the touch screen to enable system information.
3. Touch the system settings button (gear) on the screen.
4. Touch System Status to see the System Status page.
39
Pearl User Guide
Channel monitoring
To close the system information screen:
1. Touch Back to return to the System Settings screen, or the Home icon to return to the channel view.
Channel monitoring
Use Pearl's front-panel screen to have complete confidence about what you're capturing. View audio levels
and a preview of the captured video for each channel. Change between individual channels or view a grid of all
channels using on-screen navigation buttons. You can also directly monitor audio quality using the 3.5 mm
audio jack located at the front of the device. Read more Pearl's audio jack.
You may also be interested in learning about video switching from the touch screen, see Live video mixing /
switching.
Individual channel monitoring
Table 8 Parts of the touch screen in individual channel view
Item
Description
1
2
Channel name
Recording status (bright red means
recording is started)
40
Pearl User Guide
Channel monitoring
Item
Description
3
Recording timer (time since recording
was started)
4
Switch to the previous channel
5
Switch to the next channel
6
Audio VU meter
7
Grid view icon
8
System settings icon
To switch between available channels:
1. If necessary, tap the screen once to turn it on.
2. If necessary, tap the screen once to display controls on the channel view.
3. Touch the left or right controls on at the side of the channel display; the screen displays the next
channel.
To change from grid view to an individual channel view:
1. If necessary, tap the screen once to turn it on.
2. Touch any channel in the grid view; the screen displays the selected channel.
Grid-view channel monitoring
Depending on the number of configured channels, the grid view will show 2, 3, 4, 5 or 6 channels at once.
Table 9 Parts of the touch screen in grid view
Location
Top left of channel
Description
Channel Name
41
Pearl User Guide
Pearl's audio jack
Location
Description
Recording indicator, appears only if this
Top right of channel
channel is recording. (Recording control
only accessible from individual channel
view.)
Bottom left of
channel
lower right corner of
screen
Audio level indicator. See Audio
VU Meter for description of levels.
Gear icon. Used to access settings.
To change from individual channel view to grid view:
1. If necessary, tap the screen once to turn it on.
2. If necessary, tap the screen once to display controls on the channel view.
3. Touch the grid view button; the screen displays the grid view
Pearl's audio jack
Pearl's front panel includes a 3.5 mm audio jack for audio monitoring.
Audio monitoring
To use the audio monitor, plug speakers or a microphone into the 3.5 mm audio jack.
Use the touch screen to select a channel, that channel's audio is played through the speakers or headphone.
Audio is also played when switching layouts - and is always the audio for the currently live layout.
Mute audio monitoring
You can mute and unmute audio monitoring by touching the headphones icon on the touch screen.
42
Pearl User Guide
Control recording
Audio VU Meter
Regardless of whether or not speakers or headphones are plugged in, the touch screen also shows the audio
levels on a VU meter. The VU meter shows the RMS level in dBFS (decibels relative to full scale) and uses
colored bars to represent the current level.
Table 10 Touch screen audio VU meter levels
Color
Decibel range
Green
-60 dB to -10 dB
Yellow
-10 dB to -4 dB
Red
-4 dB to 0 dB
Control recording
Pearl's touch screen gives you freedom to start and stop recording without needing to log in to the web
interface.
Simply scroll to the channel you wish to control and press the start or stop recording button.
43
Pearl User Guide
Control recording
To start recording:
1. If necessary, tap the screen once to turn it on.
2. If the grid view is showing, tap the channel for which you wish to control recording; the screen displays
the channel.
3. If necessary, tap the screen once to display controls on the channel view.
4. Touch the red record button (see above) at the top right of the screen; recording starts and a timer is
displayed to show the length of the recording.
To stop recording:
1. If necessary, tap the screen once to turn it on.
2. If the grid view is showing, tap the channel for which you wish to control recording; the screen displays
the channel.
3. If necessary, tap the screen once to display controls on the channel view.
4. Touch the red record button (see above) at the top right of the screen; recording stops and the timer
disappears.
44
Pearl User Guide
Configure the touch screen
Configure the touch screen
By default, Pearl's touch screen is enabled and all its features are available. Depending on your circumstances,
you may wish to disable the screen, or disable just some of its features.
This section covers the following touch screen configuration items:
l Disable (or enable) the touch screen
l Hide (or show) channel previews on the touch screen
l Disable (or enable) system status on the touch screen
l Block (or allow) configuration functions from the touch screen
l Block (or allow) recording control from the touch screen
l Set touch screen timeout
Disable (or enable) the touch screen
You can prevent Pearl from displaying anything on the touch screen, or you can re-instate this feature by
toggling the Enable display configuration option.
The display is always touch-sensitive. This control indicates whether or not the display is on
or off.
To disable (or enable) the touch screen display:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Touch Screen link in the Configuration menu; the touch screen configuration page opens.
45
Pearl User Guide
Configure the touch screen
4. Uncheck Enable display to disable the display (or check the box to enable the display).
5. Click Apply.
Hide (or show) channel previews on the touch screen
By default, Pearl shows previews of each configured channel. If this isn't suitable for your needs, you may
disable channel preview. When channel previews are disabled, the touch screen shows the following image:
While preview is disabled, if system status or settings and configuration preset changes
are permitted, you can touch the screen anywhere to open the settings page.
To hide (or show) the channel previews on the touch screen:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
46
Pearl User Guide
Configure the touch screen
2. Login as admin.
3. Select the Touch Screen link in the Configuration menu; the touch screen configuration page opens.
4. Uncheck Show preview to disable channel previews (or check the box to enable previews).
5. Click Apply.
Disable (or enable) system status on the touch screen
Once you've configured, Pearl its possible you may no longer wish to show the system status screen on the
touch screen. .
To hide (or show) system information on the touch screen:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Touch Screen link in the Configuration menu; the touch screen configuration page opens.
47
Pearl User Guide
Configure the touch screen
4. Uncheck Show system status to prevent the system status screen from being accessible on the
touch screen (or check the box to enable system information).
5. Click Apply.
Block (or allow) configuration functions from the touch screen
By default, Pearl permits applying configuration presets and configuring network settings via the touch
screen. You can disable this ability.
If configuration is blocked and system status is permitted, touch screen users see an i icon instead
of the configuration gears icon in the lower right corner of the touch screen.
To block (or allow) the channel previews on the touch screen:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Touch Screen link in the Configuration menu; the touch screen configuration page opens.
48
Pearl User Guide
Configure the touch screen
4. Uncheck Allow settings and configuration preset changes to disable configuration from the
touch screen (or check the box to enable configuration).
5. Click Apply.
Block (or allow) recording control from the touch screen
By default, Pearl permits recording control and live switching control for channels. You can disable this control
to prevent unwanted interruptions in recordings or to stop users from switching the layout used.
Channel preview must be on for recording and live switching control to work.
To block (or allow) the recording and live mixing / switching control via the touch screen:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Touch Screen link in the Configuration menu; the touch screen configuration page opens.
49
Pearl User Guide
Configure the touch screen
4. Uncheck Allow start/stop recording to disable recording control from the touch screen (or check the
box to enable recording control).
5. Click Apply.
6. Enter a value in the Timeout field. The values is in seconds. Use 0 to keep the screen on whenever the
system is on.
7. Click Apply.
Set touch screen timeout
Initially, the touch screen is always on for easy monitoring. However, if you'd like, you can modify its
configuration to cause it to shut off after a given amount of time. To re-enable it after timeout, simply touch
anywhere on the screen.
To set a timeout for the touch screen:
50
Pearl User Guide
Configure the touch screen
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Touch Screen link in the Configuration menu; the touch screen configuration page opens.
4. Enter a value in the Timeout field. The values is in seconds. Use 0 to keep the screen on whenever the
system is on.
5. Click Apply.
51
Pearl User Guide
View system information
View system information
The system information page provides a great deal of useful information about your Pearl. Use the Info link
from the Configuration menu to view your current firmware level, system hardware version (if available) and
currently configured channels.
To view system information:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, scroll to the Configuration menu option.
4. Click Info; the system information page opens.
3. Use the information displayed to get an overview of your system, troubleshoot problems or view
streams for configured channels.
52
Pearl User Guide
Configure network settings
Configure network settings
By default Pearl uses DHCP to obtain an IP Address via an Ethernet-based network. If you want to change the
network settings, or if you’re having network-related issues, this section covers the network-related topics.
l Verify IP Address and MAC address via the touch screen
l Verify IP Address and MAC address via the web interface
l Configure a static IP address
l Configure DHCP
l Tether to a mobile network
l Perform network diagnostics
Verify IP Address and MAC address via the touch screen
Pearl's touch screen interface, if enabled, can quickly and easily show you the system's IP Address and
MAC address.
To show system information on the touch screen:
1. If the system settings button (gears) does not appear on the screen, tap the screen once to turn on the
control buttons (from the "no channels" or "preview disabled" screen, this will go directly to the system
settings screen).
2. If the system settings button (gears) is still not visible and an i icon is visible instead, configuration by
touch screen is disabled in the system's settings. See Configure the touch screen to enable.
3. Touch the system settings button (gears) on the screen; the system settings screen appears.
4. Touch System Status to see the system information page.
53
Verify IP Address and MAC address via the web inter-
Pearl User Guide
face
To close the system information screen:
1. Touch Back to return to the Systems Settings screen or the Home icon to return to the channel view.
Verify IP Address and MAC address via the web interface
The web interface shows you the system’s MAC address and current IP Address via the Network configuration
page.
To view settings on network configuration page:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Network link in the Configuration menu; the network configuration page opens.
4. Note the MAC address and Current IP address listed at the top of the page.
Table 11 Network Information Fields
Label
Description/Options
A media access control address (MAC address) is a unique identifier for the net-
MAC Address
work interface. The value is read-only and cannot be changed. You may need to
share this value with your system administrator.
Current IP Address
Reflects the current internet protocol address (IP address) of the system. This
54
Pearl User Guide
Label
Configure DHCP
Description/Options
value is either obtained from the DHCP server (if using DHCP) or is the configured
static IP address. Pearl supports IPv4 addresses. It does not support IPv6
addresses.
Configure DHCP
Occasionally, such as when moving your system to a new network, your Pearl must switch from static IP
address allocation to dynamic allocation via DHCP. You can accomplish this three ways:
l Restore factory settings, clearing all your custom settings. See Perform factory reset.
l Load a configuration file that uses DHCP networking. See Load a saved device configuration.
l Apply a configuration preset that uses DHCP networking. See Configuration presets.
l Change the network settings. See the procedure below.
For quick and easy setup of Pearl, you can configure network settings via the web interface or via touch
screen.
Using the touch screen, you can choose to apply a configuration presets that uses DHCP (see Configuration
presets
To configure network settings via the touch screen:
1. If the system settings button (gears) does not appear on the screen, tap the screen once to turn on the
control buttons (from the "no channels" or "preview disabled" screen, this will go directly to the system
settings screen).
2. If the system settings button (gears) is still not visible and an i icon is visible instead, configuration by
touch screen is disabled in the system's settings. See Configure the touch screen to enable.
3. Touch the system settings button (gears) on the screen; the system settings screen appears.
4. Touch Network ; the Network settings page appaers. The currently enabled type of network setting
(DHCP or static) is highlighted green.
55
Pearl User Guide
Configure DHCP
5. If not already using DHCP, touch DHCP to enable DHCP.
6. If DHCP was not the active network type, a confirmation message is displayed.
7. Touch OK; DHCP is enabled.
To configure use of DHCP for networking:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Network link in the Configuration menu; the network configuration page opens.
4. Select the radio button use DHCP, if not already selected.
5. Change the MTU Size value only if needed. See the table below for information on maximum
transmission unit (MTU) values.
6. Click Apply to save the changes; the changes are saved and a message appears asking you to reboot.
7. Select the Maintenance link under the Configuration menu; the maintenance page appears.
8. Click the Reboot Now button near the bottom of the page.
9. Wait for the system to reboot.
10. Connect to the admin interface using your preferred connection mechanism. SeeConnect to the admin
interface.
11. Log as admin and reload the Networking page to verify all changes were applied.
The following table describes the fields applicable when configuring DHCP on Pearl.
56
Pearl User Guide
Configure a static IP address
Table 12 DHCP Fields
Label
Description/Options
Use DHCP
Select this radio button to dynamically obtain an IP address at boot up.
Use static
address
Use static address Select this radio button to use the configured static IP address.
The maximum transmission unit (MTU) specifies the maximum packet size for transfer on
MTU Size
the network. The default value is 1500, which is the largest value allowed by Ethernet at
the network layer. It’s best if all nodes in your network use the same value, so only change
this value if you know other nodes use a different value.
Configure a static IP address
Your network administrator may require you to use a static IP address for your Pearl.
For quick and easy setup of Pearl, you can configure network settings via the web interface or via touch
screen.
Using the touch screen, you can choose to apply a configuration presets that contains a static network IP (see
Configuration presets
To configure network settings via the touch screen:
1. If the system settings button (gears) does not appear on the screen, tap the screen once to turn on the
control buttons (from the "no channels" or "preview disabled" screen, this will go directly to the system
settings screen).
2. If the system settings button (gears) is still not visible and an i icon is visible instead, configuration by
touch screen is disabled in the system's settings. See Configure the touch screen to enable.
3. Touch the system settings button (gears) on the screen; the system settings screen appears.
4. Touch Network ; the network settings page appears. The currently enabled type of network setting
(DHCP or static) is highlighted green.
57
Pearl User Guide
Configure a static IP address
5. Touch Static IP Address to configure a static IP address; the static IP configuration page appears.
6. Touch an IP Address section (e.g. 192) and type a new value using the keypad.
7. Repeat for all fields in the IP Address and Network Mask.
Only IPv4 addresses are supported.
8. Enter the Default Gateway address. If you do not have a default gateway for your network, enter the
same static IP address as in the previous step.
The default gateway cannot be left blank. If no default gateway is specified, unexpected
behavior occurs.
9. Enter the DNS Server address. If you do not have a DNS server, enter the new static IP address of the
system.
10. Touch Apply to apply the changes.
To configure a static IP address via the web interface:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Network link in the Configuration menu; the network configuration page opens.
58
Pearl User Guide
Configure a static IP address
4. Select the radio button use static address, if not already selected.
5. Enter the desired IP Address and Network Mask.
Only IPv4 addresses are supported.
6. Enter the Default Gateway address. If you do not have a default gateway for your network, enter the
same static IP address as in the previous step.
The default gateway cannot be left blank. If no default gateway is specified, unexpected
behavior occurs.
7. Enter the DNS Server address. If you do not have a DNS server, enter the new static IP address of the
system.
8. Change the MTU Size value only if needed. See the table below for information on maximum
transmission unit (MTU) values.
9. Click Apply to save the changes; the changes are saved and a message appears asking you to reboot.
10. Select the Maintenance link under the Configuration menu; the maintenance page appears.
11. Click the Reboot Now button near the bottom of the page.
59
Pearl User Guide
Tether to a mobile network
12. Wait for the system to reboot.
13. Open the Web interface using the new IP address.
14. Log as admin and reload the Networking page to verify all changes were applied.
The following table describes applicable fields when setting a static IP address.
Table 13 Static IP Address Fields
Label
Description/Options
Use DHCP
Select this radio button to dynamically obtain an IP address at boot up.
Use static address
Select this radio button to use the configured static IP address.
The internet protocol address (IP Address) to assign. This value is may be obtained
IP Address
from your system administrator. Pearl supports IPv4 addresses. It does not support
IPv6 addresses.
Also called the subnet mask, this value denotes a range of IP addresses. This value
Network Mask
may be obtained from your system administrator, determined from another computer on the same subnet, or calculated using an online subnet calculator.
The network node that serves as an access point to the rest of the network. This value
Default Gateway
cannot be blank unless you are using DCHP. Specify the system’s IP address if you
don’t have a default gateway on your network.
The domain name system server (DNS server) translates human-readable hostnames
DNS Server
into corresponding IP addresses. Specify the system’s IP address if you don’t have a
DNS server on your network. This value cannot be blank unless you are using DHCP.
The maximum transmission unit (MTU) specifies the maximum packet size for trans-
MTU Size
fer on the network. The default value is 1500, which is the largest value allowed by Ethernet at the network layer. It’s best if all nodes in your network use the same value, so
only change this value if you know other nodes use a different value.
Tether to a mobile network
Pearl supports tethering to a mobile device via USB. Tethered networking can work side-by-side with Ethernet
routing and either networking system can be a back-up for the other.
When the system falls over to the backup network type (i.e. from Ethernet to mobile, or vice
versa) all streaming sessions with clients or servers directly connected to the system are closed
60
Pearl User Guide
Tether to a mobile network
and the clients will need to reconnect. You may need to provide a new stream URL (containing the
new IP address) to your viewers. See the channel information page to get the new stream URL.
By contrast, actively published streams are closed and reconnected via the secondary network
(mobile or Ethernet) automatically, permitted the required publishing server is accessible from the
new network.
To configure tethering to a mobile network:
1. Configure the mobile device to allow tethering via USB.
2. Connect the mobile device to Pearl with a USB cable.
3. Connect to the admin interface using your preferred connection mechanism. SeeConnect to the admin
interface.
4. Login as admin.
5. Select the Network link in the Configuration menu; the network configuration page opens.
6. Click the drop-down box next to Use phone/tablet connection in the USB phone/tablet section; the
following choices appear:
Table 14 Mobile Tethering Options
Label
Description/Options
Disabled
Specifies that no USB tethering is permitted.
No tethering
Specifies that USB tethering is available for connecting a mobile device as a configuration utility (i.e. using the web browser), but no mobile data is used.
When chosen, the system tries to use the Ethernet network first. It switches to use
Prefer ethernet
the mobile network (tethering) when the Ethernet network is no longer available.
To prevent viewer interruptions, mobile data will continue to be used until the
mobile network is down or publishing is restarted.
When chosen, the system tries to use the mobile network (tethering) first. It
switches to use Ethernet (hard-wired) when the mobile network is no longer
Prefer teth-
available. To prevent viewer interruptions, Ethernet data will continue to be used
ering
until the Ethernet network is down or publishing is restarted.
Select this setting if you only have a mobile network.
7. Select your choice based on the table above.
8. Click Apply.
61
Pearl User Guide
Perform network diagnostics
Perform network diagnostics
If your Pearl has network trouble, you can perform basic network troubleshooting tasks from the Network
configuration page. In addition to providing the system’s IP address and MAC address to your network
administrator (See Perform network diagnostics), you can also ping an IP address or use traceroute to
determine the path taken to an address.
Note: Not all networks support ping and traceroute.
To ping or traceroute an IP address:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Network link in the Configuration menu; the network configuration page opens.
4. Click ping or traceroute; an animation appears to the left of the address to indicate processing is
underway.
5. Upon completion of the command, read the results from the console-like display is shown below the
Network Diagnostics setting.
62
Pearl User Guide
Perform network diagnostics
63
Pearl User Guide
Configuration presets
Configuration presets
In situations where you have changing configuration requirements for your Pearl, you can use
configuration presets to quickly and easily apply sets of pre-configured settings.
For an overview of configuration presets, see:
l Configuration presets overview
This section also covers the following related topics:
l Configuration groups
l Create a configuration preset
l Apply a configuration preset from the web interface
l Apply a configuration preset using the touch screen
l Apply the Factory default configuration preset
l Update a configuration preset
l Delete a configuration preset
There are also some very important configuration preset considerations to review:
l Configuration preset considerations
Configuration presets overview
Configuration presets make it easy to use your Pearl in a variety of situations without needing to reconfigure
it. Configuration presets divide the system's settings into the following six configuration groups. (For a
complete list of what is included in each group see Configuration presets overview.)
System
Sources
Automatic file uploads
Network
Channels
Touch screen
Using the Configuration presets section of the Maintenance page, you can create configuration presets
using any number and combination of the configuration groups. Mix and match the settings groups saved
together to create sets of configuration settings needed for each situation. You also always have a special
64
Pearl User Guide
Configuration presets overview
Factory default configuration preset (which cannot be erased) to help you return to factory configuration
without destructively erasing files saved to the system hard drive. (See Configuration presets overview
It's important to note that configuration presets are applied over existing settings. They affect only the
settings groups included in the preset, all other settings are unaffected. Read the Configuration presets
overview section carefully to understand caveats around using configuration presets.
Example of configuration presets in action
A recording and streaming company brings Pearl to a conference. Each conference session needs to be
streamed and recorded with a picture in picture layout that includes identifying information about the
presenter in the metadata and the background image for the stream. Automatic file upload is needed to make
sure the files are uploaded right after each session is complete.
The company could bring Pearl in a factory configured state and get it ready between each session, but this
requires a trained operator and doesn't allow much time to get multiple operations completed.
Instead, the company could connect the system to their own corporate network before the show, upload the
required backgrounds, and create channel configuration presets for each conference track. They can also
create network and automatic file upload (AFU) presets for each of the home and remote locations. Once at
the conference, the only changes necessary are to apply the network and AFU preset upon arrival, and the
channel configuration presets between sessions. Note that for added simplicity, you can load presets via the
touch screen!
Channel configuration presets include links to background files used, but do not include the files
themselves see Branding content. Be careful when deleting background images and logo files.
Internal network and AFU preset
The company uses this preset when configuring and testing from their corporate network. It uses a static IP
address on their corporate network and AFU that uses ftp to upload to a local ftp server.
65
Pearl User Guide
Configuration presets overview
Conference network and AFU preset
The company applies this preset to Pearl when they arrive at the conference. It changes only the network and
AFU settings (using a conference-specific IP address and secure file transfer to an ftp server).
When applying this configuration preset, all other information including passwords, date/time, channels and
source configurations, remains the same.
Conference session 1 preset
The company applies this preset from the corporate office when testing and at the conference prior to
conference session 1 starting. All other preset groups remain unchanged, this preset only affects the channel
(s) and their configuration. This preset includes a channel with a link to the correct background filename (the
background file was uploaded during pre-show configuration at the corporate office) and has metadata
specifying the speaker's name.
Conference session 2 preset
The company applies this preset from the corporate office when testing and at the conference prior to
conference session 2 starting. After applying this preset the files recorded from session 1 remain present on
the system and continue to upload via sftp (if not yet complete), but the channels reflect the session 2
background file name and presenter name.
66
Pearl User Guide
Configuration groups
Configuration presets are a versatile tool to help you use Pearl in a variety of changing conditions. Try it
yourself and see!
Configuration groups
The following table describes what settings are saved with each configuration group.
Table 15 Configuration group definitions
Group Name Symbol
Settings included in the configuration group
Date and time settings, serial port settings, remote support settings, custom
System
disk check schedule, access passwords, deny/allow lists and LDAP configuration
settings
Network
Network settings and tethering configuration.
Sources
All audio and video source configuration settings.
All channel configuration data and current recording state, all layouts, all
Channels
recorder configuration data and current recording state, individual and global
UPnP settings.
AFU
Touch screen
Automatic file upload type and parameters.
Permitted touch screen use settings.
67
Pearl User Guide
Create a configuration preset
Note that branding content, recorded files and SFTP/SCP private keys are not included in
any configuration preset.
Updloaded EDID configurations are applied immediately to the system and remain the norm for
the source until a new EDID is uploaded. Configuration presets do not affect EDIDs.
Create a configuration preset
You can create as many configuration presets as you need. The system keeps track of which configuration
groups are part of the preset and you provide a name that lets you know the significance of the preset.
Note that configuration presets that include network or system settings require a system
reboot when applied.
To create a configuration preset:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Maintenance link in the Configuration menu; the maintenance page opens.
4. Scroll to the Configuration presets section.
68
Pearl User Guide
Apply a configuration preset from the web interface
5. Type a description for your preset in the Name field.
6. Ensure only the desired configuration groups are selected from the Sections group.
7. Click Save; your configuration preset appears in the list.
Apply a configuration preset from the web interface
When you apply a configuration preset, the system settings for all included configuration groups are updated.
Other settings on the system are not affected. For example if you apply a preset that includes the
configuration groups channnels and automatic file upload, your network settings, passwords, time server,
source configurations, etc are not modified. Similarly if you apply a configuration preset that has only
network settings included, only the network settings change.
If you apply a preset that has the network or system configuration group, a reboot is required.
You can verify which configuration groups are included in a preset by looking at the list to the right of the
configuration preset name. The term 'all' means all groups are included. Otherwise groups are listed
individually.
69
Pearl User Guide
Apply a configuration preset from the web interface
You may apply multiple presets one after another. If you apply two (or more) configuration
presets that include a particular configuration group, the settings (for that group) from the last
applied preset are the active settings. In short, last in wins.
To apply a configuration preset from the web interface:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Maintenance link in the Configuration menu; the maintenance page opens.
4. Scroll to the Configuration presets section.
5. Click Apply next to the configuration preset you wish to apply.
6. The system asks for confirmation before proceeding.
If the configuration preset includes the network or system configuration groups, a
reboot is necessary.
70
Pearl User Guide
Apply a configuration preset using the touch screen
7. Click OK to apply the configuration preset; the configuration preset is applied.
8. The system reboots if needed.
Apply a configuration preset using the touch screen
You can use Pearl's touch screen to apply configuration presets.
For configuration presets that only contain the network configuration group you can use either of the two
methods described below. For all other configuration presets, use the first method.
To apply a configuration preset via the touch screen:
1. If necessary, tap the screen once to turn it on or to turn on the screen overlay.
2. If the system settings button (gear) is still not visible and an i icon is visible instead, configuration by
touch screen is disabled in the system's settings. See Configure the touch screen to enable.
3. Touch the gear icon at the bottom right of the screen; the settings page appears.
4. Touch Configuration Presets; an alphabetically sorted list of saved presets is presented (Factory
default is always listed first). Each preset shows the included preset configuration groups via a list of
icons to the right of the preset name.
71
Pearl User Guide
Apply a configuration preset using the touch screen
5. If necessary touch the arrows at the bottom of the page to navigate to the desired preset.
6. Touch the name of the preset you wish to apply.
7. A confirmation message is displayed.
If the configuration preset includes the network or system configuration groups, a
reboot is necessary.
8. Click OK to apply the preset; the configuration preset is applied.
9. The system reboots, if required.
To apply a configuration preset that contains only the network configuration group you may use this process:
1. If necessary, tap the screen once to turn it on or to turn on the screen overlay.
2. Touch the gear icon at the bottom right of the screen; the settings page appears.
72
Pearl User Guide
Apply a configuration preset using the touch screen
3. Touch the Network line; the network configuration page opens.
4. Touch Network Presets; a list of saved configuration settings with only Network settings opens.
5. Touch the name of the preset you wish to apply; a confirmation message is displayed.
73
Pearl User Guide
Apply the Factory default configuration preset
6. Click OK to apply the network configuration preset and reboot the system.
Apply the Factory default configuration preset
Your Pearl comes with a special factory default configuation preset. This configuration preset cannot be
erased and is always presented at the top of the configuration presets list. It contains all six possible
configuration settings groups.
Using the Factory default configuration setting is similar to using the Factory reset method (see Perform
factory reset with a few important differences.
In short, the Factory default configuration preset is less destructive than Factory reset. This table
describes the exact differences.
Table 16 Factory default configuration preset vs Factory reset
Deletes all created channels
Factory default
configuration preset
ü
ü
ü
Deletes all recorded files in channels
Deletes all created recorders
Factory reset function
ü
ü
ü
Deletes all recorded files in recorders
Resets network configuration
ü
ü
Resets touch screen configuration
ü
ü
Resets user passwords
ü
ü
Deletes all created configuration presets
ü
74
Pearl User Guide
Update a configuration preset
Factory default
configuration preset
Factory reset function
ü
Deletes all branding files
Resets all Source settings
ü
ü
Deletes all Automatic file upload settings
ü
ü
To apply the factory default configuration preset, follow the instructions in Apply the Factory default
configuration preset or Apply the Factory default configuration preset and select the Factory default preset.
A reboot is required.
Update a configuration preset
If you need to update a configuration preset to include different configuration groups, or simply new settings
for the same groups, you can do so easily via the web interface.
To update a configuration preset:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Maintenance link in the Configuration menu; the maintenance page opens.
4. Scroll to the Configuration presets section.
75
Pearl User Guide
Delete a configuration preset
5. Find the preset you wish to change from the presets list.
6. Copy the name of the preset into the Name field.
7. Selected the desired configuration group(s) from the Sections group.
8. Click Save; a confirmation dialog asks you to confirm you want to overwrite the configuration preset.
9. Click OK; your configuration preset is updated in the list.
Delete a configuration preset
You may want to trim the list of configuration presets to only those that are needed for your ongoing needs.
You can delete all configuration presets at once by doing a factory reset, or you can delete individual
configuration presets from the Maintenance page.
To delete a configuration preset:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
76
Pearl User Guide
Configuration preset considerations
3. Select the Maintenance link in the Configuration menu; the maintenance page opens.
4. Scroll to the Configuration presets section.
5. Click delete (x) next to Apply for the configuration preset; a confirmation message appears.
6. Click OK to confirm you want to delete the preset; the preset is deleted.
Configuration preset considerations
Configuration presets are groups of settings applied to the system, leaving other settings intact. The following
considerations will help you get the most from your configuration presets.
Channel and recorder index number behavior
Each channel and recorder has an index number. The first channel created on a system is channel 1,
subsequently channel 2, 3, 4, etc. Recorders are also created starting at index 1 with numbers incrementing as
new recorders are created. The channel (or recorder) index number is found to the left of the channel or
recorder name in the web interface:
77
Pearl User Guide
Configuration preset considerations
Configuration presets that contain the channels configuration group specify the channels in the preset by
their index number. This means if you have channels 1, 2, 3 and 4 when you save your preset, applying that
preset will overwrite the configuration of your current channels with indexes 1, 2, 3 and 4. If prior to applying
that preset you also had channels with indexes 5 and 6, the configuration settings for those two channels are
when the preset is applied (because the preset only has 4 channels).
There are three areas where channel (and recorder) index numbers affect what happens when applying
configuration presets. Read Recording StateRecorded files (in channels and recorders) and Deleting channels
for more information.
Recording State
The Configuration preset considerations section of this chapter shows that each channel and recorder's
recording state is included in the channels configuration group. This means that if a channel (or recorder) is
recording at the time you create a configuration preset, it will immediately start recording when you apply that
preset. Similarly, if a configuration preset is saved when channels or recorders are not recording, those
channels and recorders will not be recording when the preset is applied (this means a channel or recorder may
stop recording as a result of applying the preset).
For example, when applying a preset with channel 3 set to record:
l If channel 3 exists prior to applying the preset and is already recording, the file will continue recording
uninterrrupted unless the recording file type is different in the preset (in which case a new file is
started).
l If channel 3 exists prior to applying the preset and is not already recording, it immediately begins
recording.
l If no channel with index 3 exists prior to applying the preset, the channel is created and it immediately
begins recording.
78
Pearl User Guide
Configuration preset considerations
Recorded files (in channels and recorders)
Channels and recorders keep a list of files recorded in their Recordings section of the web interface. These
files remain on the system even if the channel or recorder configuration is changed or removed as a result of
applying a configuration preset.
For example, prior to applying your configuration preset, you have channels with indexes 1, 2 and 3; each of
these has five recording files. When you apply a configuration preset that has channels with index 1 and 2
only, you'll notice those channels each still have the same 5 recording files. Channel with index 3 is no longer
present, but the files are not lost!
Overwritten channel files are still available. To access and download/delete these recorded files, enter the
following into the address bar: http://<deviceIP>/admin/channelN/archive or
http://<deviceIP>/admin/recorderN/archive, where N is the index of the removed channel/recorder.
For example, if a Channel with index 3 is no longer present, its corresponding files can be accessed by
entering the following into the address bar:
l http://192.168.0.183/admin/channel3/archive
If you now create a new channel with index 3 (or load a preset that contains a channel with index 3), you'll find
it starts with five recorded files in the Recordings section. These are the same recorded files that existed at
the start of this example.
Furthermore, if you delete any of the recordings, you are deleting the only instance of those files. Using our
previous example, if you delete one of the five recordings from channel index 1, you'll find that even after
applying different presets channel 1 will have only four recorded files.
Deleting channels
Recorded files are stored on the system based on their channel or recorder number. All files saved for channel
index 1 are in one folder, and all files for recorder index 2 are in another. When you delete a channel (or
recorder), you permanently delete all recordings for that channel (or recorder) even if those recordings were
made while a different preset is applied.
Note applying a configuration preset with a different set of channels or recorders is not the same
as deleting a channel.
When deleting a channel or recorder that has recorded files, the web interface warns you of other
configuration presets that use the same channel or recorder index numbers. When you see this prompt, we
recommend you take a moment to look through the Recordings list to make sure you're OK to proceed with
permanently deleting all the recorded files.
79
Pearl User Guide
Configuration preset considerations
Branding content
The channels configuration group includes the filenames for logos and backgrounds used in the currently
configured channels. It does not include the image files. Therefore it is important to make sure that between
uses of different channel-related configuration presets you do not delete or replace files listed in the
Branding Content section of the web interface. There is currently no configuration group that includes the
Branding Content files.
EDIDs
EDIDs are uploaded and immediately applied to a specific source. This change remains in place until the user
uploads a new EDID or requests the factory EDID is applied by using the Restore default EDID button (see
Force the capture card to use a specific EDID
If you apply a preset that needs a special EDID, be sure to remember to upload that EDID after applying the
configuration preset.
Configuration presets are not user profiles
Configuration presets should not be confused with the concept of user profiles. Specifically, the following
issues arise from trying to use configuration presets as user profiles:
l recorded files are not removed between application of configuration presets (users could see each
other's files)
l configuration presets can be overwritten and deleted with no password (users could affect each other's
presets)
l branding and recorded files can be deleted, affecting more than just the currently applied configuration
presets (users could erase branding or recordings belonging to other users)
l applying a configuration presets does not clear the settings from groups not part of the preset (user
information is not private)
80
Pearl User Guide
Configuration preset considerations
Touch screen considerations
The touch screen configuration group includes all the security settings for the touch screen. One such
setting is the ability to use the touch screen. It is therefore possible to apply a preset via the touch screen that
effectively locks out any further use of the touch screen. If this happens accidentally, use the web interface to
re-enable the touch screen (see Configure the touch screen).
81
Pearl User Guide
Configure date and time
Configure date and time
Pearl uses the current date and time in naming recorded files and when synchronizing and timestamping
inputs from multiple sources (i.e. when synchronizing an audio and a video source). The admin interface lets
you specify date and time settings to ensure they are correctly configured for your time zone and your
network.
This section covers the following date and time-related topics:
l Verify date and time via the touch screen
l Verify date and time settings
l Change the time zone
l Configure synchronized time (NTP, PTP v1, and RDATE)
l Configure a Local NTP Server
l Configure the date and time manually
Verify date and time via the touch screen
Pearl's touch screen interface, if enabled, can quickly and easily show you the system's date and time settings.
To show system information (including date and time) on the touch screen:
1. If the system information button (i) does not appear on the screen, tap the screen once to turn on the
control buttons.
2. If the system information button (i) is still not visible, it is disabled in the system's Touch screen
configuration. See Configure the touch screen to enable system information.
3. Touch the system information button (i) on the screen; the system information screen appears.
To close the system information screen:
1. Touch anywhere on the screen to return to the previous screen.
82
Pearl User Guide
Verify date and time settings
Verify date and time settings
The current date, time, time zone, and synchronized time protocol settings are shown when the Date and
Time configuration page is loaded in the Pearl web interface.
To view settings on the date and time configuration page:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Date and Time link in the Configuration menu; the date and time configuration page opens
and the following information is displayed:
The date and time configuration page also indicates whether the system is currently using synchronized or
manually set time, and whether or not a local network time protocol (ntp) server is running.
The following table describes the date and time configuration fields.
Table 17 Date and Time Options
Label
Description/Options
Time Zone
The currently selected time zone.
Enable time syn-
Whether or not a time synchronization protocol is being used for setting time. (If not
chronization
selected, time is set manually.)
Protocol
The time synchronization protocol.
Service IP Address The time synchronization server address.
Set time manually
Date
Whether or not time is set manually. (If time is not being set manually, a time synchronization protocol is used.)
The current date. (This is the current date even if the radio button Set time manually is
not selected.)
83
Pearl User Guide
Label
Configure synchronized time (NTP, PTP v1, and RDATE)
Description/Options
The current time. (This is the current time even if the radio button Set time manually is
Time
not selected.)
Configure synchronized time (NTP, PTP v1, and RDATE)
By default Pearl uses the network time protocol server (NTP server) protocol and a time server from National
Research Council Canada. You can continue to use this time server or configure a new server that is more
appropriate for your network and location. Your system administrator can provide the correct time
synchronization server settings.
To set the time synchronization method:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Date and Time link in the Configuration menu; the date and time configuration page
opens.
4. Click the Enable time synchronization radio button if it is not already selected.
5. Choose one of the following choices from the Protocols drop down:
Table 18 Synchronized Time Options
Label
Description/Options
Network Time Protocol (NTP) is used for clock synchronization over the internet.
NTP
There are many publicly available NTP servers you can use, or your company may
have its own NTP server. For more information about NTP and to find
NTP servers, refer to http://support.ntp.org/bin/view/Servers/WebHome.
RDATE is a tool for querying the current time from the network. It is generally
RDATE
considered obsolete and has been replaced by NTP. It's offered here for backwards compatibility with older timekeeping systems.
The Precision Time Protocol (PTP) is used for clock synchronization over the inter-
PTP v1
net. It has clock accuracy in the sub-microsecond range, making it more granular
than NTP.
6. Tailor the synchronization protocol with the required parameters as described below.
7. If NTP is selected:
a. Enter the IP address or server name for the NTP server in the Server IP Address field.
84
Pearl User Guide
Configure the date and time manually
NTP uses UDP packets and port 123. If the system is behind a firewall and accessing an
external NTP server, UDP packets must be permitted on port 123.
8. If RDATE is selected:
a. Enter the IP address or server name for the RDATE server in the Server IP Address field.
b. Select an update interval from the drop down box.
9. If PTP v1 is selected:
a. Select the multicast address of PTP v1 server from the PTP domain drop-down.
PTP Domain
Description
Default
PTP at multicast address 224.0.1.129
Alternative 1
PTP at multicast address 224.0.1.130
Alternative 2
PTP at multicast address 224.0.1.131
Alternative 3
PTP at multicast address 224.0.1.132
PTP uses UDP packets and ports 319 and 320 . If the system is behind a firewall and
accessing an external PTP server, UDP packets must be permitted on ports 319 and 320.
10. Click Apply.
Configure the date and time manually
By default Pearl uses NTP for time synchronization. If your system does not have access to a time
synchronization server, or if you do not wish to use one, you can choose to manually set the date and time.
To manually set the date and time:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Date and Time link in the Configuration menu; the date and time configuration page
opens.
4. Type the desired date in the Date field. Use the format yyyy-mm-dd.
85
Pearl User Guide
Change the time zone
5. Type the desired time in the Time field. Use the format hh:mm:ss.
6. Click Apply.
Change the time zone
By default the system has the Canada/Eastern time zone set. Configuration of the time zone is necessary to
ensure synchronized time servers provide the correct time to the system.
To select another time zone:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Date and Time link in the Configuration menu; the date and time configuration page
opens.
4. Select the new time zone from the Time Zone drop down box.
5. Click Apply.
Configure a Local NTP Server
Pearl can run a local NTP server.
To configure a local NTP server:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Date and Time link in the Configuration menu; the date and time configuration page
opens.
4. Select the check box Enable local NTP server.
86
PART 2: Capture
Capturing is the process of taking the signals from your video and audio sources and encoding them in a
format that is ready for streaming and recording.
If you followed the quick start guide, you're already capturing, streaming and possibly recording your sources.
The section of the guide helps you fine tune and troubleshoot the capturing process.
When using Pearl, you can stick to all the default capture and encoding settings, or you tweak them to set the
up exactly as you like.
You can capture a single source at once, capture multiple sources in a custom channel or even switch between
sources or groups of sources (layouts) while streaming and recording.
Techniques for creating channels to capture, stream and record a single source; to create custom channels
with multiple sources and multiple layouts; and how to switch layouts while capturing are all described in this
section.
The chapters in this section are:
l Channels
l Live video mixing / switching
l Sources
l Troubleshooting
87
Pearl User Guide
What is a channel?
What is a channel?
Pearl uses Channels to organize and display content captured from DVI, VGA, HDMI, SDI, and audio.
Channels make your sources (DVI, VGA, HDMI, SDI, and audio) available for streaming and recording. You
choose how you want to configure your sources (and extras like images and text overlays) to into layouts
within your channel.
Pearl gives you a lot of control over how your sources are streamed. You are not limited to creating a Channel
list that is a one-to-one reflection of your Sources list. You can make channels from some or all of your
sources and your can add the same source to multiple single-source or multi-source layout channels.
For example, you could use the same source in all three of these situations, concurrently:
- as the only source in Channel 1 at 1080p, 30fps, 10,000 kbps;
- as the only source in Channel 2 at 720p, 15 fps, 2,000 kbps;
- and added to Channel 3 as part of a multi-source layout with picture in picture.
All channels can be streamed and recorded simultaneously. Following the example above, you could record
any combination of those three channels, and stream one, two, or all three of them using any available
streaming methods.
In addition to creating multi-source channels, you can customize your channels by adding a images, company
information, corporate colors and time stamps. Pearl has a visual layout editor to help you create exactly the
layout you want to stream.
For each channel you create, you can use the layout editor to create one or more channel layouts. Then, while
recording and/or streaming, you can switch live between different layouts. To learn about creating layouts,
read Create a custom channel and Custom channel layout editor. To learn how to do live video mixing / live
video switching, see Live video mixing / switching.
Through channel configuration and fine tuning you can maximize your stream quality, minimize your
processing requirements and bandwidth. You can also specify how the video is presented and streamed to
sharing destinations and viewers. Topics in this section include:
l Use the automatic channels Auto A and Auto B
l Create a simple channel
l Configure encoding
88
Pearl User Guide
Use the automatic channels Auto A and Auto B
l Create a custom channel
l Custom channel examples
l Custom channel layout editor
l Add a video source (custom channel)
l Add an audio source (custom channel)
l Add an image (custom channel)
l Add a text overlay (custom channel)
l Live video mixing / switching
l Preview a channel
l Delete a channel
l Rename a channel
While configuring channels, consider opening a live preview of the channel in another tab or browser window
so you can see the changes as they are applied, refer to Preview a channel.
Use the automatic channels Auto A and Auto B
To get you started as quickly as possible, Pearl comes pre-configured with two channels: Auto A and Auto B.
To use these channels, simply plug a source into one of the Row A inputs and, if desired, a second source into
one of the Row B inputs. The system automatically configures the channel's frame size to match the source
resolution and calculates the best frame rate and bit rate.
In release 3.15.1 there is no audio automatically assigned to auto channels. Add audio manually
using the instructions Add an audio source (custom channel).
You can start viewing the channel immediately on the touch screen display (if enabled) or by using a browser
on a computer on the same LAN or network. Browse to the following URL:
For Auto A: http://<serial>.local/preview.cgi?channel=1
For Auto B: http://<serial>.local/preview.cgi?channel=2
For example:http://d560515f.local/preview.cgi?channel=2
Or, if Bonjour services (which permit browsing by serial number) are not installed on the computer you can
obtain the IP address from the touch screen display, if enabled, and browse to:
89
Pearl User Guide
Use the automatic channels Auto A and Auto B
For Auto A: http://<IP Address for Pearl>/preview.cgi?channel=1
You find alternate connection streams (i.e. RTSP or MPEG-TS) and can further configure these channels by
logging into the admin interface and accessing Auto A and Auto B by the links under the Channels menu.
You can delete the Auto A and Auto B channels, but they will re-appear upon factory reset or
when loading the default configuration profile.
Know which signal is used for Auto-A or Auto-B
Pearl has video input sensing, meaning it knows when there is a video signal coming through from an attached
source.
If you attach more than one source to a row prior to powering on Pearl, the following priority is used:
Priority
Connector Type
1
HDMI
2
SDI
3
VGA The auto channel uses a source until the source has no signal, then switches to the highest priority signal
found.
For example, if you attach SDI, then VGA and TRS cables to Row A of your Pearl, Auto A will show
SDI and use SDI audio until such time as the SDI video signal is lost. At that time Auto A switches to
VGA video.
If you then connect HDMI to Row A (so you now have something connected to each video/audio port
on Row A) and the VGA signal is lost, Auto A displays HDMI and uses HDMI audio as it is the highest
priority signal.
If all the connected sources lose signal at the same time (i.e. for the example above when SDI loses video
signal, no video signal is found on the VGA source) no change is made and the auto channel continues to use
the current source. In this case, a no signal image is displayed for viewers.
90
Pearl User Guide
Use the automatic channels Auto A and Auto B
Configure auto channels
Auto channels are included with Pearl to make setup quick and simple. However if you want to set custom
encoding or streaming configuration for the channel, you can configure it like any other channel.
To further configure automatic channels Auto A and Auto B:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Scroll to the Channels section.
4. Click Auto A or Auto B from the Channels section; the channel's status page opens.
5. Configure the channel as you would any other channel. See below.
You can change the source used for the two auto channels by selecting a different source from
the layout editor in the Sources page. When you do this, the channel name changes to reflect the
new source (if that is the only source is used for the channel). No auto switching is performed.
This is desirable if you know, for example, that you will always use SDI video with TRS audio and
you never need the automatic switching capabilities of the auto channels.
91
Pearl User Guide
Create a simple channel
Create a simple channel
Channels arrange the output from sources into a viewable and recordable stream. Although there are may
ways you customize a channel, this procedure walks you through the most basic channel setup with a
single source. For multiple-source channels and advanced layout editing see Add channel metadata. (You
can always update this channel later to use multiple sources or multiple layouts.)
After creating this channel you'll be ready to stream it using the system default settings. Instructions to
configure encoding, branding, and CDN Streaming are described in separate procedures.
To create a simple channel:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Ensure a DVI, HDMI, VGA or SDI input source is connected to the device and you know the name of the
source it is connected to. If you're not sure, see What is a source?.
4. From the web interface, scroll to the Channels menu option. A list of existing channels, if any is
displayed.
5. Click Add channel located at the bottom of the list; the Sources page opens.
6. You're automatically editing the Default layout in the channel layout editor. (By default a 16:9 visual
layout editor with a black background is shown.)
92
Pearl User Guide
Create a simple channel
7. Click Add new itemto add a layer to the layout; a drop down appears allowing you to choose the kind
of item to add to your layout.
8. Select Video Source from the drop down; the new item is added to the layout and the Source settings
box appears on the right side of the page.
93
Pearl User Guide
Create a simple channel
9. Click the Source drop down and select your source; your source appears in the visual layout editor
above.
10. For best results, keep the Keep aspect ratio when scaling checkbox checked in the Source
settings box.
11. Use the red and white source handles in the visual editor to stretch your image to the full size of the
layout.
94
Pearl User Guide
Create a custom channel
12. If audio is desired, scroll down and choose an audio source from the displayed list.
13. Click Save at the lower right corner of the page; the layout changes are saved.
Because this is a single-source channel with only one layout, the channel's name is updated
to display the source’s name next time you view the channel. Click the channel name to
refresh and view this if desired, if desired. If you wish to change a channel's name directly,
see Rename a channel.
Your channel is ready for basic streaming and recording.
By default (on a new channel), when the source doesn't have a 16:9 aspect ratio, the system
automatically detects the correct aspect ratio and updates the layout after you leave and return
to the layout editor screen. This happens because the encoding page has the Use current signal
resolution as frame size setting selected by default. If you want to change the aspect ratio for
your channel, see Configure encoding .
There are a lot of creative things you can do next with your channel, including creating more layouts and
editing this layout to add images and more sources. See Create a custom channel.
Create a custom channel
Pearl has two styles of channels.
1. Simple channels with a single source that fits the full screen, as discussed in Create a simple channel
2. Custom channels with one or more layouts, sources, background matte color and images.
95
Pearl User Guide
Create a custom channel
Both types of channels are created using the same interface. In fact, custom channels are the same thing as
simple channels, but they're called out separately in this manual because they are more complex. We call a
channel a custom channel (or custom layout channel) when is has multiple sources, image elements, multiple
layouts, or any combination of those items.
So the only distinction between simple channels and custom channels is whether you choose to add any extra
elements to the channel.
When making simple channels, your source takes up the whole screen, but with custom channels, you can
organize sources, pictures and text overlays in different locations on your screen. We call these layouts, and
each custom channel you create can have multiple layouts.
If you want to change the way things appear in your stream while streaming (aka video switching or video
mixing), you'll need to create one layout for each of the views you want for your stream. Later, while you are
streaming, you can switch live between the layouts using the web UI or Pearl's touch screen.
If you're planning to do live switching with your channel, we recommend you set the frame size to
a fixed size instead of using the default automatic detection of source frame size. Setting the
frame size to a fixed value ensures you don't experience any stream interruptions if the source
frame size changes due to layouts that contain a single source that has a different frame size than
those in other layouts.
As you saw when creating a simple channel, the first thing you need to do is create your (first) layout. Before
getting started with custom channel layouts we recommend you review the Custom channel layout editor and
get some inspiration from our Custom channel examples. Then use the remaining topics in this section to help
you create and configure your perfect custom channel layout(s)!
l Create a custom channel or layout
l To upload an image
l Delete an uploaded image
l Add an image (custom channel)
l Add a video source (custom channel)
l Add an audio source (custom channel)
l Set the background color (custom channel)
l Add a text overlay (custom channel)
l Delete or move a layout (custom channel)
l Rename a layout (custom channel)
Once you have your layouts created, read about Live video mixing / switching to learn how to change between
layouts while streaming and/or recording.
96
Pearl User Guide
Create a custom channel
Each layout you add to your channel adds a bit of overhead on Pearl - and more complex layouts
take more resources. So it's a good idea to make sure you delete any layouts you're not using.
Custom channel layout editor
The visual channel layout editor gives you full control on size and position of the pictures, sources and text
overlays you add to your channel.
You can edit existing channel layouts (even ones you initially created as simple channels) or you can create a
new channel or a new layout within a channel to work with. To add a new layout, see Create a custom channel
or layout.
To select a layout for editing:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select your channel from the channels menu and click Sources for the channel.
4. Select the layout you want to edit by clicking anywhere in the layout row; the layout editor shows the
current state of the selected layout for your channel and the row for the layout you're editing is
highlighted green.
5. If this is a new layout, you are presented with an empty layout area and a black background matte.
The Sources page and channel layout editor is broken into a few pieces.
97
Pearl User Guide
Create a custom channel
Layout selector
First there is the layout selector. From here you can pick which layout to preview/edit, create a new layout,
delete a layout or select which layout is active.
Visual channel layout editor
Next is the channel layout editor where you can add pictures, sources and text overlays to your layout. You
can also choose the background matte.
Note there is currently no way to change the order of items added (we're working on it!) so you need to build
from the bottom up. First add a background image (if you want to use one), then your sources, and lastly any
text or picture overlays.
98
Pearl User Guide
Create a custom channel
The heart of the channel layout editor is the layout area, which has the same frame size and aspect ratio as
your stream. As you add items to the layout, they appear in the layout area. The currently selected item is
presented in full colour while other items appear transparent.
To position the items you can use the mouse to click and drag, or you can use the manual positioning values
to set a location as a percent of the screen (by typing a value followed by the percent sign, e.g. 4%) or in pixels
(by typing a value followed by px, e.g. 16px).
You can resize items by clicking and dragging the red and white circles at the corners of the items or by using
the manual positioning values. For example entering 0% in all four of the outside boxes will stretch the item to
the full size of the layout area.
You can modify the settings for each item by clicking the row. The item's settings box appears. See Add an
image (custom channel), Add a video source (custom channel) and Add a text overlay (custom channel) for
more details on item settings.
Audio source selector and save button
The last section of the Sources page is the audio selector and the (very important) Save button.
99
Pearl User Guide
Create a custom channel
Select the audio source(s) you want to add to your channel. Sources are mixed at equal levels. If you have one
source it's added at 100% it's volume. With two audio sources, each is added at 50%, and so on.
When you're done all your changes, use the Save button to save the changes to your layout.
If you accidentally try to leave the layout without saving, Pearl reminds you to save before leaving.
Ready to make some layouts of your own? Try these topics:
l Create a custom channel or layout
l Add a video source (custom channel)
l Add an audio source (custom channel)
l Add an image (custom channel)
l Add a text overlay (custom channel)
l Delete or move a layout (custom channel)
l Set the background color (custom channel)
l Rename a layout (custom channel)
Custom channel examples
Here are a few examples of what you can do with just two sources and two picture files. Use your imagination
to create the layouts you want!
100
Pearl User Guide
Layout example
Create a custom channel
Description
One source, at the full size of the channel.
(Simple channel)
To get this look: Add one source to the
layout, select keep aspect ratio and
stretch to fit the full layout size.
One source, with a green background
matte.
To get this look: Select a background
color. Add a source to the layout and size
appropriately, leaving the background
matte visible.
One source with a logo (.png with
transparency) in the bottom left corner.
To get this look: Upload an image with
transparency through the Branding
Content page. Follow the steps from the
first example to add the source, then add
a picture item and place it where desired.
101
Pearl User Guide
Layout example
Create a custom channel
Description
One source with a text overlay in the
bottom right corner.
To get this look: Follow the steps from
the first example to add the source, then
add a text overlay item to the layout.
Enter your text in the settings box and
place it where desired.
One source with a background image.
To get this look: Upload your
backround image (must have the right
aspect ratio) through the Branding
Content page. When creating the layout,
first add the picture and stretch it to the
full screen. Next, follow the steps from
the first example to add the source.
Two sources with a background image.
To get this look: Follow the steps for
the example above, then add and
position a second source.
102
Pearl User Guide
Layout example
Create a custom channel
Description
Two sources (one cropped to a new
aspect ratio), a background image and a
logo.
To get this look: Upload your
background and logo images through the
Branding Content page. When creating
the layout, first pick the background, then
the sources, and lastly the logo. Size and
position each. For the second source, click
"cropping" in the source settings and
select the desired crop.
A few more examples, this time including a 4x3 source.
Layout example
Description
One source, at the full size of the channel.
(Simple channel)
To get this look: Add one source to the
layout, select keep aspect ratio and
stretch to fit the full layout size. (Note the
channel broadcasts in 4x3 if you have
Use current signal resolution as
frame size selected on the encoding
page.)
One 4x3 source in a 16x9 frame, with a
green background matte.
To get this look: Make sure your
encoding page has a 16x9 frame size.
From the sources page, select a
background color. Add a source to the
layout and stretch to the full height of the
screen, leaving the background matte
visible.
103
Pearl User Guide
Create a custom channel
Layout example
Description
A 4x3 source and a cropped 16x9 source
together with a background image.
To get this look: Upload an image with
transparency through the Branding
Content page. Follow the steps from the
first example to add the sources and use
the crop utility to crop the second source
to a square aspect ratio.
Time to get started on your own layouts! See:
l Create a custom channel or layout
l Custom channel layout editor
Create a custom channel or layout
We call a channel a custom channel (or custom layout channel) when is has multiple sources, image elements,
multiple layouts, or any combination of those items. Custom layouts give you full control on size and position
of the pictures, sources and text overlays you add to your channel.
Use this procedure to help you create a new channel or layout, then use the related procedures to add
elements to your layout.
If you're planning to use live switching, we strongly recommend you rename the channel rather
than using the default channel name (Rename a channel). See the note at the bottom of this
topic to avoid streaming and recording issues resulting from adding or deleting layouts when live
switching.
To create a new custom channel (with default layout) or add a layout to an existing channel:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Do one of the following to make the Sources page appear:
a. select your channel from the channels menu and click Sources for the channel; or
b. select the Add channel link to create a new channel.
104
Pearl User Guide
Create a custom channel
4. Next, pick one of the following actions to create or select a layout to edit:
a. select the layout you want to edit by clicking anywhere in the layout row; or
b. click Add Layout to create a new layout.
5. The layout editor shows the current state of the selected layout for your channel and the row for the
layout you're editing is highlighted green.
6. If this is a new channel or layout, you are presented with an empty layout area with a black background
matte.
Now that you've created your layout, you can start adding items to it. See these topics:
l Add a video source (custom channel)
l Add an audio source (custom channel)
l Add an image (custom channel)
l Add a text overlay (custom channel)
l Delete or move a layout (custom channel)
l Set the background color (custom channel)
l Rename a layout (custom channel)
Important note for channels with multiple layouts
By default (and historically), Pearl's channels are named automatically based on the content in the channel.
When a channel has only one layout, and that layout has only one source (regardless of whether or not there
are pictures or overlays in the layout), the channel name is the same as the source name
105
Pearl User Guide
Create a custom channel
For example: By default, a channel with only layout that has only HDMI-A in it will be named HDMI-A.
When you add a second layout to a channel, the channel name changes to a generic name Channel X (where
X is the channel index number). Normally this wouldn't pose any problem, but the changing name does have
some side effects: the stream is stopped and restarted, and the channel's recorder (if recording) is stopped
and a new file is started.
Furthermore, when you delete layouts in a channel until there is only one layout (with one source) left, the
channel name reverts to the source name.
To avoid any issue with changing channel names on channels where you'll have more than one layout, we
strongly recommend you rename the channel to a custom name (Rename a channel. This will ensure no
automatic channel name changes.
Add a video source (custom channel)
To stream a source you need to add it to a channel. In the case of custom channels with layouts, you can add
one or more sources to the layout area.
You can add a source to a layout on an existing channel or you can create a new channel. If you're not sure
how to create a channel or a layout, start by reviewing the first few steps in the topic Custom channel layout
editor or start with Create a simple channel.
To add a source to your layout:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Follow the steps in Custom channel layout editor or Create a custom channel or layout to get to the
channel layout editor.
4. From the channel layout editor, click Add item; a drop down box appears. (If you have any other items
already in your layout, the new item appears at the top of the list.)
106
Pearl User Guide
Create a custom channel
5. Select Video Source from the drop down; the new item is added to the layout and the Source settings
box appears on the right side of the page.
6. Click the Source drop down and select your source; your source appears in the visual layout editor
above.
7. For best results, select the Keep aspect ratio when scaling checkbox from the Source settings
box.
8. If desired, select Crop from the Source settings box and use the red and white handles to draw a box
around the section of the source you'd like to have in the layout; your cropped selection changes in the
layout area.
107
Pearl User Guide
Create a custom channel
9. Moving back to the layout area, use the mouse, the keyboard or the manual position value fields to
position and resize your source. You can click and drag, stretch using the handles in the layout area, or
type values into the fields. See the note below for more information.
10. If needed, re-order the items in your layout by clicking and dragging items in the item list (under the
Add new item link).
For example, if you added your video source over a text overlay, the video source could conceal
the overlay. To fix it, drag the video source item below the text item in the list, or vice-versa.
11. When your layout is complete, scroll to the bottom of the page and click Save to save your work.
Other things you may want to add to your layout:
l Add an audio source (custom channel)
l Add an image (custom channel)
108
Pearl User Guide
Create a custom channel
l Add a text overlay (custom channel)
l Delete or move a layout (custom channel)
l Set the background color (custom channel)
l Rename a layout (custom channel)
A note about item positioning and sizing
There are four ways to position and size items in the layout area
1. using the mouse
2. using the keyboard
3. using the manual positioning values with percents
4. using the manual positioning values with pixels
To use the mouse:
Click and drag to move the item. Click and drag the red and white circles to resize the item as you wish.
Using this method you can make quick changes that are in increments of approximately 5% of the
width or height of your layout area. For more refined movements, hold the down the Ctrl key on your
keyboard while dragging the item with the mouse.
To use the keyboard:
Use the arrow keys on the keyboard to move the item up, down, left or right in the layout. Changes are
in increments of approximately 5% of the height or width of the layout area. Make more refined
movements by holding down the Ctrl key on your keyboard while pressing the up, down, left or right
keys. You can also hold the Shift key while using the arrow keys to control the size of the item on the
layout. Hold both Ctrl and Shift for fine-grained size control.
Using percents:
Specify a whole number, followed by a percent sign (e.g. 4%) in any of the manual positioning fields.
The image will move and resize to honor the space you specified. For example to move the item in 12%
from the left side of the layout area, enter 12% in the bottom left positioning value square. The image
will resize to accomodate your change. If you further enter 15% in the bottom right positioning value
square, the image will be centered and take up 76% of the width of the layout area.
Using pixels:
If you need to specify an exact amount in pixels (rather than percent) you can type a pixel value in any
of the positioning value squares followed by the characters px (e.g. 56px). You can mix and match
109
Pearl User Guide
Create a custom channel
pixels and percents changing only the boxes you want to use pixel values. At any time you can switch
back to percents by typing a percent.
Add an audio source (custom channel)
To stream the audio for a source you need to add it to a channel and make sure audio is enabled in the
channel's encoding page. (Audio is enabled in the encoding page by default.)
Audio must be added to each layout for your channel. You can use the same audio for each layout, or if you
desire, you can have different layouts use different audio. If you're not sure how to create a channel or a
layout, start by reviewing the first few steps in the topic Custom channel layout editor or start with Create a
simple channel.
To add an audio source to your layout:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Follow the steps in Custom channel layout editor or Create a custom channel or layout to get to the
channel layout editor.
4. Select the audio source(s) you want to add to your channel. Sources are mixed at equal levels. If you
have one source it's added at 100% it's volume. With two audio sources, each is added at 50%, and so
on.
5. When your layout changes are complete, scroll to the bottom of the page and click Save to save your
work.
6. Follow the steps in Configure audio codec to ensure audio is enabled for your channel and to select
your audio settings.
Other things you may want to add to your layout:
l Add a video source (custom channel)
l Add an image (custom channel)
l Add a text overlay (custom channel)
l Delete or move a layout (custom channel)
110
Pearl User Guide
Create a custom channel
l Set the background color (custom channel)
l Rename a layout (custom channel)
To upload an image
You can customize your channels by adding pictures as backgrounds, overlays or information. Collectively the
images you upload to the system are known as branding images.
For best results always upload images that are already the correct size needed in your layout.
Background images should match the frame size of your channel (frame size is set in the
Encoding configuration page).
There are two ways to upload branding images. You can upload images to the branding page, as described in
this procedure, or you can drag and drop images using the procedure described in Add an image (custom
channel). Note that using the procedure below is the only way to see whether or not you'll be overwriting an
existing image.
To upload a branding image to the branding page:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Click Branding Content under the Configuration menu; the configuration page opens.
111
Pearl User Guide
Create a custom channel
4. Click Choose File; a browser page opens.
5. Navigate to the folder on your admin computer that contains the logo.
6. Select the file, the following file formats are supported: PNG and JPEG.
The maximum supported file size is 3840×2160. No warning or error message is displayed
if your image is too large. Files that exceed the maximum size do not appear in the dropdown list when selecting an image.
7. Click Open; the file is added to the File/template to upload field.
8. Click Upload; the file is uploaded and displayed in the Other files section.
112
Pearl User Guide
Create a custom channel
9. See the following topic to learn how to apply the logo, background or other image to a channel:
l Add an image (custom channel)
Add an image (custom channel)
You can use images in your custom channel layouts to create a background for your source, to add your
corporate logo, or to add relevant information about the event you're streaming.
Pearl supports png (PNG)and .jpg (JPEG) images. You can upload any image to a maximum size of
3840×2160, however it's strongly recommended that you upload exactly the size you need to avoid having
your image scaled.
In earlier releases, there were separate procedures for adding backgrounds and logos to a channel. These
actions are now both considered adding an image to a custom channel layout and can be accomplished with
the steps below.
You can add a picture to a layout on an existing channel or you can create a new channel. If you're not sure
how to create a channel or a layout, start by reviewing the first few steps in the topic Custom channel layout
editor or start with Create a simple channel.
To add a picture to your layout:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Follow the steps in To upload an image or Create a custom channel or layout to upload your image, if
not already uploaded. If you like, you can also use the drag and drop technique described below.
4. Follow the steps in Custom channel layout editor to get to the channel layout editor.
5. From the channel layout editor, click Add item; a drop down box appears. (If you have any other items
already in your layout, the new item appears at the top of the list.)
113
Pearl User Guide
Create a custom channel
6. Select Picture; the Picture Settings section appears on the right side of the page.
7. If you haven't already uploaded your image, you can drag and drop it from your desktop to the grey
Please select picture box. (Note: no warning is displayed if the image is too large or will replace
another file).
8. If you have already uploaded the image, click the Use image drop down to select an image you have
uploaded to the system;
9. Your picture appears in the Picture settings preview and is added to the layout area. It is selected for
sizing and positioning.
(If your uploaded image does not appear in the list, ensure it doesn't exceed the maximum
file size of 3840×2160.)
114
Pearl User Guide
Create a custom channel
10. For best results, keep the Keep aspect ratio when scaling checkbox selected in the Picture
settings box. (This is selected by default.)
11. In the layout area, use the mouse, the keyboard or the manual position value fields to position and
resize your image. For background images, click and drag to fill the full layout area. See the note below
for more information on positioning techniques.
12. If needed, re-order the items in your layout by clicking and dragging items in the item list (under the
Add new item link).
For example, if you added your background image after adding a video source, the background
image conceals the video source. To fix it, drag the video source item above the background
image item in the list, or vice-versa.
13. When your layout is complete, scroll to the bottom of the page and click Save to save your work.
Other things you may want to add to your layout:
115
Pearl User Guide
Create a custom channel
l Add a video source (custom channel)
l Add an audio source (custom channel)
l Add a text overlay (custom channel)
l Delete or move a layout (custom channel)
l Set the background color (custom channel)
l Rename a layout (custom channel)
A note about item positioning and sizing
There are four ways to position and size items in the layout area
1. using the mouse
2. using the keyboard
3. using the manual positioning values with percents
4. using the manual positioning values with pixels
To use the mouse:
Click and drag to move the item. Click and drag the red and white circles to resize the item as you wish.
Using this method you can make quick changes that are in increments of approximately 5% of the
width or height of your layout area. For more refined movements, hold the down the Ctrl key on your
keyboard while dragging the item with the mouse.
To use the keyboard:
Use the arrow keys on the keyboard to move the item up, down, left or right in the layout. Changes are
in increments of approximately 5% of the height or width of the layout area. Make more refined
movements by holding down the Ctrl key on your keyboard while pressing the up, down, left or right
keys. You can also hold the Shift key while using the arrow keys to control the size of the item on the
layout. Hold both Ctrl and Shift for fine-grained size control.
Using percents:
Specify a whole number, followed by a percent sign (e.g. 4%) in any of the manual positioning fields.
The image will move and resize to honor the space you specified. For example to move the item in 12%
from the left side of the layout area, enter 12% in the bottom left positioning value square. The image
will resize to accomodate your change. If you further enter 15% in the bottom right positioning value
square, the image will be centered and take up 76% of the width of the layout area.
Using pixels:
116
Pearl User Guide
Create a custom channel
If you need to specify an exact amount in pixels (rather than percent) you can type a pixel value in any
of the positioning value squares followed by the characters px (e.g. 56px). You can mix and match
pixels and percents changing only the boxes you want to use pixel values. At any time you can switch
back to percents by typing a percent.
Add a text overlay (custom channel)
Adding the date and time, channel name or other custom text as an overlay on your video is an easy way to
customize your stream.
You can add an overlay to a layout on an existing channel or you can create a new channel. If you're not sure
how to create a channel or a layout, start by reviewing the first few steps in the topic Custom channel layout
editor or start with Create a simple channel.
To add a picture to your layout:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Follow the steps in Custom channel layout editor or Create a custom channel or layout to get to the
channel layout editor.
4. From the channel layout editor, click Add item; a drop down box appears. (If you have any other items
already in your layout, the new item appears at the top of the list.)
5. Use the item type drop down box to select Text ; the Text settings box appears and the layout area is
updated with the text overlay.
117
Pearl User Guide
Create a custom channel
6. In the Text field, specify the overlay text you want to add to the layout. Use your own text and any
combination of the shortcut codes listed at the end of this procedure.
For example: Use this string:
%A %B %d, %G. Live streaming channel Auto A.
to obtain these results (Thursday February 26, 2015. Live streaming channel Auto A.):
7. Use the font drop down to select the size of your text.
8. For best results, select the Keep aspect ratio when scaling checkbox from the Text settings box.
(This is selected by default.)
9. In the layout area, use the mouse or the manual position value fields to position and resize your text
overlay. (You may first need to change the height of the text box handles before you can proceed with
resizing or positoning.) See the note below for more information on positioning techniques.
10. If needed, re-order the items in your layout by clicking and dragging items in the item list (under the
Add new item link).
For example, if you added your overlay text before adding a video source, the video source
conceals the overlay text. To fix it, drag the overlay text item above the video source item in the
list, or vice-versa.
11. When your layout is complete, scroll to the bottom of the page and click Save to save your work.
118
Pearl User Guide
Create a custom channel
Table 19 Time Format options
Field
Value
Example
date
%F
2012-01-26
year
%G
2012
month (01)
%m
01
month (Jan)
%b
Jan
month (January)
%B
January
day of the month
%d
26
weekday (Thu)
%a
Thu
weekday (Thursday)
%A
Thursday
time
%T
08:40:45
hour
%k
08
minute
%M
40
second
%S
45
millisecond
%#m
378
Other things you may want to add to your layout:
l Add a video source (custom channel)
l Add an audio source (custom channel)
l Add an image (custom channel)
l Delete or move a layout (custom channel)
l Set the background color (custom channel)
l Rename a layout (custom channel)
A note about item positioning and sizing
There are four ways to position and size items in the layout area
1. using the mouse
2. using the keyboard
119
Pearl User Guide
Create a custom channel
3. using the manual positioning values with percents
4. using the manual positioning values with pixels
To use the mouse:
Click and drag to move the item. Click and drag the red and white circles to resize the item as you wish.
Using this method you can make quick changes that are in increments of approximately 5% of the
width or height of your layout area. For more refined movements, hold the down the Ctrl key on your
keyboard while dragging the item with the mouse.
To use the keyboard:
Use the arrow keys on the keyboard to move the item up, down, left or right in the layout. Changes are
in increments of approximately 5% of the height or width of the layout area. Make more refined
movements by holding down the Ctrl key on your keyboard while pressing the up, down, left or right
keys. You can also hold the Shift key while using the arrow keys to control the size of the item on the
layout. Hold both Ctrl and Shift for fine-grained size control.
Using percents:
Specify a whole number, followed by a percent sign (e.g. 4%) in any of the manual positioning fields.
The image will move and resize to honor the space you specified. For example to move the item in 12%
from the left side of the layout area, enter 12% in the bottom left positioning value square. The image
will resize to accomodate your change. If you further enter 15% in the bottom right positioning value
square, the image will be centered and take up 76% of the width of the layout area.
Using pixels:
If you need to specify an exact amount in pixels (rather than percent) you can type a pixel value in any
of the positioning value squares followed by the characters px (e.g. 56px). You can mix and match
pixels and percents changing only the boxes you want to use pixel values. At any time you can switch
back to percents by typing a percent.
Set the background color (custom channel)
When you create a custom channel layout, you can select the background color to fill any unused space. For
example you can add a color from your corporate color scheme.
To add a picture to your layout:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
120
Pearl User Guide
Create a custom channel
3. Follow the steps in Custom channel layout editor or Create a custom channel or layout to get to the
channel layout editor.
4. From the channel layout editor, click the drop down arrow next to the existing (by default black)
background color; the color picker opens.
5. Pick a new color or type in an RGB value in the field; the color is updated in the layout area.
6. Click anywhere off the color picker to close the picker.
7. When your layout is complete, scroll to the bottom of the page and click Save to save your work.
Rename a layout (custom channel)
Layouts you create are automatically given a default name (the first one is Default!). You can keep these
names, or you can edit them to something more descriptive.
If you're using the touch screen for Live video mixing / switching
You can rename any layout, even the currently active layout.
To rename a layout:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Follow the steps in Custom channel layout editor or Create a custom channel or layout to get to the
channel layout editor.
4. From the layout picker, click on the row of the desired layout; the layout appears in the editor below.
121
Pearl User Guide
Create a custom channel
5. From the editor, click the name of the layout; it turns red.
6. Type in your new layout name and press Enter to save the new name. (Note if you click somewhere
else without pressing Enter, your changes are discarded.)
Delete or move a layout (custom channel)
Your custom channel can have multiple layouts. The order they are listed in the web UI is also the order they
are presented on the touch screen. It's simple to re-order layouts or erase layouts you're not using any more.
Reorder layouts
To move a layout:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Follow the steps in Custom channel layout editor or Create a custom channel or layout to get to the
channel layout editor.
4. Using the rows in the layout selector, click and drag to rearrange the order of your layouts.
Delete layouts
You can delete any layout except the currently active layout.
122
Pearl User Guide
Create a custom channel
If you're planning to use live switching, we strongly recommend you rename the channel rather
than using the default channel name (Rename a channel). See the note at the bottom of this
topic to avoid streaming and recording issues resulting from adding or deleting layouts when live
switching.
To delete a layout:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Follow the steps in Custom channel layout editor to get to the channel layout editor.
4. Click the X at the left side of the row for the layout you wish to delete; the system prompts you to
make sure you want to delete the layout.
5. Click OK to proceed; the layout is deleted.
Important note for channels with multiple layouts
By default (and historically), Pearl's channels are named automatically based on the content in the channel.
When a channel has only one layout, and that layout has only one source (regardless of whether or not there
are pictures or overlays in the layout), the channel name is the same as the source name
For example: By default, a channel with only layout that has only HDMI-A in it will be named HDMI-A.
When you add a second layout to a channel, the channel name changes to a generic name Channel X (where
X is the channel index number). Normally this wouldn't pose any problem, but the changing name does have
some side effects: the stream is stopped and restarted, and the channel's recorder (if recording) is stopped
and a new file is started.
Furthermore, when you delete layouts in a channel until there is only one layout (with one source) left, the
channel name reverts to the source name.
To avoid any issue with changing channel names on channels where you'll have more than one layout, we
strongly recommend you rename the channel to a custom name (Rename a channel. This will ensure no
automatic channel name changes.
123
Pearl User Guide
Configure encoding
Delete an uploaded image
Images used in custom channel layouts are stored on the system hard drive. You can delete an image after
you are done using it, or to when performing general housekeeping duties on the system.
To delete an uploaded image:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
If the image is used as part of the layout for any channel, select a different image or no
image by using the drop-down list in the Picture settings box within that channel's layout
before deleting the file using the steps below.
3. Click Branding Content under the Configuration menu; the configuration page opens.
4. Click Remove; a confirmation dialog box opens.
5. Click OK; the dialog box closes and the image file is removed from the configuration page.
Configure encoding
You can modify the encoding settings for each channel you create. These settings let you perfect your stream
by selecting the right frame size, bit rate, audio/video codecs, and more.
This section covers the following encoding topics:
l Configure video codec
l Configure frame size
l Fine tune stream settings
124
Pearl User Guide
Configure encoding
l Configure audio codec
l Codec and file format compatibility
Configure video codec
To configure encoding:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Click the Encoding link for your channel; the encoding configuration page opens.
4. Click the Codec drop-down menu to change the size and speed of the compression and decompression
and the quality of the image. Choose one of the following options from the Codec drop-down menu.
Value
H.264
Motion JPEG
MPEG-4
Description
H.264 is the default value and provides high quality video while using low bandwidth. This is the preferred codec for the system.
This is suitable for live streaming and video, however may have low quality
images while using high bandwidth. Motion JPEG does not support audio.
This may be suitable for presentations. Provides good image quality, while using
moderate bandwidth.
5. If the selected codec is Motion JPEG, you can configure the Page refresh time. Specifiy a time in a
seconds.
6. If the selected codec is H.264 (default), click Video encoding preset to define how the video stream is
encoded. Choose one of the following:
125
Pearl User Guide
Configure encoding
Value
Description
Hardware
This is the default H.264 encoding preset. Choose this setting for best per-
Accelerated
formance.
This matches the default from previous generations of Epiphan products. Choose
Software
this only if you need software encoding or X.264 encoding to match results created with previous generations of Epiphan products or firmware.
7. If the selected codec is H.264 (default), click Video encoding profile to limit or include video formats
that are supported. Choose one of the following:
Value
Baseline
Main
Description
Choose this option when streaming to an application that requires robustness
and cannot tolerate data loss, for example video-conferencing.
Choose this option for standard-definition broadcasts. This is the default.
Choose this option when video is viewed for broadcast and disk storage applic-
High
ations, particularly for high definition television application such as Blu-ray disk
storage format and HDTV broadcast service.
Video encoding profile and preset can be set only when the H.264 codec is selected.
8. If all your changes are complete, scroll to the bottom of the page and click Apply.
Configure frame size
By default, for channels with only one layout and when that layout has only one video source, your Pearl
automatically uses the incoming source frame size as the stream frame size. Frame size greatly affects the
amount of bandwidth needed to transmit your stream. The larger the frame size, the more bandwidth you
need to stream it. So you may want to keep the frame size the same as your source, or you may want to apply
upscaling, downscaling, stretching, or black bar framing, depending on your needs.
For example:
l if the input signal resolution is 1920×1080 (a 16:9 aspect ratio)
l and stream frame size is set to another 16:9 frame size such as 1280×720,
the smaller stream frame size causes the system to downscale the image and use less bandwidth to
transmit.
126
Pearl User Guide
Configure encoding
Or if you have a widescreen/HD format source but need a 4:3 output frame size, you can add black bars to
the top and bottom of the frame.
The system is designed to provide scaling, however for the best overall system performance
(particualrly when reaching maximum system capacity), configure your source to provide the
correct frame size and avoid scaling.
To configure your stream's frame size:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Click Encoding for the your channel; the encoding configuration page opens.
4. Scroll to the Frame size section.
5. Perform one of the following steps:
Using current signal resolution as the frame size only works for channel layouts with a
single source. If you're using multiple sources, follow the steps below to set your frame
size.
a. Check the Use current signal resolution as the frame size check box. Enabling this feature
greys out the other frame-size configuration fields. The system automatically streams at the
frame size of the input signal. If you change the frame size (resolution) of the input signal after streaming (or
recording) begins your may see interrupted streaming and recording. Enabling this
feature is not recommended for systems where input resolution is changed
frequently.
b. Change the frame size, follow the steps below.
6. Set the Frame size values to reflect the dimensions required for your stream. Some suggested values
cover popular resolutions of cameras and display devices such as monitors, but you may also specify
127
Pearl User Guide
Configure encoding
something custom:
a. Uncheck Use current signal resolution as frame size.
b. Type a frame size in the field; or
c. Select an option from the sizes shown, the dimensions will appear in the frame size field.
Scaling occurs automatically (no extra configuration needed) when you make the
dimensions larger, smaller, or a different aspect ratio than the source.
If your channel has a layout with only one source and your source and stream aspect ratios
differ, when viewing that layout, your source is centered in the frame and matte bars are
added to the top and bottom or left and right sides to make up the difference. See
Remove black bars (matte) from the video.
7. If all your changes are complete, scroll to the bottom of the page and click Apply.
If you plan to use layout switching during a live stream, it's best to choose a fixed layout size. This
avoids causing the stream restart due to frame size change when you switch between singlesource layouts that use frame sizes.
Fine tune stream settings
Along with video/audio codecs and frame size, there are other configurable stream settings that affect quality
and bandwidth. Like with frame size selection, values for these settings can be a tradeoff between bandwidth
available and quality for stream viewers.
A table at the end of this section provides additional guidance for the settings
To fine tune your stream's settings :
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
128
Pearl User Guide
Configure encoding
3. Click Encoding for the your channel; the encoding configuration page opens.
4. Scroll to the Key frame interval setting.
5. Click the Key frame interval drop-down box to choose how often a key frame (a frame that contains
all the pixels) is sent when streaming the video. The longer the key frame interval the smaller the video
file size, and vice versa.
6. If desired, change the Limit frame rate. The default should be adequate in most applications. While
decreasing the limit may improve system performance, you may need to test different values to
balance video smoothness and processing power.
7. If using H.264 of MPEG4 video codecs, you can increase or decrease image quality by increasing or
decreasing the target Bitrate value. Video with a high level of motion and high resolution, such as a
sporting event, requires a high bitrate.
8. If all your changes are complete, scroll to the bottom of the page and click Apply.
Table 20 Stream settings guidance
The key frame interval feature specifies how often a key frame (a frame
that contains all the pixels) is sent when streaming the video. This setting
also impacts how quickly a video moves through the frames when a
viewer uses the search function of their media player.
Increasing the number of seconds between key frames can significantly
Key frame interval
reduce your bandwidth and system resource usage with minor impact to
your video quality. A good rule of thumb is to keep the interval between 2
to 3 seconds and decrease the key frame interval as the motion increases.
Try different settings and note changes in the video quality. If your video
quality is poor and jittery you may need to decrease the interval between
key frames. If you have unlimited bandwidth and system resources you
can choose an option to stream key frames only.
Frame rate reflects the number of images captured by the device per
second. Reducing the frame rate reduces bandwidth usage, and vice versa.
The system's ability to maintain a set frame rate is based on several
factors, for example:
Frame rate
l overall system load affects the ability for the device to process
pixels;
l available network bandwidth;
l the source and stream frame size (resolution);
129
Pearl User Guide
Configure encoding
l the type of motion that is captured; and
l number of users accessing the stream.
When adjusting the frame rate, you may need to try different values to
achieve the best outcome. The following table provides the performance
expectations when typical settings are used.
In general, higher bitrate mean higher image quality in the stream, at the
cost of higher bandwidth needed to transmit it.
For comparison against something you are likely familiar with, an HD Blu-
Bitrate
ray video is typically in the range of 20 mbps, standard-definition DVD is
usually 6 mbps.
If you don't know what value to use, a good place to start is 5000 kbps (slightly less than a typical DVD). Test to see how this works for your
viewers and adjust.
Configure audio codec
If your channel sources included audio (see Create a simple channel or Create a multi-source channel), your
stream will be default use the AAC audio codec at 48 kHz. You can modify this setting to best match your
streaming or post-processing needs.
To configure your stream's audio codec :
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Click Encoding for the your channel; the encoding configuration page opens.
4. Scroll to the Audio settings section.
130
Pearl User Guide
Configure encoding
5. Ensure the Enable audio checkbox is checked.
6. If the default audio format AAC 44KHz, stereo, 320 Kbps is not desired, click the Audio format dropdown menu to select an audio codec. A table at the end of this procedure gives details about each
option.
7. Click the Audio channels drop-down menu to choose mono (1 channel) or stereo (2 channels).
If desired, you can choose Mono to have left and right stereo channels combined and
streamed together (i.e. when listening to the streamed audio, the same blended sound will
come through both the left and right channels).
If you have only one mono analog input, use the left TRS jack and select mono encoding to
have the same sound come from both the left and right channels. (If stereo sound is
chosen, the sound will only come through on the left channel.)
8. Select an Audio bitrate from the drop-down menu. The table at the end of this procedure gives some
guidance on audio bitrates.
For stereo audio, we recommend 256 kbps or 320 kbps.
9. If all your changes are complete, scroll to the bottom of the page and click Apply.
Table 21 Audio codecs and bitrate guidance
Value
Description
AAC is the default audio codec.
AAC
This codec is comparable to MP3, and may have better sound quality with a similar
131
Pearl User Guide
Value
Configure encoding
Description
bit rate. Supported values are 16, 22, 44 and 48K kHz. Most digital signals (HDMI
or SDI sources) use 48 kHz audio.
Matching the encoded level with the source level provides the best sound quality
by avoiding audio resampling. For analog signals, 44 kHz provides higher sampling.
The maximum bitrate for mono encoding of a 44 kHz signal is 264 kbps. For stereo,
320 kbps is supported.
MP3 provides a common audio format for audio storage.
Supported values are 22 kHz, 44 kHz and 48 kHz. Most digital signals (HDMI
or SDI sources) use 48 kHz audio. Matching the encoded level with the source level
provides the best sound quality by avoiding audio resampling. For analog signals,
MP3
44 kHz provides higher sampling.
Flash (FLV) doesn't support 48 kHz MP3 audio. When selecting this
value you'll need to use a media player (or install ASF browser plugins)
to preview your channel.
Pulse Code Modulation (PCM) is a standard for digital audio in computer and other
devices such as, digital telephone systems.
Most digital signals (HDMI or SDI sources) use 48 kHz audio. Matching the encoded
level with the source level provides the best sound quality by avoiding audio
PCM
resampling. For analog signals, 44 kHz provides higher sampling.
Flash (FLV) doesn't support 48 kHz PCM audio. When selecting this
value you'll need to use a media player (or install ASF browser plugins)
to preview your channel.
Codec and file format compatibility
Not all streaming and recording protocols support all combinations of video and audio codecs. Use the tables
below to determine what settings work for your streaming and recording needs.
The following table displays the compatibility between the video/audio codecs and formats supported for
streaming.
132
Pearl User Guide
Video Codec selected
Configure encoding
Audio Codec selected
RTSP
FLV
ASF
MPEG-TS
MJPEG
H.264
No audio codec
ü
ü
ü
ü
H.264
LPCM
ü
ü
ü
H.264
MP3
ü
ü
ü
ü
H.264
AAC
ü
ü
ü
ü
MPEG-4
No audio codec
ü
MPEG-4
LPCM
ü
MPEG-4
MP3
ü
MPEG-4
AAC
ü
MJPEG
No audio codec
ü
The following table displays the compatibility between the video/audio codecs and formats supported for
recording.
Video Codec selected
Audio Codec selected
MP4
AVI
MOV
MPEG-TS
H.264
No audio codec
ü
ü
ü
ü
H.264
PCM
ü
ü
ü
H.264
MP3
ü
ü
ü
ü
H.264
AAC
ü
ü
ü
ü
MPEG-4
No audio codec
ü
ü
ü
MPEG-4
LPCM
ü
ü
ü
MPEG-4
MP3
ü
ü
ü
MPEG-4
AAC
ü
ü
ü
MJPEG
No audio codec
ü
ü
ü
ü
133
Pearl User Guide
Add channel metadata
Add channel metadata
Adding company information to metadata is an easy way to identify and copy protect your broadcast or
recording.
Older versions of the Pearl firmware also added no signal images, backgrounds and logos through
the branding feature. Background images and logos are now available through a generic
procedure that doesn't limit you to just one background or logo. See Add an image (custom
channel). Custom no signal images are temporarily unavailable.
This section describes the following topics for customizing your channel:
l Add channel metadata
l To remove metadata from a channel
Add channel metadata
Using the Branding feature, you can apply a logo to your channel and specify the following meta data that the
media player displays for your viewers:
l title of the presentation;
l company website;
l presenter’s name;
l copyright date or other labels such as proprietary information, preliminary etc; and
l additional information about the broadcast, such as time of the broadcast, or change to the schedule.
To apply channel metadata:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, select a channel; the menu expands.
4. Click the Branding link for your channel; the Branding configuration page opens.
134
Pearl User Guide
Preview a channel
5. Enter metadata such as: presentation title, presenter name(s), any copyright dates and additional
information about the broadcast that you want the viewer to know.
How metadata is displayed depends on the media player. For example VLC stores
the metadata in a media information file, while other media players scroll the text
horizontally from right to left along the bottom of the media player window, similar
to a ticker message bar.
6. Click Apply.
To remove metadata from a channel
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, select a channel; the menu expands.
4. Click the Branding menu option; the Branding configuration page opens.
5. Scroll to the Content metadata section.
6. Click the Author, Copyright or Comments field.
7. Highlight the text and press delete on the keyboard. The field is empty.
8. Click Apply.
Preview a channel
While configuring a channel, you may want to open a live preview of the channel in another tab or browser
window so you can see the changes as they are applied. Choose one of the following options to preview your
channel:
l Preview a channel from the Info page
l Preview a channel from the Status page
135
Pearl User Guide
Preview a channel
l Preview all channels at once
Preview a channel from the Info page
The system's Info page displays links for previewing your channel(s). This fast and simple method allows you
to see link for all the streams in a single location.
To preview a channel from the Info page:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, click Info from the Configuration menu option; the information window opens
.
4. Scroll to the channel you want to preview.
5. Click View; the corresponding channel is displayed in the window.
Preview a channel from the Status page
The channel's status page gives a wealth of information about the channel, including bit rate, frame size, a
snapshot of the channel and links to preview the channel.
To preview a channel from the Status page:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Click the link for Channel you want to preview, the menu expands.
4. Click Status; the channel's Status page opens.
136
Pearl User Guide
Preview all channels at once
5. Scroll down to see the snapshot.
6. Right-click the Live Broadcast link and select Open in a new Tab or Open in a new Window; a tab or
window opens displaying a preview of the channel.
Preview all channels at once
Pearl has a special preview mode that lets you see all configured channels at once.
The resulting web page can be very large. You may wish to be aware of your web browser's zoom
hot keys. Many browsers will zoom out with Ctrl-- (control minus) and zoom in with Ctrl-= (control
equals).
To preview all channels at the same time:
1. Open a new browser window.
2. Type the following string into the address bar of your web browser on your admin computer (ipaddress
is the IP address of your Pearl).
http://<ip address of Pearl>/preview.cgi
For example: http://172.20.1.33/preview.cgi
3. Press Enter, the preview web page appears displaying the content of all active channels.
137
Pearl User Guide
Rename a channel
Rename a channel
By default, channels are created with the same name as their source - until a second layout or a second source
is added to the channel, at which time the channel is renamed Channel X where X is the index of the channel.
However there may be circumstances when you want to create a distinct name for the channel to reflect the
source(s) it contains.
Auto channels initially have the channel name Auto A and Auto B, but if you change the source to
something other than an automatic source, the name of the channel changes to reflect the new
source.
To rename a channel:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, scroll to the Channels menu option.
4. Click on the channel you want to rename; the menu expands.
5. Click any link for the channel; the corresponding channel status or configuration page opens.
You can change a channel's name from any of it's configuration pages.
3. Click the channel name at the top of the channel configuration page; the name text becomes red to
indicate that it is editable.
4. Highlight the old name and press backspace or delete on the keyboard.
5. Type the new name, using alphanumeric characters. It's recommended (but not mandatory) that you
use underscores to separate words, if needed.
6. Press Enter on the keyboard. The name is updated at the top of the screen and in the list of Channels in
the navigation menu.
You must press the Enter key on the keyboard for the change to take effect.
Delete a channel
From time to time you may want to clean up the list of channels, and remove channels that are no longer
used. The following steps describe how to delete a channel. Deleting a channel does not delete the input
138
Pearl User Guide
Delete a channel
source configuration, however it deletes any recorded files for the channel.
To delete a channel, follow the steps below.
1. From the web interface, scroll to the Channels menu option.
2. Click the channel you want to delete; the menu expands.
3. Click Status; the Status page opens displaying the service state and stream info for the channel.
4. Click Delete this channel; a confirmation dialog box appears to remind you that all recorded files for
this channel will be removed.
You cannot undo this command.
5. Click OK to continue or Cancel to stop. If you proceed, a message indicating that the channel was
successfully deleted appears at the top of the page.
139
Pearl User Guide
Live video mixing / switching
Live video mixing / switching
Pearl supports live video mixing (also known as live video switching) while you are capturing, streaming and
recording. Video mixing is a great way to create dynamic content for your viewers and recordings. With Pearl,
switching happens in less than half a second ( < 500 ms)!
This means you can start your stream with a video source showing a countdown, move to a single-camera
view, then switch between multiple cameras or multiple layouts with more than one source, and end again
with a thank you message for attendees. (Layout switches made in your channel are reflected in both the live
stream and recording. )
For example, your stream could look like this:
Before you can switch between layouts, make sure you have your custom channel with layouts created. See
Create a custom channel or layout.
Now on to the fun part! There are two ways to perform live switching. You can use either the web UI or the touch screen.
Switching / mixing using the touch screen
Switching live video inputs, or video mixing, is simple and intuitive using Pearl's touch screen. Simply scroll to
the channel you want to work on, select the layout switching mode and apply the layout you want to use.
By default layout control is enabled for the touch screen, but it's possible your touch screen has been
configured by the administrator to prevent layout switching, or even channel monitoring. If the instructions
below don't work for you, see Block (or allow) recording control from the touch screen for details on enabling
layout control by the touch screen.
To switch video using the touch screen:
1. If needed, touch the screen once to turn it on.
2. If needed, touch your channel in the grid view to change it to individual view.
3. If needed, touch the screen once to enable controls on the screen.
140
Pearl User Guide
Live video mixing / switching
4. Touch the button to start layout switching mode; the screen changes to display your layouts.
5. Initially, your live layout (which is displayed on the right side) is the same as your preview, or on deck,
layout. It appears in the list at the bottom with a green bar on the frame to show it is in preview. Touch
any other layout; the touchscreen updates to show your new layout in preview.
141
Pearl User Guide
Live video mixing / switching
6. Both the live layout and the preview layouts update at a reduced frame rate to the live stream, but fast
enough that you can see what is happening.
7. When ready, touch Apply to cause the layout currently in preview to become live; the switch happens
and your screen is updated.
8. Continue to switch layouts as needed for the duration of your event or recording.
9. Touch Back to return to the individual view screen at any time or when you are done video mixing.
Switching / mixing using the web UI
Switching live video inputs, or video mixing, is fast and easy using the web UI. For best results, you may wish
to be in a location where you can see the live action, and have a solid understanding idea of what is in each of
your layouts. Good layout names can help with this. See Rename a layout (custom channel).
To do live video mixing:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Follow the steps in Custom channel layout editor or Create a custom channel or layout to get to the
channel layout editor.
142
Pearl User Guide
Live video mixing / switching
4. The currently active layout has a red button in the rightmost column.
5. Touch the empty circle for another layout to make it the active layout; the layout changes in the live
stream (and recording), and the new row gets the red button.
6. Continue to switch layouts as needed for the duration of your event or recording.
143
Pearl User Guide
What is a source?
What is a source?
A source can be an image, video, or audio from a camera, a computer screen or any device that provides a
VGA, SDI, DVI or HDMI video signal and audio signal output.
Video Sources
The web interface automatically discovers all video source ports and displays them in the Sources section of
the web admin interface.
Each video input on the back of the system is identified by its row (A or B) and input type (SDI, HDMI, or VGA).
For example the SDI input from row A is labeled SDI-A. Input sources display their captured images at the
bottom their respective source page. It is a good practice to view the images from each source to confirm
what is captured. See below.
When a source is connected, the system automatically detects and adjusts the image capture settings at start
up and continues to adjust every 60 seconds during operation (interval is configurable). The system’s goal is to
produce the best quality captured image given the source equipment used. Generally no further
configuration is needed.
144
Pearl User Guide
Connect a source
Audio sources
Pearl's web interface also automatically discovers all audio sources displays them in the same section. Audio
sources are identified by the word audio in the source name. Audio input devices such as a microphone and
portable music players can send audio signals to Pearl using the TRS audio input ports at the back of the
system. Audio is also supported via HDMI and SDI.
This chapter covers the following sections:
l Connect a source
l Preview a source
l Rename a source
Connect a source
You can connect sources to Pearl at any time, either before or after the system is powered on. Similarly you
can disconnect a source from a port and even connect a different source at any time.
Changing the source connected to a port that is being streamed or recorded can result in the
recording stopping or the stream frame size changing depending on how your channel is
configured.
If the frame size changes, viewers may be disconnected and need to re-connect to the stream.
Connect the input sources to the following input ports on the system:
Table 22 Cable and port connections
Cable
Input Port
SDI
SDI port
VGA
VGA port
HDMI* or DVI
HDMI port
audio
Audio Input port
* Pearl only supports video and audio capture from HDMI content that is not HDCP-protected.
145
Pearl User Guide
Preview a source
Preview a source
You can preview the images captured from your sources in the web admin interface. No extra configuration is
needed.
To preview the captured stream/images:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Ensure a source is connected to the input port, see Table Preview a source.
4. From the web interface, click the source name from the Sources menu; the source configuration page
opens.
5. Scroll to the bottom of the source configuration page to see the preview.
Configure a source
Generally the captured stream doesn't require any additional configuration, but if needed, you can log into
the web interface to make configuration changes.
To configure a source:
146
Pearl User Guide
Configure a source
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Ensure a source is connected to the input port, see Table Configure a source.
4. From the web interface, scroll to the Sources menu option.
5. Click the HDMI, SDI or VGA source link; the source configuration page opens.
6. If desired, scroll to the bottom of the source configuration page to see the video Snapshot.
7. Make note of the name of the source, or optionally, change the source name to reflect the data it is
capturing. You'll need to know this name to add the source to a channel. See Create a simple channel.
8. In most cases the video is ready to add to a channel and broadcast. If fine adjustments are required,
refer to the table below to make minor configuration changes. (The only configurable item for SDI
and HDMI sources is rotation.)
DVI and HDMI Signals
The following options are available for DVI and HDMI signals via the HDMI port.
Value
Rotate
Description
This feature is useful when a source captures video that is rotated 90⁰ or is
displayed upside down. Choose one of the following values to change the video
147
Pearl User Guide
Value
Configure a source
Description
orientation while streaming:
l No rotation
l 90⁰ clockwise
l 90⁰ counter clockwise
l 180⁰
Enable dein-
Enable this feature to convert an interlaced source signal to a non-interlaced sig-
terlacing
nal.
VGA Signals
The following values are configurable for VGA signals coming in via a VGA port.
Value
Description
When a source is setup, the system automatically detects and adjusts the image
Autoadjustments
capture settings at start up and continues to adjust every 60 seconds during
interval (sec)
operation. To change the number of seconds between update, enter a value, or
0 to disable the feature, otherwise the default of 60 seconds is set.
When an image is not aligned in the window, use this feature to move an image
Vertical shift
up or down on the screen. The values range from 20 (moves the image up) to –
20 (moves the image down).
When an image is not aligned in the window, use this feature to move an image
Horizontal shift
left or right on the screen. The values range from -999 (moves the image to the
left) to 999 (moves the image to the right).
Phase
Specifies phase adjustments for VGA signals. Generally not used unless value is
provided by Epiphan support.
Changing the value adjusts the horizontal resolution of the image. Adjust the
PLL adjustment
value using small increments until the image is sharper. The value ranges from
0-999 to 999.
The Offset and Gain parameters function as contrast control for an image. The
Offset controls the darker parts of the image and the gain controls the bright
Offset
parts of the image. Adjust both values to optimize image quality. Adjust the
values using small increments until the image is sharper. If you set Offset to a
high value, set a high value for the gain to balance the two.
148
Pearl User Guide
Value
Configure a source
Description
The Gain and Offset parameters function as contrast control for an image. The
Gain controls the bright parts of the image and Offset controls the darker parts
Gain
of the image. Adjust both values to optimize image quality. Adjust the values
using small increments until the image is sharper. If you set Offset to a high
value, set a high value for the Gain to balance the two.
Sets the aspect ratio of the captured image. The default is 4:3. Set the value to
Wide mode when capturing images that have a wide aspect ratio. Using the
Aspect Ratio
incorrect setting causes the image to be distorted or stretched.
Configurable for VGA sources only.
HSync threshold
Adjust horizontal sync detection.
VSync threshold
Adjust vertical sync detection.
This feature is useful when a source captures video that is rotated 90⁰ or is
displayed upside down. Choose one of the following values to change the video
orientation while streaming:
Rotate
l No rotation
l 90⁰ clockwise
l 90⁰ counter clockwise
l 180⁰
SDI Signals
The following options are available for signals via the SDI port.
Value
Description
This feature is useful when a source captures video that is rotated 90⁰ or is
displayed upside down. Choose one of the following values to change the video
orientation while streaming:
Rotate
l No rotation
l 90⁰ clockwise
l 90⁰ counter clockwise
l 180⁰
Enable dein-
Enable this feature to convert an interlaced source signal to a non-interlaced sig-
149
Pearl User Guide
Rename a source
Value
Description
terlacing
nal.
Rename a source
Source names are used when adding sources to channels, therefore it is important that you know the name of
the source you wish to use. If a channel has only one source, the channel name will by default be the same as
its source name and will update automatically when the source name changes.
Sometimes it's helpful to configure the source name to match the data it's capturing so it's clear what the
channel is capturing too. Alternately you can change the channel's name. See Rename a channel.
To change a source name:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, scroll to the Sources menu option.
4. Click the HDMI, SDI or VGA source link; the source configuration page opens.
5. Click the source name at the top of the page; the name turns red.
6. Highlight and delete the existing source name.
150
Pearl User Guide
Control audio volume
7. Type a new source name.
8. Press Enter (on your keyboard) to save the new name.
You must press Enter to save the new name. The Apply button will not save the source
name change.
Control audio volume
Do you find the volume is too high or too low for some of your audio sources? You can control the volume
level for audio inputs through the web admin interface.
To set audio volume:
1. Ensure an audio input source is connected to an audio input port.
2. Connect to the admin interface using your preferred connection method. See Connect to the admin
interface.
3. Login as admin.
4. From the web interface, scroll the Sources section.
5. Select an audio source; the audio configuration page opens.
6. For Analog audio sources (TRS), select the Input source from the drop-down menu. Choose Line
(default setting, unbalanced audio), to capture system audio, or choose Balanced to capture audio
from a microphone or other balanced source connected to the audio input port.
7. Click the volume drop-down menu. A list of percentages is displayed. Choose to amplify the volume by
a percentage of the original volume. The default setting is 50%. Decrease the percentage if the output
volume is too loud. Increase the percentage if the output volume is not loud enough.
151
Pearl User Guide
Confirm audio levels (via the touch screen)
Adjusting the Capture volume adjusts the recorded and streamed output audio.
8. Click Apply.
Confirm audio levels (via the touch screen)
The touch screen includes an audio meter that indicates audio levels (if any) for each channel. This meter is
visible in both the grid and individual channel view, at the lower left corner of the channel preview. You may
need to touch the screen once to turn on decorations before you can see the audio meter.
If the channel has stereo audio, the meter is split horizontally into two bars. The top bar is the left channel and
the bottom bar is the right channel.
VU Meter (mono audio)
VU Meter (stereo audio)
To confirm audio signal through the touch screen:
1. If needed, touch the screen once to turn it on.
2. View, from either the grid view or the individual channel view, the colored VU audio meter in the lower
left quadrant of each channel preview.
152
Pearl User Guide
Troubleshoot capture
Troubleshoot capture
In addition to fine tuning channel settings such as frame rate, resolution and bit rate to ensure optimal use of
resources while streaming a quality video, there may be circumstance when you must fine tune the video
input source.
Changing how source images are displayed may cause undesired results, for example
experimenting with the PLL setting may result in the image not being displayed properly. It is a
good practice to backup your configuration settings so that you can revert back to a good
configuration if the changes that you made are not desirable. See Save and restore device
configuration.
The following topics are covered in this section:
l Remove black bars (matte) from the video
l Force the capture card to use a specific EDID
l Unstretch the output video
l Video not centered (VGA sources only)
l Remove the combing effect on images
l Video looks squished (VGA sources only)
l Video too bright, too dark or washed out (VGA sources only)
Remove black bars (matte) from the video
By default, for channels with only one layout and only one source, Pearl makes sure that the aspect ratio of
input signals is preserved when the output is streamed. If an input video signal doesn't match the encoded
frame aspect ratio, bars are added to the sides or top and bottom of the encoded stream when the output is
streamed and recorded. The color of the bars (matte) is defined by the Background color selected on the
Channel sourcespage. See Add channel metadata.
For example:
l Input signal resolution is 720×480 (a 3:2 aspect ratio)
l encoded resolution is 640×480 (a 4:3 aspect ratio that is narrower than the input resolution)
Borders are added to the top and bottom of the image to preserve the wider ratio of the input.
153
Pearl User Guide
Remove black bars (matte) from the video
For example:
l Input signal resolution is 720×480 (a 3:2 aspect ratio)
l encoded resolution is 1280×800 (a 16:10 aspect ratio that is wider than the input resolution)
Borders are added to the left and right of the image to preserve the narrower ratio of the input.
If you are seeing bars on your image but would rather have the image fill the whole screen you have to
options:
1. Change the output frame size to match the aspect ratio of the input.
2. Stretch the image to fit the output frame size aspect ratio.
These two options are described below.
Match the output frame size to the aspect ratio of the source
signal
The frame size is matched only for layouts that have only one source. Note that if you have
layouts with different frame sizes, switching them while live streaming will cause an interruption
and restart of the stream. The same thing happens if you change the resolution of your source
while streaming.
To change the output frame size to match the aspect ratio of the source:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
154
Pearl User Guide
Remove black bars (matte) from the video
2. Login as admin.
3. Select a channel; the menu expands.
4. Click Sources; the Sources page opens.
5. Find the name of the media source used for the channel.
6. Click this source under the Sources menu.
7. Make note of the input signal resolution.
8. Click the channel's Encoding ; the Encoding page opens.
9. Scroll to the frame size parameter.
10. The simplest option is to select Use current signal resolution as frame size and click Apply. You can
alternatively select it briefly to note the current video signal resolution, then deselect it and follow the
steps below.
11. Look for the source aspect ratio in the list of aspect ratios provided.
a. If the source resolution is on the list, choose another resolution on the same line (i.e. with the
same aspect ratio).
b. If the source resolution is not on the list, use a calculator to get a factor of the source resolution
and enter it in the Frame size fields.
155
Pearl User Guide
Force the capture card to use a specific EDID
12. Click Apply.
Stretch the image
To remove the matte (black bars) by stretching the image to fit your output frame size:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select a channel; the channel menu expands.
4. Click Sources; the Sources page opens.
5. Click the row for your layout; the layout appears in the layout editor.
6. Select the gear for your Item with your video source; the Source Settings box appears.
7. Deselect Keep aspect ratio when scaling in the Source Settings box.
8. Click and drag the source in the layout editor to stretch as desired to fill the frame.
9. Click Save.
Force the capture card to use a specific EDID
Extended display identification data (EDID) is data provided by a video display device (usually a monitor) to
describe its capabilities to a video source (usually a graphics or video output card in a PC or another device).
The video source uses the EDID to determine the capabilities of the monitor to determine the resolution, color
depth and other settings that the monitor can support.
EDID is crucial for DVI sources but mostly ignored by VGA sources.
Like monitors, each video capture card in Pearl contains an EDID. When you connect a VGA or DVI video
source (such as a laptop or video camera), this source sees Pearl's capture card as a monitor and uses its EDID
to negotiate which video signal to send.
Generally capture card's DVI input correctly emulates a monitor that supports your video source. However
sometimes, particularly if your source uses a custom set of display properties, you need to help Pearl by
uploading a custom EDID to force the capture card to report that it emulates a resolution, color depth, etc
needed by your laptop, camera or other video source.
156
Pearl User Guide
Force the capture card to use a specific EDID
Upload a new EDID
In most circumstances the factory installed default EDID, is sufficient. However, there may be some cases
where a video source uses resolutions that you do not want to use. In that case you can choose an EDID that
forces Pearl's capture card to use a specific set of attributes.
The uploaded EDID is permanently installed on your system and this capture card (a "Source" in the web
interface) will always share the uploaded EDID with the connected video input source.
EDID changes are permanent until you replace them with another EDID or specifically choose to
restore the facotry EDID for a given source. Not even a system-level factory reset removes the
configured EDIDs.
1. To download a new EDID file, go to the Epiphan support web page. The support page opens.
2. Select the support page for Pearl.
3. Scroll to the EDID section.
4. Click on an EDID from the list. The file is saved to your downloads folder on your hard drive.
5. Connect to the admin interface using your preferred connection mechanism. SeeConnect to the admin
interface.
6. Login as admin.
7. Scroll to the EDID upload section.
8. Click Choose File; a file browser opens.
9. Browse to the location where the custom EDID file was saved and select the file.
10. Click open; the EDID filename is displayed on the screen.
157
Pearl User Guide
Force the capture card to use a specific EDID
11. Click upload, the EDID upload begins; the screen shows a progress inidicator.
12. When the upload is complete the page changes to reflect success or failure.
Restore factory default EDID
When you have finished with a custom EDID, you can restore the capture card (in the Sources list) to the
default EDID. Currently there is no way to tell if your capture card is using a custom EDID. If you are unsure,
restoring to factory default is the best approach.
To restore the default EDID:.
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, scroll to the Sources section.
4. Click the capture card (source) for which you wish to restore the EDID; the source configuration page
opens.
158
Pearl User Guide
Unstretch the output video
5. Scroll to the EDID section.
6. Click the restore button.
7. The screen updates with a status indicator.
8. When the EDID restoration is complete, the page updates to reflect the action is completed.
Unstretch the output video
By default, Pearl makes sure that the aspect ratio of input signals is preserved when the output is streamed. If
this default was overridden the image is stretched to match the output frame size. The effect may be subtle
and may not be problematic for you, but if you want to resolve this it is very simple to do.
To preserve the source aspect ratio:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, click Encoding; the encoding page opens.
159
Pearl User Guide
Video not centered (VGA sources only)
4. Click Sources; the Sources page opens.
5. Click the row for the layout you want to edit; the layout editor opens.
6. Select the gear icon for your source from the list of layout items; the Source settings box appears.
7. From the Source settings box, make sure Keep aspect ratio when scaling is selected.
8. Scroll to the bottom of the page and click Save.
Unstretching the image causes a matte (black bars) to appear on the sides or top and bottom of
the output. To remove these see Remove black bars (matte) from the video.
Video not centered (VGA sources only)
The image from the source is displayed too high or low, or too far to the left or right.
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
160
Pearl User Guide
Remove the combing effect on images
3. From the web interface, scroll to the Sources menu option.
4. Click the desired video source ; the source configuration page opens.
5. To move the video horizontally to the left or right, scroll to Horizontal shift .
6. Enter incremental values to shift the video image to the left (use a negative value) or right (use a
positive value).
7. Click Apply. View the output in the Snapshot preview below . You may need to make further
adjustments to move the video left or right.
8. Make further adjustments and click Apply after each change to confirm the results.
9. To move the video up or down, scroll to Vertical shift .
10. Enter incremental values to shift the video image down (use a negative value) or up (use a positive
value).
11. Click Apply. View the output in the Snapshot preview below. You may need to make further
adjustments to move the video up or down.
Remove the combing effect on images
When frames are interlaced, artifacts from one frame may appear on the next frame. This occurs when a fast
motion video is interlaced. Since each frame is captured from a different point in time, the action captured in
one frame is carried over to the next frame. The result is a blurred image and horizontal lines running across
the video.
To convert an interlaced source signal to a non-interlaced signal.
161
Pearl User Guide
Video looks squished (VGA sources only)
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, scroll to the Sources menu option.
4. Click on the desired video source ; the source configuration page opens.
5. Enable the Enable deinterlace setting.
6. Click Apply. View the output in the Snapshot preview below.
Video looks squished (VGA sources only)
The image is squeezed horizontally on the screen. This distortion occurs when there's a mismatch between the
aspect ratio Pearl detects and the aspect ratio that is sent from the source signal. To compare the two signal
values, you must know the aspect ratio that the source is sending.
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, click Info; the info window opens with a list of all configured channels.
4. Compare the aspect ratio from the source with the aspect ratio from the Pearl info window. Confirm if
there is a mismatch.
162
Pearl User Guide
Video too bright, too dark or washed out (VGA sources
only)
5. If there is a mismatch, go to the Encoding page for the channel and change the frame size to match the
frame size that is sent from the source. See Configure encoding .
6. If the video is still squeezed horizontally on the screen, follow the steps below.
7. From the web interface, scroll to the Sources menu option.
8. Click on the source for which you want to change the aspect ratio; the source configuration page
opens.
9. Scroll to the Aspect ratio setting.
10. Select Wide mode from the drop-down menu, when the source is wider than what is being displayed in
the preview or Live View.
11. Click Apply. View the output in the Snapshot preview below.
Video too bright, too dark or washed out (VGA sources only)
If the video from the source is too light, too dark or washed out, use the offset and gain controls together to
optimize image quality. Increasing the gain amplifies weak signals but also increases noise, you must balance
offset and gain values to achieve the best quality image.
Adjust these settings by the smallest values possible; compensate for a large change to one by making a large
change to the other. Setting both offset and gain to high values can result in poor video quality.
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
163
Pearl User Guide
Video too bright, too dark or washed out (VGA sources
only)
3. From the web interface, scroll to the Sources menu option.
4. Click the desired video source; the source configuration page opens.
5. Scroll to Gain.
6. Enter a small value, for example 1 to 25 in the field to brighten the image.
7. Scroll to Offset.
8. Enter a small value, for example 1 to 15 , to balance the gain setting . The Offset value behaves as a
contrast to the Gain value.
9. Click Apply. View the output in the Snapshot preview below. You may need to make further
adjustments to fine tune the brightness and contrast.
164
PART 3: Stream
Streaming provides powerful and flexible approaches to delivering to your users. Offering an easy to use
interface, users can stream video using multiple formats to multiple users and devices such as web browsers,
media players, set-top-boxes, Smart TVs and Content Distribution Networks. The tool's flexibility is further
enhanced by its ability to support standard codecs used by most sharing destinations and media players.
This section discusses the following topics related to publishing your content:
l Stream
l Samples of stream settings
165
Pearl User Guide
What is streaming?
What is streaming?
After you have configured your media and channels, decided on the content and layout of your broadcast, it’s
time to share your stream.
Pearl provides a number of options for streaming. Choose from methods for unicast, multicast, CDN, SAP,
UPnP and more.
The following sections provide a description of the available streaming options, insight into why you would
choose each option, and procedures to stream your content using each option.
o Choose a streaming option
o Supported streaming formats
Streams for viewers:
o Stream to viewers
o Disable (and enable) streams for viewers
o Restrict access to streams for viewers
o Stream content using HTTP or RTSP
o Configure HTTP and RTSP streaming ports
o Stream content using HLS (HTTP Live Streaming)
o Stream content using UPnP
Stream to a server:
o Stream to a server
o What is streaming?
o What is streaming?
Stream to a media player:
o Stream to a media player
Choose a streaming option
Each method of streaming media has strengths and weaknesses depending on your audience location,
hardware resources and bandwidth. To help you decide how to publish your content, you must first identify
the number of viewers and how viewers will access your content. Are you streaming live video, or recorded
video. Do you need to stream the content to one client (peer-to-peer), deliver a single stream to multiple
166
Pearl User Guide
Supported streaming formats
clients (multicast), or provide web-based streaming where multiple clients can access the broadcast (Content
Distribution Network).
Your Pearl can stream to individual viewers through HTTP, HTTP Live Streaming, UPnP and RTSP and can also
simultaneously stream to a server such as a multicast server or CDN.
Supported streaming formats
When you set up your channel the system generates and displays a list of available video formats and
standards specific to the selected audio and video codecs used by your channel.
To view the video formats and standards specific to your selected codec:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, click a Channel; the menu expands.
4. Click Status: the following page opens displaying the stream protocol that is supported based on the
selected codecs.
167
Pearl User Guide
Stream to viewers
Stream to viewers
Streaming to viewers allows viewers to connect directly to your Pearl and view the live stream.
You can configure whether or not streaming is enabled for viewers. See Stream to viewers.
Publishing Options
Use this option to...
Quickly stream content to viewers simultaneously. No set up is required.
Pearl is ready to stream content as soon as it is has power and a configured
channel. No other settings are required. Your audience need only access the
HTTP
URL of the broadcast and they are instantly connected. This viewing method
is ideal for a small number of viewers since streaming uses your system
resources and bandwidth. However a small amount of overhead is used for
each viewer. For more information about using a HTTP streaming, refer to
Stream content using HTTP or RTSP.
Quickly stream content to viewers. No set up is required. Pearl is ready to
stream content as soon as it has power and a configured channel. No other
RTSP
settings are required. Your audience need only copy and paste the URL of
the stream into a media player. For more information about using a RTSP
and HTTP streaming, refer to Stream content using HTTP or RTSP.
Stream live over the standard HTTP port 80, making it possible to cross
firewalls and proxies that are normally accessible to other HTTP traffic and
HTTP Live Streaming
facilitates content delivery to CDNs. See Stream content using HLS (HTTP
(HLS)
Live Streaming).
There is approximately a 30 second delay when streaming using HLS.
To stream video outside of your LAN, configure port forwarding on your router. Refer to your
Network Administrator; network configuration is beyond the scope of this guide.
Stream content using HTTP or RTSP
The quickest and simplest way to deliver your content is to send the broadcast's URL to your viewers. You can
provide separate URLs for each channel being streamed.
The format of the URL provided to you by the admin interface depends on the method you used to access
the system, either through network discovery using the serial number or IP address.
168
Pearl User Guide
Stream content using HTTP or RTSP
The system must be accessible on the viewer's LAN for the viewer to use access by serial
discovery.
If your system is behind a firewall and you wish to share with remote viewers, you will need to set
up port forwarding on your network. See your IT administrator.
Table 23 URL options
Access Method
URL Format
http://<serial>.local/preview.cgi?channel=<channel number>
rtsp://<serial>.local:<port>/stream.sdp
serial discovery
Where serial is the serial number of the system and channel number
is the provided from the GUI (see below).
http://<IP Address of Pearl>/preview.cgi?channel=2
rtsp://<IP Address of Pearl>:<port>/stream.sdp
IP address
Where the IP address is the IP address of the system and the port
and channel number informationis provided on the channel's status
page.
To retrieve the stream URL for your viewers:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, click a Channel; the menu expands.
4. Click Status: the following page opens displaying the stream protocol that is supported based on the
selected codecs.
169
Pearl User Guide
Configure HTTP and RTSP streaming ports
5. Jot down the either the Live Broadcast , RTSP stream or other web streaming address. This is the
address you can send to viewers or to create a link to your broadcast.
Users must install Bonjour Print Services on their Windows or Mac computer to access the live
Preview using the serial number. Log into the admin interface by IP address to see the URL with
the IP address instead of the serial number.
Configure HTTP and RTSP streaming ports
For RTSP streaming the only information required to view the broadcast is the URL and the port number used
to stream the broadcast. Port numbers are also used for HTTP streaming methods such as FLV, ASF
and MPEG-TS. By default, each channel has a unique HTTP and RTSP port number. If needed, you can modify
these port numbers. Be sure to always use unique numbers for each channel.
To set the HTTP and RTSP streaming ports, follow the steps below.
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, click a Channel; the menu expands.
4. Click Streaming; the channel's Streaming page opens.
170
Pearl User Guide
Stream content using HLS (HTTP Live Streaming)
5. Set the HTTP Streaming port to specify the port used to stream the HTTP broadcast. This value along
with the URL is used by viewers to access the FLV, ASF and MPEG-TS streams.
The port number must be higher than 500 for HTTP. In the case of RTSP streaming this
value is ignored.
6. Set the RTSP Streaming port to specify which port to use when you are streaming live video via RTSP.
This value along with the URL is used by viewers to access the broadcast. The default for channel one is
554.
7. Click Apply.
Stream content using HLS (HTTP Live Streaming)
Stream live over the standard HTTP port 80, making it possible to cross firewalls and proxies that are normally
accessible to other HTTP traffic .
HLS is supported with the H.264 codec and MP3 or AAC audio encoding. When streaming using
HLS there is approximately a 30 second delay.
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
171
Pearl User Guide
Send stream URLs to viewers
3. From the web interface, select the channel containing video you want to stream; the menu expands.
4. Click Streaming; the channel's Streaming configuration page opens.
5. Enable HTTP Live Streaming by selecting the HTTP Live Streaming checkbox.
6. Click Apply.
7. Click Status for the channel. The status page opens.
8. Provide the HLS stream link to your viewers.
Send stream URLs to viewers
For participants to log in and view a stream, you must provide a stream URL. The URL that you send depends
on the device the participant uses to view the stream. You can provide separate URLs for the stream coming
from each channel, or one URL that includes all the streams for the channel.
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
172
Pearl User Guide
View the Flash stream
3. From the web interface, click the channel that you want to view; the menu expands.
4. Click Status; the Status page opens displaying the stream protocols supported based on the selected
codecs. For more information on compatibility between codec and file formats, see Send stream URLs
to viewers.
5. Copy the URL and provide to viewers. Based on their media player, viewers can access the broadcast
using a URL specific to their media player.
Viewers may now view the stream using a digital media player or browser. See Viewing with a web browser and
Viewing with a media player (RTSP).
View the Flash stream
There are two methods to view the retrieve the flash stream URL:
173
Pearl User Guide
View the Flash stream
l Live broadcast link on the channel's status page.
l Info page from the configuration menu
View your broadcast using the View link on the Info menu
1. Connect to the admin interface using your preferred connection mechanism. SeeConnect to the admin
interface.
2. Login as admin or operator.
3. From the web interface, click Info menu option; the info window opens with a list of all configured
channels.
4. Click on the channel you want to preview. A page opens displaying the live broadcast and broadcast
URL.
5. Copy the URL and provide to viewers. Based on their media player, viewers can access the broadcast
using a URL specific to their media player.
View your broadcast using the Live broadcast link on the Status
page
1. Connect to the admin interface using your preferred connection mechanism. SeeConnect to the admin
interface.
174
Pearl User Guide
View the Flash stream
2. Login as admin or operator.
3. From the web interface, click the channel that you want to view; the menu expands.
4. Click Status; the status page opens displaying the live broadcast and stream URL.
5. When HTTP live streaming for the channel is enabled the status page also shows the HTTP Live
Streaming link. See, Stream content using HLS (HTTP Live Streaming).
When HLS is enabled and with no viewer password set, viewers can access the stream using a
tablet or smart phone device.
6. Click on the Live broadcast or HTTP Live Stream link, if it configured. The window opens displaying the
live broadcast and broadcast URL.
175
Pearl User Guide
Viewing with a web browser
7. Copy the URL and provide to viewers. Based on their media player, viewers can access the broadcast
using a URL specific to their media player.
Viewing with a web browser
If a viewer password is configured, provide participants with the password to log in, along with the IP address
or the URL to be used by the participant's browser.
If your channel is configured with 48 kHz audio, flash streaming (which is used for browser
viewing) may not work. In this case, we recommend you view the channel with a media player
instead. (See below.)
1. Open a web browser.
2. Enter the IP address of the broadcast stream, refer to the example below. To locate the IP address for
the broadcast, refer to Viewing with a web browser
If the IP address of the broadcast is 172.20.1.33, then browse to:
http:// 172.20.1.33/preview.cgi?channel=<channel number>
3. Enter the user name and password at the prompt:
User Name: viewer
Password: (enter the viewer password)
4. Press Enter. The stream is played in the browser window.
176
Pearl User Guide
Viewing with a media player (RTSP)
Viewing with a media player (RTSP)
If a viewer password is configured, provide participants with the password to log in, along with the IP address
or the URL to be copied to the media player. For example purposes the following procedure describes the
steps using a VLC media player.
1. Launch a media player.
2. Click the Media tab, a drop-down menu opens.
3. Choose Open Network Stream; a dialog box opens.
4. Enter the stream URL .
rtsp://49E7B8E4.local:554/stream.sdp
177
Pearl User Guide
Disable (and enable) streams for viewers
5. Press Play. The stream is played in the media player window.
Disable (and enable) streams for viewers
When you create a channel it's available by default for viewing by stream viewers who have the stream URL.
You can choose to disable streaming to viewers through the channel's streaming configuration.
Disabling streams for viewers disables all viewer formats including HTTP, RTSP, HLS and UPnP.
To disable (or enable) streams for viewers:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, click Streaming for the desired channel; the streaming page opens.
178
Pearl User Guide
Restrict access to streams for viewers
3. Uncheck Enabled to disable streaming to viewers (or check to enable).
4. Click Apply at the bottom of the page.
Restrict access to streams for viewers
Pearl can restrict access to all viewer streams using global viewer passwords and IP allow/deny lists. See User
administration and Restrict viewers by IP address
If LDAP is configured for viewer authentication, the viewer must pass global autentication using
LADAP credentials (or the viewer global password, if there is one) and must meet the local channel
settings (come from an allowed IP address). See User administration for more information on
LDAP configuration.
To restrict viewers for a channel:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, click Streaming for the desired channel; the streaming page opens.
4. Scroll to the Stream access control section of the page.
179
Pearl User Guide
Restrict access to streams for viewers
3. Select Use these settings from the drop down list; the configuration fields are enabled.
Global LDAP settings are always enforced. Any local settings are in addition to LDAP sign on.
3. If desired, specify a password for viewers of this channel; the password appears masked as you type it.
If you have global allow/deny lists or a global user password, you can override the global
settings and remove all access control for a channel by selecting Use these settings and
leaving all the fields blank.
3. If desired, specify allow and deny IPs for viewers of this channel. See Restrict viewers by IP address for
more information about allow and deny lists.
4. Click Apply at the bottom of the page.
To return a channel to the default (global) access control settings:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, click Streaming for the desired channel; the streaming page opens.
4. Scroll to the Stream access control section of the page.
5. Select Use global settings from the drop down list; the configuration fields are disabled (any changes
to the configuration fields are not saved).
6. Click Apply at the bottom of the page.
180
Pearl User Guide
Restrict viewers by IP address
Restrict viewers by IP address
Pearl permits you to restrict which computers can access broadcasts by building a list of allowed and/or
denied IP addresses. You can do this at a global level for the system and can also override these settings on a
per-channel basis. Both global and per-channel configuration procedures are described below.
IP address restriction is valid for the viewer only and does not affect the web admin interface or
the mobile configuration interface.
If your viewer account has a password, your viewers must connect to the system from a computer (or
gateway) with a permitted IP address and must also supply the username (viewer) and password before they
can view the broadcast.
To restrict access by IP address you need to know the IP addresses, or range of addresses for your viewers. By
default all IP addresses are allowed to connect to the broadcast.
If you’re not familiar with creating allow/deny lists, refer to the examples below this procedure for assistance
with crafting your lists.
To restrict viewers by IP address:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Access passwords link in the Configuration menu; the password configuration page opens.
4. Type allowed IP addresses or address ranges in the Allow IP’s field. Separate addresses with a comma.
5. Type denied IP addresses or address ranges in the Deny IP’s field. Separate addresses with a comma.
6. Click Apply.
To restrict viewers of a specific channel by IP address:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Streaming link for the desired channel; the streaming configuration page opens.
4. From the Access Control drop-down, select Use these Settings; local password and Allow/Deny IP
lists are enabled.
5. If desired, type a password for the viewer in the Viewer Password field.
6. Type allowed IP addresses or address ranges in the Allow IP’s field. Separate addresses with a comma.
181
Pearl User Guide
IP Restriction Examples
7. Type denied IP addresses or address ranges in the Deny IP’s field. Separate addresses with a comma.
8. Click Apply.
If a user attempts to connect to the stream from a disallowed IP address, access is denied. If connecting by
internet browser, the message "IP address rejected." is displayed.
The following table describes the applicable fields.
Table 24 IP Based Restriction Fields
Label
Description/Options
Enter individual IP Addresses or IP Address ranges, separated by commas. To specify a
range, use a hyphen (-). Optional spaces improve readability.
Users connecting from addresses in this list are permitted to view broadcasts from the
Allow IP's
system, provided their IP address is not in the Deny IP’s list.
To allow all (except IP addresses in the deny list, if any), leave the field blank.
You can use the Allow list by itself, or in conjunction with the Deny IP’s list as an exception
to a rule in the allow list.
Enter individual IP Addresses or IP Address ranges, separated by commas. To specify a
range, use a hyphen (-). Optional spaces improve readability.
Users connecting from addresses in this list are not allowed to view broadcasts from the
Deny IP's
system, unless their IP address is in the Allow IP’s list. If a specific IP address is in both lists,
access to the stream is denied.
You can use the Deny list by itself, or in conjunction with the Allow IP’s list as an exception
to a rule in the allow list.
IP Restriction Examples
Allow List with Distinct IP Addresses
The simplest allow/deny list is to use the list of known IP addresses to craft a list of allowed IP addresses. All
other addresses are denied access to the broadcast.
For example if your system is accessible on your local area network (LAN) and you want to make sure only the
CEO’s specific desktop, laptop and tablet computers (with IP Addresses 192.168.1.50, 192.168.1.51, and
192.165.1.75, respectively) can connect to the broadcast, construct the following allow list:
Allow: 192.168.1.50, 192.168.1.51, 192.168.1.75
182
Pearl User Guide
IP Restriction Examples
Allow List with a Range of IP Addresses
Sometimes you’ll want a range of computer IP addresses to connect to your system. This may happen when
you have one range of IP addresses assigned to desktop computers (i.e. in the range 192.168.1.1 to
192.168.1.100) and another range assigned to boardroom computers (i.e. the range 192.168.1.200 to
192.168.1.250). If you only want the boardroom computers to connect to broadcasts from the system you
can specify the range of boardroom IP addresses rather than needing to type in each individual address. The
allow list looks as follows:
Allow: 192.168.1.200-192.168.1.250
Note that we could have specified two of the IP addresses in the previous example as a range.
Allow List with a Range of IP Addresses and One or More Specific
IP Addresses
Putting the first two examples together, we want to permit access to IP addresses in the range of boardroom
computers (192.168.1.200-192.168.1.250) and also want to add the desktop, laptop and tablet computers
of the CEO (IP addresses 192.168.1.50, 192.168.1.51, and 192.168.1.75, respectively). Note the first two IP
addresses are consecutive, so they can be added as a second range. Add these IP addresses to the list as
follows:
Allow: 192.168.1.200-192.168.1.250, 192.168.1.50-192.168.1.51, 192.168.1.75
Your list can have multiple ranges and multiple distinct IP addresses, provided they are separated by commas.
Deny List with Distinct IP Addresses
Another simple allow/deny list is to use the list of known IP addresses to list specific denied IP addresses. All
other addresses are allowed access to the broadcast.
For example imagine your system is accessible on your local area network (LAN) and you want to allow any
computer on the LAN can access the stream except your publicly-accessible boardroom (with IP address
192.168.1.211). You can use the following deny list (leave the allow list empty) to permit all computers except
the boardroom computer:
Deny: 192.168.1.211
As with Allow lists, your deny list can specify a range of IP addresses, and can specify multiple ranges or
distinct IP addresses in a comma-separated list.
183
Pearl User Guide
IP Restriction Examples
Allow List with a Range of IP Addresses, Distinct IP Addresses, and
an Exception
Building on the previous examples, consider the situation where you want the CEO’s computers
(192.168.1.50, 192.168.1.51, 192.168.75) and all boardroom computers (192.168.1.200-192.168.1.250)
to access the broadcast, with the exception of the public boardroom computer (192.168.1.211). Use both
allow and deny lists to create the rule as follows:
Allow: 192.168.1.200-192.168.1.250, 192.168.1.50-192.168.1.51, 192.168.1.75
Deny: 192.168.1.211
Both lists can have multiple ranges and multiple distinct IP addresses, provided they are separated by
commas.
Deny List with a Range of IP Addresses
Converse to the previous examples, consider the situation where you want every computer on the network to
access the broadcast, with the exception of the CEO’s desktop, laptop, and tablet computers. Additionally,
boardroom computers should not be permitted with the exception of the cafeteria computer (IP address
192.168.1.222).
The deny list is an "exception" list for the allow list. So to craft the rule described above we need to allow all the
computers in the local subnet, then deny specific sub-ranges including two groups of boardroom computers
ensuring the cafeteria computer's IP address is not in the deny list:
Allow: 192.168.1.1-192.168.1.250
Deny: 192.168.1.200-192.168.1.221, 192.168.1.223-192.168.1.250, 192.168.1.50-192.168.1.51,
192.168.1.75
184
Pearl User Guide
Stream to a server
Stream to a server
Your Pearl streams to a server when you want to use a CDN or Multicast.
By default, no server streaming is configured. See Stream to a server and Stream to a server for details on
configuring one of these two options.
Publishing Options
Use this option to...
Stream web content to many viewers simultaneously to any geographical
location. A viewer accesses the broadcast from a website using a user name
and password, if required. Using a CDN to host your broadcast is highly
scalable and makes financial sense to website owners since you do not pay
for additional server hardware or routing should your network traffic
increase or decrease.
Using a CDN to stream live content allows you to reach a large
geographically diverse audience and because CDNs perform format
conversion, the stream is platform independent.
For more information about streaming to a CDN, see Stream to a server.
The following options are available to stream video to a CDN:
Epiphan TV - test your video stream using Epiphan’s portal
Content Distribution
Network
using RTSP announce - stream live video to a content delivery network
using RTMP push - stream live video to a content delivery network
Wowza Streaming Cloud - for quick integration with Wowza
Streaming Cloud
Original Livestream - for use with older Livestream installations
RTSP and RTMP streaming provides the following advantages:
l viewers can watch the action as it unfolds;
l video quality automatically changes to adjust to changes in
bandwidth;
l reduced bandwidth usage since the player maintains a smaller
buffer; and
l viewers can scroll back through later sections of the video while the
video is streaming.
185
Pearl User Guide
Publishing Options
Stream to a server
Use this option to...
Stream content to a multicast IP address where it can be shared with
multiple viewers within the same LAN. All viewers receive the same stream
at the same time. Similar to turning on a radio station, all listeners hear the
same music at the same time.
This delivery method relies on network equipment that supports
multicasting and is usually used in high bandwidth corporate LANs and not
on Internet-based architectures.
This delivery method is useful for training sessions, when there is a specific
timeframe when the audience will view the content. For more information
about using multicasting for streaming your content, see: Stream to a
server
l RTP/UDP transport standard is used to stream H.264 video when
Multicast Streaming
unicast or multicast streaming is used. Each viewer retrieves an SDP
file. SDP files can be stored on a streaming server, or opened by a
media player. For multicast, the destination address is where the
broadcast can be viewed.
l MPEG-TS UDP transport standard is used to stream MPEG-4 video
when unicast or multicast streaming is used. Each viewer retrieves a
UDP address to add to their media player.
l MPEG-TS RTP/UDP transport standard is used to stream video when
a single port is used to stream video and audio via unicast or
multicast. Each viewer retrieves a RTP address to add to their media
player.
This option can be used to stream video and audio to an IP TV or set top
box playlist.
To stream video outside of your LAN, use a CDN or configure port forwarding on your router.
Refer to your Network Administrator; network configuration is beyond the scope of this guide.
The Streaming feature, used for CDNs and multicast streaming, is available only when the H.264
codec is selected.
186
Pearl User Guide
Stream to a CDN
Stream to a CDN
A Content Delivery Network (CDN) relies on geo-diverse CDN servers to receive and disperse web content to
the CDN server closest to the user. The closer the server is to the user the faster the content is delivered.
Streaming your content through a CDN allows you to stream any time, anywhere, regardless of the viewing
device.
You can publish to any CDN provider that supports incoming streams sent via RTSP announce or RTMP push.
Both RTSP and RTMP can be used for live streaming, however not all CDNs or media servers support both
formats. Choose the streaming format that your CDN or media server supports. Epiphan has tested with the
CDN providers listed here: http://epiphan.tv/cdn-partners.php. Contact your CDN for a list of supported
audio codecs and ensure your Encoding configuration uses one of the supported codecs.
To publish content to a CDN provider ensure you have:
l a path to the mount point or an XML configuration file (provided by the CDN provider);
l verify which transport protocols your CDN supports:
l a current flash player; and
l select the H.264 codec from the channel's Encoding page.
You can also test how your content is streamed by sending your content to Epiphan’s CDN. For a list of
Epiphan’s preferred CDN providers, see: http://epiphan.tv/cdn-partners.php.
Use one of the following links to configure your Pearl for publishing to a CDN:
l To stream content to a CDN using RTSP announce
l To stream content to a CDN using RTMP push
l Stream to a CDN using an XML profile
l Stream to Wowza Streaming Cloud
l Test using Epiphan TV CDN
187
Pearl User Guide
Stream to a CDN
To stream content to a CDN using RTSP announce
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, click a Channel; the menu expands.
4. Click Streaming; the channel's Streaming page opens.
5. Scroll to the Stream to a server section of the page.
3. Click the Publish drop-down menu.
4. Choose using RTSP announce from the drop-down menu.
5. Enter the ingestion point url provided by the CDN or media server.
6. Check the Use TCP for RTP stream checkbox. Verify which transport protocols your CDN provider
supports.
7. Enter a user name and password.
8.
The CDN provider assigns a user name and password to authenticate the publisher.
Contact the CDN provider for your log in credentials.
9. Click Apply.
To stream content to a CDN using RTMP push
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, click a Channel; the menu expands.
4. Click Streaming; the channel's Streaming page opens.
188
Pearl User Guide
Stream to a CDN
3. Click the Publish drop-down menu.
4. Choose using RTMP push from the drop-down menu.
3. Enter the ingest point URL provided by the media server or CDN.
4. In the Stream namefield, enter the stream name you configured with the CDN..
5. Enter the CDN user name and password.
The CDN provider assigns a user name and password to authenticate the publisher.
Contact the CDN provider for your log in credentials.
6. Click Apply.
Stream to a CDN using an XML profile
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, click a Channel; the menu expands.
4. Click Streaming; the channel's Streaming page opens.
189
Pearl User Guide
Stream to a CDN
3. Click the Choose File button next to use profile XML; a file browser window opens.
4. Select the XML profile supplied by your CDN and click OK; the configuration is read from the XML file
and applied.
3. Click Apply.
Stream to Wowza Streaming Cloud
To set up streaming via Wowza Cloud, you first need to sign in to the Wowza Streaming Cloud web site and
create a new Live Stream. Retain the connection code that is provided upon applying the configuration
settings; this code is required to complete the streaming set-up process.
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, click a Channel; the menu expands.
4. Click Encoding; the channel's Encoding page opens.
190
Pearl User Guide
Stream to a CDN
5. Configure Encoding settings accordingly, ensuring the Codec selected is H.264.
Configuring audio is optional. Supported formats are limited to MP3 and AAC. Due to RTMP
restrictions, MP3 48 kHz is not supported.
6. Click Apply
7. Under the selected channel, click Streaming; the channel's Streaming page opens.
8. Click the Publish drop-down menu.
9. Select to Wowza Cloud from the drop-down list.
191
Pearl User Guide
Stream to a CDN
10. Enter the connection code obtained from the Wowza Streaming Cloud set-up into the Connection
code field.
11. Click Set to pair the channel on Epiphan's encoder with the live stream on Wowza Cloud
12. Click Apply. When the connection to Wowza Cloud has been established, the stream name appears on
the channel's Status page.
After clicking Apply, there may be a short 2-3 minute delay before the live stream is displayed.
192
Pearl User Guide
Stream to a CDN
Stream to Original Livestream
To set up streaming via the Original Livestream service, you first need to sign in to your Original Livestream
account and create a new stream.
To configure streaming on your Pearl:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, click a Channel; the menu expands.
4. Click Encoding; the channel's Encoding page opens.
5. Configure Encoding settings accordingly, ensuring the Codec selected is H.264.
Configuring audio is optional. Supported formats are limited to MP3 and AAC. Due to RTMP
restrictions, MP3 48 kHz is not supported.
6. Click Apply
7. Under the selected channel, click Streaming; the channel's Streaming page opens.
193
Pearl User Guide
Stream to a CDN
8. Click the Publish drop-down menu.
9. Select Original Livestream from the drop-down list.
10. Enter the channel name in the Short channel name field.
11. Enter your Original Livestream Username and Password in the next two fields.
12. Click Apply. When the connection to Original Livestream has been established, the stream name
appears on the channel's Status page, similar to this example from wowza streaming cloud.
After clicking Apply, there may be a short 2-3 minute delay before the live stream is displayed.
Test using Epiphan TV CDN
Epiphan.tv is a service provided by Epiphan to help our customers to experiment with content distribution
networks, bandwidth, performance limits and viewer limits are applied. To upgrade to a full service, select one
of Epiphan’s preferred CDN provider at http://epiphan.tv/cdn-partners.php.
194
Pearl User Guide
Stream to a CDN
Stream to Epiphan TV
To hear audio content from Epiphan TV ensure audio is set to MP3 in Encoding configuration.
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, click a Channel; the menu expands.
4. Click Streaming; the channel's Streaming page opens.
5. Scroll to the Stream to a server section of the page.
6. Click the Publish drop-down menu.
7. Choose to <serial>. Epiphan.tv. Where <serial> is the serial number of the system.
8. Click Apply; a connection through the media tunnel is established. The system streams to the Epiphan’s
portal – epiphan.net.
You must set audio format to MP3 when streaming through epiphan.net, see Configure
encoding .
View content from Epiphan TV
Before viewing content from Epiphan TV ensure you have:
l a current browser;
l a current flash player;
195
Pearl User Guide
Stream to a CDN
l select the H.264 codec from the channel's Encoding page; and
l set the stream bitrate lower than 500 kbits/s in the channel's Encoding setup.
To view content:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, click a Channel; the menu expands.
4. Click Streaming; the channel's Streaming page opens.
3. Click the link to view the broadcast.
4. A web page opens displaying the broadcast.
Specify a multimedia player to view your Epiphan TV broadcast
1. From the Epiphan TV portal, click Switch To on the bottom of the screen; the following options
appear.
196
Pearl User Guide
Stream to a CDN
2. Choose a plug-in from the list, the stream is displayed using the selected multimedia player.
Add a link to your website to stream your Epiphan TV broadcast
Follow the steps below to embed code for the broadcast in a web page.
1. Go to the Epiphan TV portal.
2. Click Embed on the bottom of the screen; a dialog box opens displaying the code.
3. Highlight and right-click on the code in the dialog box. A drop-down menu appears.
4. Choose Copy.
5. Paste the content into the HTML code for your website. A link to your broadcast on Epiphan TV is
added to your web page.
Retrieve a list of addresses based on video stream encapsulation
1. Go to the Epiphan TV portal.
2. Click Direct URLs on the bottom of the screen; a dialog box opens displaying a list of URLs for
different types of streams.
3. Use the copy and paste function to provide viewers with the URL to view the stream.
197
Pearl User Guide
Stream content using multicast
Stream content using multicast
A multicast stream consists of one stream distributed to many viewers via a multicast-capable network. Pearl
supports the following multicast streaming options:
l Using RTP/UDP push
l Using MPEG-TS UDP push
l Using MPEG-TS RTP/UDP push
Pearl supports multicast streaming content to an IP TV or a set-top box playlist when the stream format is
MPEG-TS. The following procedures outline the steps to distribute your content using multicast streaming.
MPEG-TS streams using RTP/UDP push
Before configuring your channel for MPEG-TS streaming, ensure the following codecs are configured:
l Video – H.264
l Audio – MP3 or AAC, if audio is configured.
To configure your channel for MPEG-TS using RTP/UDP push:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, click a Channel; the menu expands.
4. Click Streaming; the channel's Streaming page opens.
5. Click the Publish drop-down menu.
6. Choose using MPEG-TS RTP/UDP push.
7. Enter the destination multicast IP address where the broadcast can be viewed.
A IPv4 multicast address range is an address between 224.0.0.0 to 239.255.255.255.
Contact your System Administrator for the specific address to use.
8. Enter the destination port number through which the media will stream.
9. Perform one of the following:
a. If you do not want to advertise your stream to a media player over a local network, go to the last
step of this procedure; or
b. To advertise your stream to a media player over a local network, follow the steps below.
198
Pearl User Guide
Stream content using multicast
10. Enable the SAP announcement checkbox to advertise your stream over a local network. When the
checkbox is enabled and a multicast IP address is configured, your stream is displayed in the playlist of
local media player.
11. Enter a multicast IP address in the SAP announcement IP field. If your media player is configured to
receive multicast streams from an IP address that is different from the default address 224.2.127.254,
you may need to contact your system administrator for a specific multicast IP address.
12. Enter a channel number in the Channel number field to identify your stream in the media player. By
default the Channel number is the channel identifier.
When a channel number value is not specified, viewers cannot select a channel from the
set-top box or Smart TV .
13. Enter a name for a group of streams in the text box next to Group name. Since media players simply
present a list of available streams, you can organize your streams into multiple folders or in cases where
folders are not displayed, use dot separator hierarchy to help your viewers filter out unwanted streams
by category.
14. Click Apply.
15. Click the Info menu option of the web interface. An Info page opens displaying stream information.
To view the stream from a media player, open the URL in a media player, for example:
rtp://@ip:port or in the case of the sample configuration in the figure shown above:
rtp://@226.10.24.32:7000
To view the stream when SAP announce has been set and the stream is advertised on a media player, set-topbox or Smart TV, refer to Viewing with Session Announcement Protocol (SAP).
MPEG-TS streams using UDP push
Before configuring your channel for the MPEG-TS streaming, ensure the following codecs are configured:
l Video – H.264
l Audio – MP3 or AAC, if audio is configured.
To configure MPEG-TS with UDP push:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
199
Pearl User Guide
Stream content using multicast
3. From the web interface, click a Channel; the menu expands.
4. Click Streaming; the channel's Streaming page opens.
5. Click the Publish drop-down menu.
6. Choose using MPEG-TS UDP push.
7. Enter the destination multicast IP address where the broadcast can be viewed.
A IPv4 multicast address range is an address between 224.0.0.0 to 239.255.255.255.
Contact your System Administrator for the specific address to use.
8. Enter the destination port number through which the media will stream.
9. Perform one of the following:
a. If you do not want to advertise your stream to a media player over a local network, go to the last
step of this procedure; or
b. To advertise your stream to a media player over a local network, follow the steps below.
10. Enable the SAP announcement checkbox to advertise your stream over a local network. When the
checkbox is enabled and a multicast IP address is configured, your stream is displayed in the playlist of
local media players.
200
Pearl User Guide
Stream content using multicast
11. Enter a multicast IP address in the SAP announcement IP field. If your media player is configured to
receive multicast streams from an IP address that is different from the default address 224.2.127.254,
you may need to contact your system administrator for a specific multicast IP address.
12. Enter a channel number in the Channel number field to identify your stream in the media player. By
default the Channel number is the channel identifier.
When a channel number value is not specified, viewers cannot select a channel from the
set-top box or Smart TV .
13. Enter a name for a group of streams in the text box next to Group name. Since media players simply
present a list of available streams, you can organize your streams into multiple folders or in cases where
folders are not displayed, use dot separator hierarchy to help your viewers filter out unwanted streams
by category.
14. Click Apply. To view the stream, open the URL in a media player, for example:
udp://@ip:port
For example: udp://@226.10.24.32:7000
To view the stream when SAP announce has been set and the stream is advertised from a media player,
set-top-box or Smart TV, refer to Viewing with SAP Announce.
Multicast streaming using RTP/UDP
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, click a Channel; the menu expands.
4. Click Streaming; the channel's Streaming page opens.
3. Click the Publish drop-down menu.
4. Choose using RTP/UDP push.
201
Pearl User Guide
Stream content using multicast
5. Enter the destination multicast IP address.
6. Enter the port number through which the audio will stream.
7. Enter the port number through which the video will stream.
Audio and video use nearby port numbers (<port number>and <port number+2>). The minimum
distance between audio and video ports must be 2.
8. Click Apply; an SDP file is generated and available from the Status page of the web interface.
9. Select a name and location for the SDP file and save it.
10. Share the link to the file with viewers.
202
Pearl User Guide
Stream to a media player
Stream to a media player
Your Pearl can use UPnP and SAP to stream to set top boxes, digital signs, smart TVs and other digital media
players.
The following table gives an overview of each option.
Publishing Options
Use this option to...
Using the Universal Plug and Play (UPnP) networking protocol, your Pearl
UPnP
can be discovered and can stream to software and hardware media players,
set-top-boxes and Smart TVs with ease.
SAP (session announcement protocol) is a protocol for broadcasting
SAP
multicast session information. Media players can see the announcement or
can use the multicast SDP file (session description file) directly.
To stream video outside of your LAN, use a CDN or configure port forwarding on your router.
Refer to your Network Administrator; network configuration is beyond the scope of this guide.
Stream content using multicast
A multicast stream consists of one stream distributed to many viewers via a multicast-capable network. Pearl
supports the following multicast streaming options:
l Using RTP/UDP push
l Using MPEG-TS UDP push
l Using MPEG-TS RTP/UDP push
Pearl supports multicast streaming content to an IP TV or a set-top box playlist when the stream format is
MPEG-TS. The following procedures outline the steps to distribute your content using multicast streaming.
MPEG-TS streams using RTP/UDP push
Before configuring your channel for MPEG-TS streaming, ensure the following codecs are configured:
l Video – H.264
l Audio – MP3 or AAC, if audio is configured.
To configure your channel for MPEG-TS using RTP/UDP push:
203
Pearl User Guide
Stream content using multicast
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, click a Channel; the menu expands.
4. Click Streaming; the channel's Streaming page opens.
5. Click the Publish drop-down menu.
6. Choose using MPEG-TS RTP/UDP push.
7. Enter the destination multicast IP address where the broadcast can be viewed.
A IPv4 multicast address range is an address between 224.0.0.0 to 239.255.255.255.
Contact your System Administrator for the specific address to use.
8. Enter the destination port number through which the media will stream.
9. Perform one of the following:
a. If you do not want to advertise your stream to a media player over a local network, go to the last
step of this procedure; or
b. To advertise your stream to a media player over a local network, follow the steps below.
10. Enable the SAP announcement checkbox to advertise your stream over a local network. When the
checkbox is enabled and a multicast IP address is configured, your stream is displayed in the playlist of
local media player.
11. Enter a multicast IP address in the SAP announcement IP field. If your media player is configured to
receive multicast streams from an IP address that is different from the default address 224.2.127.254,
you may need to contact your system administrator for a specific multicast IP address.
12. Enter a channel number in the Channel number field to identify your stream in the media player. By
default the Channel number is the channel identifier.
When a channel number value is not specified, viewers cannot select a channel from the
set-top box or Smart TV .
13. Enter a name for a group of streams in the text box next to Group name. Since media players simply
present a list of available streams, you can organize your streams into multiple folders or in cases where
folders are not displayed, use dot separator hierarchy to help your viewers filter out unwanted streams
by category.
14. Click Apply.
204
Pearl User Guide
Stream content using multicast
15. Click the Info menu option of the web interface. An Info page opens displaying stream information.
To view the stream from a media player, open the URL in a media player, for example:
rtp://@ip:port or in the case of the sample configuration in the figure shown above:
rtp://@226.10.24.32:7000
To view the stream when SAP announce has been set and the stream is advertised on a media player, set-topbox or Smart TV, refer to Viewing with Session Announcement Protocol (SAP).
MPEG-TS streams using UDP push
Before configuring your channel for the MPEG-TS streaming, ensure the following codecs are configured:
l Video – H.264
l Audio – MP3 or AAC, if audio is configured.
To configure MPEG-TS with UDP push:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, click a Channel; the menu expands.
4. Click Streaming; the channel's Streaming page opens.
5. Click the Publish drop-down menu.
6. Choose using MPEG-TS UDP push.
205
Pearl User Guide
Stream content using multicast
7. Enter the destination multicast IP address where the broadcast can be viewed.
A IPv4 multicast address range is an address between 224.0.0.0 to 239.255.255.255.
Contact your System Administrator for the specific address to use.
8. Enter the destination port number through which the media will stream.
9. Perform one of the following:
a. If you do not want to advertise your stream to a media player over a local network, go to the last
step of this procedure; or
b. To advertise your stream to a media player over a local network, follow the steps below.
10. Enable the SAP announcement checkbox to advertise your stream over a local network. When the
checkbox is enabled and a multicast IP address is configured, your stream is displayed in the playlist of
local media players.
11. Enter a multicast IP address in the SAP announcement IP field. If your media player is configured to
receive multicast streams from an IP address that is different from the default address 224.2.127.254,
you may need to contact your system administrator for a specific multicast IP address.
12. Enter a channel number in the Channel number field to identify your stream in the media player. By
default the Channel number is the channel identifier.
206
Pearl User Guide
Stream content using multicast
When a channel number value is not specified, viewers cannot select a channel from the
set-top box or Smart TV .
13. Enter a name for a group of streams in the text box next to Group name. Since media players simply
present a list of available streams, you can organize your streams into multiple folders or in cases where
folders are not displayed, use dot separator hierarchy to help your viewers filter out unwanted streams
by category.
14. Click Apply. To view the stream, open the URL in a media player, for example:
udp://@ip:port
For example: udp://@226.10.24.32:7000
To view the stream when SAP announce has been set and the stream is advertised from a media player,
set-top-box or Smart TV, refer to Viewing with SAP Announce.
Multicast streaming using RTP/UDP
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. From the web interface, click a Channel; the menu expands.
4. Click Streaming; the channel's Streaming page opens.
3. Click the Publish drop-down menu.
4. Choose using RTP/UDP push.
207
Pearl User Guide
Stream content using multicast
5. Enter the destination multicast IP address.
6. Enter the port number through which the audio will stream.
7. Enter the port number through which the video will stream.
Audio and video use nearby port numbers (<port number>and <port number+2>). The minimum
distance between audio and video ports must be 2.
8. Click Apply; an SDP file is generated and available from the Status page of the web interface.
9. Select a name and location for the SDP file and save it.
10. Share the link to the file with viewers.
Viewing with Session Announcement Protocol (SAP)
When SAP Announce is configured for a stream that uses UDP streaming, the stream is advertised over the
local network. Local viewers can view the stream using a software or hardware media player. Viewers are
presented with a list of available channels, similar to a television menu. Viewers need only click on a stream
and the video is streamed to their desktop, mobile or tablet. To configure SAP announce, go to Stream
content using multicast.
Your stream is advertised by the metadata title, if one was configured under Branding, otherwise it is
identified by it's channel identifier. For a description of how to set the metadata, refer to Add channel
metadata.
208
Pearl User Guide
Stream content using multicast
When browsing from a VLC media player, streams are advertised by their channel identifier and are organized
by the group name. When browsing from an XBMC media player, streams are advertised by the stream's
metadata title, if configured, otherwise streams are advertised by their channel identifier.
1. Ensure the stream has SAP announcement enabled, otherwise it is not advertised in the media player's
playlist.
2. Ensure the SAP announcement IP is a multicast IP address.
3.
Some media players, for example Exterity receivers, listen for SAP announcements on a
specific multicast address 239.255.255.255. If your audience is using Exterity to view your
stream, you must change the SAP announcement IP address to 239.255.255.255.
4. Launch a media player. The following steps are based on a VLC media player and may be different for
other media players.
5. Click View from the menu; a drop-down menu opens.
6. Select Playlist. A Playlist window opens. The right-hand panel indicates the playlist is empty.
7. From the side menu, click Network streams (SAP). The playlist is populated with all streams in your
network that are SAP announcement enabled. If you specified a Group Name when you configured the
publish stream the stream will be listed in folder identified by the group name.
In the example below, two streams D2P83658.vga and D2P83658.video are organized in a folder by their
group name.
8. Click on a live stream; the stream plays in the media player window.
209
Pearl User Guide
Stream content using UPnP
Stream content using UPnP
Using the Universal Plug and Play (UPnP) networking protocol, your Pearl can be discovered and can stream
to software and hardware media players, set-top-boxes and Smart TVs with ease. If UPnP is enabled, the
system automatically establishes communication with media players on the network.
UPnP uses MPEG-TS over HTTP with the H.264 codec and MP3 or AAC audio encoding (or no audio). You can
only access live streams or recordings that meet these requirements.
For security reasons the default behavior prevents UPnP access to live streams and recorded files.
This section covers the following topics:
l Enable UPnP
l Disable UPnP
l Viewing with UPnP
l Play directly to a media player
l Auto-restart playback to a UPnP device
l Change UPnP device name
Some players will not be able to access the stream or saved recordings if a view password is set. If
needed, see User administration to clear the viewer password.
The topics in this chapter include how to enable and disable UPnP and how to control media players from
Pearl. To choose recordings or live streams from your media player, see Stream content using UPnP.
Enable UPnP
Enable UPnP to allow digital media players on the network to browse for media or live streams from your
system. There are two steps required to enabled UPnP, enabling UPnP for the system (including setting a
share name) and enabling UPnP per channel or recorder. By default, UPnP is disabled at the system level and
for each channel.
Streams and MPEG-TS recorded files must use the supported codecs: H.264 with MP3 or AAC
audio. Having a viewer password could prevent the ability to use UPnP.
To enable UPnP:
210
Pearl User Guide
Stream content using UPnP
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Click the UPnP link in the Configuration section; the UPnP configuration page opens.
4. Enter a name in the Server name field. If no name is provided the server name will be the system's
serial number.
5. Select whether you want to share live video and recorded files.
6. Click Apply.
7. If no live stream is available that meets the criteria for UPnP, a message is displayed in the Play on
service start section of the page.
8. Otherwise, the Play on service start section shows a drop-down list of what can be streamed.
Enable UPnP sharing for the channels or recorders you want to share:
211
Pearl User Guide
Stream content using UPnP
1. For channels (live streaming):
a. Click the Streaming link for the desired channel; the Streaming page opens.
a. Click the Share via UPnP check box (if not checked).
b. Click Apply
2. For channels (recorded files):
a. Click Recording for the desired channel; the channel's recording page opens.
b. Click the word change next to the list of what is being recorded; the recording options expand.
c. Click the Share via UPnP check box (if not checked).
d. Click Apply.
3. For recorders:
a. Click the link for the recorder from the Recorders menu; the recorder's configuration page
opens.
b. Click the word change next to the list of what is being recorded; the recording options expand.
212
Pearl User Guide
Stream content using UPnP
c. Click the Share via UPnP check box (if not checked).
d. Click Apply.
You can now browse for your server from your digital media player.
Disable UPnP
By default, UPnP sharing is disable for the device, and for each channels and recorder. If you enabled UPnP
sharing it for a particular broadcast, you may want to disable UPnP sharing after the broadcast is complete.
You can choose to disable access to live streams, recorded files, or to the whole system.
To disable UPnP for a channel or recorder:
1. For channels:
a. Click the Streaming link for the desired channel; the Streaming page opens.
b. Deselect the Share via UPnP check box (if checked).
c. Click Apply
2. For recorders:
a. Click the link for the recorder from the Recorders menu.
b. Click the word change next to the list of what is being recorded; the recording options expand.
a. Deselect the Share via UPnP check box (if not checked).
b. Click Apply.
To disable UPnP globally (for the whole system):
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Click the UPnP link in the Configuration section; the UPnP configuration page opens.
4. Deselect Share live video through UPnP to stop sharing live video.
5. Deselect Share recorded files through UPnP to stop sharing recorded files.
6. Click Apply; UPnP sharing is disabled.
213
Pearl User Guide
Stream content using UPnP
Viewing with UPnP
Using a software or hardware media player, you can browse for files or streams with Universal Plug and Play
(UPnP). UPnP uses MPEG-TS over HTTP with the H.264 codec and MP3 or AAC audio encoding (or no audio).
You can only access live streams or recordings that meet these requirements.
For security reasons the default behavior prevents UPnP access to live streams and recorded files.
To enable UPnP, see What is streaming?
Some players cannot access the stream or saved recordings if a viewer password is set. If needed,
see User administration to clear the viewer password.
When browsing via UPnP your Pearl is displayed by the server name you set, or it's product serial number.
For example, when browsing from a Windows computer, you will see a list of media devices that includes
Pearl:
Live Streams
When you open the device from Windows Media Player, you'll see a list of the available channels you can
stream under the Videos tab. From other digital media players, the channel list can be under a Live Streams
folder.
With Windows Media Player, double click to open any channel and press Play to start the stream. Using your
digital media player, select a live stream and press play.
Recorded Files
Recorded files are shown in the Recorded Files folder. Files are organized by the channel or recorder from
which they were recorded. Windows Media Player shows the recorder files side by side with the channels and
other digital media players show the recorded files in a file tree format, see below.
214
Pearl User Guide
Stream content using UPnP
UPnP can also be used to directly play a recording to the digital media player, or to set a media player to
automatically play a particular live stream after reboot of Pearl. See What is streaming? and What is
streaming?.
Play directly to a media player
If your digital media player is UPnP enabled, Pearl can play direct the media player to play recorded files,
without browsing through menus in the player.
Recorded files must be in MPEG-TS format and use the supported codecs: H.264 with MP3 or AAC
audio. Having a viewer password could prevent the ability to use UPnP.
To play directly to a media player:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Ensure Share recorded files through UPnP is enabled on your Pearl and for the channel or recorder
you wish to share. (See Play directly to a media player.)
4. Go to the recorded files list for the desired channel or recorder. (See Recorded files.)
5. From the list of files, select the file you want to play and click on the Play To icon for the file; a list of
visible digital media players is displayed.
6. Select a media player; the recording plays on the screen(s) connected to the media player.
Auto-restart playback to a UPnP device
In unmanned situations such as industrial applications and digital signs, it is useful to automatically have a
stream played to a digital media player, even if Pearl restarts.
To configure auto-restart of a stream to a media player:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
215
Pearl User Guide
Stream content using UPnP
3. Click the UPnP link in the Configuration section; the UPnP configuration page opens.
4. Scroll to the Play on service start section.
5. Select a stream to use from the Live stream drop-down list.
6. Select a digital media player from the Player drop-down list. (Digital media players on your network
that support UPnP playback will automatically appear in the drop-down list.)
7. Click Apply.
Only a single stream and player combination can be configured for auto play. The channel's UPnP
configuration must be enabled for it to appear.
Change UPnP device name
You can configure the UPnP server name that appears for your Pearl. By default, if you left the server name
field blank when enabling UPnP, the server name is the system's serial number.
To change the UPnP server name:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Click the UPnP link in the Configuration section; the UPnP configuration page opens.
4. Highlight and delete the text in the Server name field, if any.
5. Type a new server name. Use characters A-Z, a-z, 0-9, _, :, @, ^, #, -. {}, [], ().
6. Click Apply; the name changes.
216
Pearl User Guide
Samples of stream settings
Samples of stream settings
When choosing your stream settings it is important to consider the stream content. When streaming fast
moving video it's best to choose a higher bitrate and frame rate versus streaming a slide presentation where
you can save on bandwidth and system processing by lower the bitrate and frame rate. Stream setup is a
matter of balancing quality and system resource usage.
To help you to achieve this balance the following tables list the recommended settings when streaming video
and slide content from a PC, Mac or tablet.
Streaming video content
The table below provides suggested settings to maximize your video quality while minimizing system resource
usage when streaming video content from a PC, Mac or tablet.
Setting
PC and Mac
Tablet
H.264
Motion JPEG
Video encoding preset
High Speed
Video encoding profile
Main
Codec
Enhanced compatibility mode
Disable for PC
(h.264 slicing for RTP)
Enable for Mac
Key frame interval
Limit frame rate
2 sec
30
30
2000 Kbits for HD
Bitrate
3000 Kbits for Full HD
auto
3000 kbits for ~ HD; 4000
kbits for ~ Full HD (Mac)
Rate control mode
Audio format
Balanced
PCM 22 KHz
217
Pearl User Guide
Streaming slide content
Streaming slide content
The table below provides suggested settings to maximize your stream quality while minimizing system
resource usage when streaming slide content from a PC, Mac or tablet.
Setting
PC and Mac
Tablet
H.264
Motion JPEG
Video encoding preset
High Quality
Video encoding profile
High
Codec
Enhanced compatibility mode (h.264
Disable for PC
slicing for RTP)
Enable for Mac
Key frame interval
Limit frame rate
2 sec
15
15
Bitrate
Rate control mode
Audio format
auto
Balanced
PCM 44 KHz
218
PART 4: Record
Your Pearl encodes the video and audio it captures. Not only can you stream this content, but you can also
simultaneously record it. In fact, if you're streaming a picture in picture layout or low quality streams, you may
even want to create separate channels to also record each input at full frame size and with a high bitrate so
you have the best possible digital media for future re-use or post-processing.
If you choose to record your channels, Pearl stores the recorded files on the system's amply-sized hard drive
and provides you a variety of automatic or manual mechanisms to download the files.
This section discusses the following topics related to recording:
l What is a recording?
l Recorders
l Recorded files
l File and recording transfer
l Local FTP server
219
Pearl User Guide
What is a recording?
What is a recording?
Your Pearl can record the output from each channel. (See Recorders for information on creating multi-track
recorders using multiple channels.) Recordings are very robust and crafted so that even in the case of
accidental system shutdown, recording files are closed off and playable.
You can choose to record simultaneously while streaming, or record without streaming.
This section describes the following topics for creating and configuring recordings via the web interface.
l Recording basics
l Record a channel via the web interface
l Record a channel via the touch screen
l Record with a recorder
l Configure recording file size
l Restart recording
l Control recording with a mouse
l Control recording with the big red button
l Save directly to USB drive
Recording control is easily performed through the Web admin interface, but can also be set up for third party
tools using our APIs. See Control with HTTP commands and Control with RS-232 / serial port for information
on controlling recordings with third party tools.
See Recorded files to learn how to download the recorded files.
Recording can also be controlled via the tablet interface. See Control recording via the tablet
interface.
Recording basics
While recording a channel or recorder, a new file is created each time the maximum time or size limit is met.
Additionally, when recording a multi-channel recorder or a multi-source layout channel, a new file is created if
an additional source is added to the recorder.
Physically removing the source (e.g. unplugging it) or otherwise interrupting the signal to the source does not
affect recording, and the recording will include the configured No Signal image. When recording auto channels,
a new recording is made when the input changes from one to another due to signal loss. Recording is stopped
220
Pearl User Guide
Record a channel via the web interface
if the channel, or all channels in a recorder, are made inactive by changing the channel configuration to "no
source" via the admin interface.
You can choose to create AVI, MP4, MOV or MPEG-TS recordings. See Recording basics to learn how to change
the recorded file type.
The MOV file type created by Pearl requires a relatively newer player for playback. Epiphan has tested with the
following players.
Operating System
Tested Players
l QuickTime 10.3 (for 1080p streams)
Mac OS
l QuickTime 10.3 (for streams less than 1080p)
l VLC 1.0.0+ (for all streams)
l QuickTime 7.6.6+
Windows
l VLC 2.1.5+
l Windows Media player 12+ (except MOV files)
l MPlayer
Linux
l VLC 2.0.8+
l DICE 2.0.21
Android
l VLC 0.9.9+ (works only with MOV files that have no audio)
HTML 5 Browsers (Windows)
l Google Chrome 37+ (works with MOV and MP4 files using H.264 codec)
Record a channel via the web interface
Each channel has a configuration page that allows you to start, stop and configure recordings.
To start and stop channel recording:
1. Connect to the admin interface using your preferred connection mechanism. SeeConnect to the admin
interface.
2. Login as admin or operator.
3. Click the name of the desired channel; the channel menu expands.
221
Pearl User Guide
Record a channel via the web interface
4. Click the Recording link for the channel; the Recording page appears.
5. To Start Recording:
a. Click the Start button; the recording starts and a timer indicates how long it has been recording.
If the start button is not active, there are no active sources for this channel or recorder.
Check your inputs to ensure signals are working as expected.
b. You may browse away from the page without affecting the recording. When the page refreshes,
the channel number is displayed in red to indicate recording is underway.
222
Pearl User Guide
Record a channel via the touch screen
c. The system continues to record this channel (and any concurrent recordings) until it is stopped.
If the system runs out of storage space, the oldest recorded file is deleted to make room for the
new recording. The recording is broken into multiple files as defined by the channel
configuration. See Record a channel via the web interface.
6. To Stop Recording:
a. Click the Stop button on the given channel’s Recording page. The channel number changes to
black next time the web interface is refreshed (by clicking a link or refreshing the page).
Record a channel via the touch screen
Pearl's touch screen gives you freedom to start and stop recording without needing to log in to the web
interface.
Simply scroll to the channel you wish to control and press the start or stop recording button.
223
Pearl User Guide
Record a channel via the touch screen
The touch screen may be configured to be always off, to prevent channel preview, or to prevent
recording control. If you are unable to follow the instructions below, see the Configure the
touch screen
To start recording:
1. If necessary, tap the screen once to turn it on or to turn on the screen overlay.
2. If the grid view is showing, tap the channel for which you wish to control recording; the screen displays
the channel.
3. If necessary, tap the screen once to display controls on the channel view.
4. Touch the red record button at the top right of the screen; recording starts and a timer is displayed to
show the length of the recording.
To stop recording:
1. If necessary, tap the screen once to turn it on.
2. If the grid view is showing, tap the channel for which you wish to control recording; the screen displays
the channel.
3. If necessary, tap the screen once to display controls on the channel view.
4. Touch the red record button at the top right of the screen; recording stops and the timer disappears.
224
Pearl User Guide
Configure recording file size
Configure recording file size
By default, recorders and channels record to AVI files. When the recording reaches 30 minutes in length or a
file size of 500 MB (whichever occurs first), the system closes the current recording file and opens a new one.
This is done seamlessly with no loss in recorded data.
You may find it useful to have recordings divided this way for ease of download, but you may also want to
change the recording limits to be larger or smaller to meet your individual situation.
Additionally you can configure the prefix for all recordings (the suffix is the date and time of the recording)
and you can exclude a channel or recorder’s recordings from automatic upload.
To change the recording configuration:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. For a channel recording:
a. Click the desired channel; the channel menu expands.
b. Click the Recording link for the channel; the Recording page opens.
4. For a recorder:
a. Click the desired recorder link from the Recorders section; the recorder configuration page
opens.
5. Click the change link under Recorder Setup; the recorder setup section expands. (The setup page looks
slightly different for Recorders, but the options are the same.)
6. Select a time limit for the recording from the Time limit drop down.
7. Select a file size limit from the Size limit drop down.
Tip: If you don’t know what size to select, do some test recordings to get an idea of the file
sizes you can expect. If you want to guarantee the recording lasts to a given time limit,
select a file size that is far larger than you saw in your tests.
225
Pearl User Guide
Configure recording file size
8. Select a file type from the File type drop down.
9. If desired, enter a prefix for the recordings. All new recording files for this channel or recorder will be
prefixed with the text you enter.
Tip: It’s best to avoid spaces in file names. Use underscores or hyphens to separate words.
10. If desired, click the check box to exclude this channel or recorder from automatic file uploads. (See File
and recording transfer for information on automatic uploads.)
11. Click Apply; the changes are saved and the recorder setup displays the new configuration.
The table below describes the options available for recording file configuration.
Table 25 Recording File Configuration Fields
Label
Description / Options
Specifies the length of time the system waits before the recording file is saved and a
Time limit
new one is started (assuming the size limit has not yet been reached). Values range
from 5 minutes to six hours.
Specifies the file size a recording can become before it is saved and a new one is started
Size limit
(assuming the time limit has not yet been reached). Values range from 50 MB to 64 GB.
Specifies the recording file type. Select from AVI, MP4, MPEG-TS, or MOV. Choose
MPEG-TS for UPnP playback.
File type
Notes:
MP4 and MOV are fragemented formats with fixed 10 s intervals.
MPEG-TS does not support PCM audio encoding.
Specifies how the recordings are named. Recording files start with the given prefix folFilename prefix
lowed by the date and time. The channel or recorder name is used if no prefix is given.
Allowed characters: A-Z, a-z, 0-9, _, , #, -, [], ().
Automatic file
Select this if you want this channel or recorder to be part of any scheduled automatic
upload
uploads. (See File and recording transfer for information on automatic uploads.)
226
Pearl User Guide
Label
Restart recording
Description / Options
Select this if you want this channel or recorder to be avialable via UPnP. If global UPnP
Share via UPnP
is not enabled when you select this checkbox, a link appears to let you to fix it. Click the
link and click Apply to make the global UPnP change save your recording configuration
changes.
Restart recording
Recording files are automatically saved and new ones opened for writing when they reach the configured time
or size limit, when the channel or recorder name is changed, or when changes are made to the stream.
You cannot download files from the system while they are being recorded, so from time to time you may need
to close the current recording and restart a new one to facilitate file downloads. The system supports this
through the recording reset option, which closes the current recording file and opens a new one without
missing any frames.
To close the current recording and start a new file:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. For a channel recording:
a. Click the desired channel; the channel menu expands.
b. Click the Recording link for the channel; the Recording page opens.
4. For a recorder:
a. Click the desired recorder link from the Recorders section; the recorder configuration page
opens.
5. Click the Reset button next to the stop button; the current file is stopped and a new one begins.
6. Refresh the page to see the new recorded files list.
227
Pearl User Guide
Recorders
Recorders
Your Pearl can record the output from each channel and, using Recorders, it can also record multiple channels
together in a single multi-track file.
Recording multiple channels at once ensures the recordings are started and stopped at the same time,
resulting in perfect synchronization. Once the recording is complete, you can automatically use one of the
system's file synchronization methods to copy it off the server, or you can use our built-in tool to split the file
into individual tracks for post-processing.
You only need to create recorders for multi-track recordings. For single channel recordings, see
Record a channel via the web interface.
This section describes the following topics for creating and managing multi-channel recorders.
l Add a recorder
l Change the channels recorded by a recorder
l Record with a recorder
l Rename a recorder
l Delete a recorder
See What is a recording? to learn how to create recordings and configure recording file sizes.
Add a recorder
Each channel has its own built-in recorder that is accessible from the Recording link. If you want to record
several channels simultaneously to a multi-track file, create a new recorder.
To add a new recorder:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Click the Add recorder link from the Recorders section; a new recorder is created and the recorder
configuration page opens. By default this recorder uses the next available number and records all
channels.
228
Pearl User Guide
Change the channels recorded by a recorder
Change the channels recorded by a recorder
By default when you create a new recorder, it records all the channels configured on the system. If new
channels are added, they are automatically added to the recorder.
If you wish to record a subset of channels to a single multi-track file, you can edit the channels recorded by a
recorder.
To change the channels recorded by a recorder:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the desired recorder link from the Recorders section; the recorder configuration page opens.
4. Click change next to the list of what is currently being recorded.
5. If the all channels box is selected, click it to deselect it; the other check boxes are enabled.
6. Click the check boxes for the desired channels.
229
Pearl User Guide
Record with a recorder
Channels with no active video source are displayed in italics. You can include these channels
in your channel selections for the recorder.
7. Click Apply; the changes are reflected in the recorder configuration page.
Record with a recorder
Recorders are stopped and started via their configuration page. Multiple recorders and channel recordings can
occur concurrently.
The number of channels being recorded is displayed below the recording stop/start buttons. To configure the
channels being recorded, see Change the channels recorded by a recorder.
To start and stop recorder:
1. Connect to the admin interface using your preferred connection mechanism. SeeConnect to the admin
interface.
2. Login as admin or operator.
230
Pearl User Guide
Record with a recorder
3. Click the name of the desired recorder; the recorder configuration page appears.
4. To Start Recording:
a. Click the Start button; the recording starts and a timer indicates how long it has been recording.
b. You may browse away from the page without affecting the recording. When the page refreshes,
the recorder number is displayed in red to indicate recording is underway.
c. The system continues to record this recorder (and any concurrent recordings) until it is stopped.
If the system runs out of storage space, the oldest recorded file is deleted to make room for the
new recording. The recording is broken into multiple files as defined by the recorder
configuration. See Record with a recorder.
5. To Stop Recording:
231
Pearl User Guide
Rename recorded files
a. Click the Stop button on the given recorder's configuration page. The recorder number changes
to black next time the web interface is refreshed (by clicking a link or refreshing the page).
Rename recorded files
Recording files are named based on the filename prefix specified during configuration. If needed, you can
rename them to something more descriptive.
You can also change the default naming mechanism. See What is a recording? for more details about setting
filename prefixes.
To rename recordings:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Find the recordings by channel or by recorder. See Rename recorded files.
4. Select the pencil and paper icon next to the filename you wish to change.
5. Type the new file name and press enter when finished.
The web interface keeps track of the filename extension (i.e. .avi) so you do not need to
include it when renaming the file.
Delete recorded files manually
Recordings can be manually deleted via the web interface. You can delete one file at a time, select multiple files
for a given recorder or channel and delete those, or you can delete all recordings for a channel or recorder.
232
Pearl User Guide
Delete recorded files manually
If you want to delete all the files on the system, follow this procedure for each channel and recorder listed in
the web interface.
To delete recordings:
1. Connect to the admin interface using your preferred connection mechanism. SeeConnect to the admin
interface.
2. Login as admin or operator.
3. Find the recordings by channel or by recorder. See Delete recorded files manually.
4. To delete an individual file:
a. Click the X icon to the right of a file entry to request deletion; a confirmation dialog appears.
b. Click OK on the confirmation dialog.
5. To delete multiple files for the current channel or recorder:
a. Select the check box next to the recordings you wish to delete from this channel or recorder.
b. Click Delete Selected; a confirmation dialog appears.
c. Click OK on the confirmation dialog.
The list may not update immediately. You can refresh the list by reloading the Recording
page (for channels) or the recorder settings page (for recorders).
6. To delete all files for the current channel or recorder:
a. Click Delete All; a confirmation dialog appears.
b. Click OK on the confirmation dialog.
233
Pearl User Guide
Delete recorded files manually
The list may not update immediately. You can refresh the list by reloading the Recording
page (for channels) or the recorder settings page (for recorders).
234
Pearl User Guide
Recorded files
Recorded files
Recordings you make of channels or with recorders are stored on the system's internal hard drive. Pearl has a
finite amount of available hard drive storage space. Though it is enough space to hold a lot of recordings, it
will eventually run out of space if recordings are added but never removed. When this happens, the system
deletes the oldest recorded files to make room for new recordings.
You can use a variety of methods to automatically transfer files from the system to local network storage.
Alternatively you can manually select individual recordings to transfer or delete.
This section discusses the following manual file management topics.
l View list of recorded files
l Download recorded files manually
l Extract tracks from a recording
l Rename recorded files
l Delete recorded files manually
For information on automatic file transfers, see File and recording transfer.
View list of recorded files
Recordings for Pearl are stored for each channel and each recorder separately. To view all the recordings
stored, follow the procedures below for all channels and all recorders you have configured.
To view the recordings for a channels or recorders:
1. Connect to the admin interface using your preferred connection mechanism. SeeConnect to the admin
interface.
2. Login as admin or operator.
3. To view files recorded for a channel:
a. Select a channel from the Channels section; the channel menu expands.
b. Select the Recording link for your channel; the Recording page appears.
4. To view files recoded for a recorder:
a. Select the recorder from the Recorders section; the recorder page appears.
5. If there are no files:
a. A message indicates there are no recorded files (for this channel).
235
Pearl User Guide
Download recorded files manually
6. Otherwise:
a. All files for this channel are listed, sorted by date.
Files that are part of the same recording session are listed one after another. Three dots appear
between files of different recording sessions. The file currently being recorded (if applicable) is
shown at the top of the list. It cannot be modified or downloaded until it has finished recording.
Download recorded files manually
Recordings can be manually downloaded from the web interface. You should consider deleting them from
internal storage after you complete the download. See Download recorded files manually, below.
This procedure explains how to download files to your admin computer. See File and recording transfer for
information on transferring files to a USB drive connected to the system.
To download recordings to your admin computer:
1. Connect to the admin interface using your preferred connection mechanism. SeeConnect to the admin
interface.
2. Login as admin or operator.
3. Find the recordings by channel or by recorder. See Download recorded files manually.
236
Pearl User Guide
Extract tracks from a recording
4. To download an individual file:
a. Click the name of a recording file to download it.
5. To download multiple files:
a. Select the check box next to the recordings you wish to download from this channel or recorder.
b. Click Download Selected to download a zip file containing the selected recordings.
Extract tracks from a recording
Recorders combine multiple channels and audio sources together in a single multi-track file. If desired, you can
create a copy of a recording with only select tracks. This feature is supported for .AVI, .MP4 and .MOV
recordings only.
Specific track versions of recorded files are not included in any automatic file transfers. See
Extract tracks from a recording
To create a duplicate recording file with only select tracks:
1. Connect to the admin interface using your preferred connection mechanism. SeeConnect to the admin
interface.
2. Login as admin or operator.
3. Select the recorder from the Recorders section; the recorder page appears.
4. Find the file you want to duplicate and click the up arrow icon next to it; a list of tracks appears.
237
Pearl User Guide
Extract tracks from a recording
5. Select the track(s) you want to extract.
Tip: To deselect all tracks, click the check box for the top track, then hold SHIFT and click the
check box for the bottom track.
6. Click Extract tracks; a duplicate of the recording is made with only the selected tracks.
238
Pearl User Guide
Rename recorded files
Only one duplicate recording is saved per recording file. If you create a second duplicate
recording, it will overwrite the previous copy. Download the file with your extracted tracks to
preserve it.
Rename recorded files
Recording files are named based on the filename prefix specified during configuration. If needed, you can
rename them to something more descriptive.
You can also change the default naming mechanism. See What is a recording? for more details about setting
filename prefixes.
To rename recordings:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Find the recordings by channel or by recorder. See Rename recorded files.
4. Select the pencil and paper icon next to the filename you wish to change.
5. Type the new file name and press enter when finished.
The web interface keeps track of the filename extension (i.e. .avi) so you do not need to
include it when renaming the file.
Delete recorded files manually
Recordings can be manually deleted via the web interface. You can delete one file at a time, select multiple files
for a given recorder or channel and delete those, or you can delete all recordings for a channel or recorder.
If you want to delete all the files on the system, follow this procedure for each channel and recorder listed in
the web interface.
To delete recordings:
239
Pearl User Guide
Delete recorded files manually
1. Connect to the admin interface using your preferred connection mechanism. SeeConnect to the admin
interface.
2. Login as admin or operator.
3. Find the recordings by channel or by recorder. See Delete recorded files manually.
4. To delete an individual file:
a. Click the X icon to the right of a file entry to request deletion; a confirmation dialog appears.
b. Click OK on the confirmation dialog.
5. To delete multiple files for the current channel or recorder:
a. Select the check box next to the recordings you wish to delete from this channel or recorder.
b. Click Delete Selected; a confirmation dialog appears.
c. Click OK on the confirmation dialog.
The list may not update immediately. You can refresh the list by reloading the Recording
page (for channels) or the recorder settings page (for recorders).
6. To delete all files for the current channel or recorder:
a. Click Delete All; a confirmation dialog appears.
b. Click OK on the confirmation dialog.
The list may not update immediately. You can refresh the list by reloading the Recording
page (for channels) or the recorder settings page (for recorders).
240
Pearl User Guide
File and recording transfer
File and recording transfer
Your Pearl can be configured to automatically upload recordings from local storage to a network storage
location or an attached USB drive.
We call this process Automatic File Upload or AFU for short.
This section discusses the following generic automatic upload topics:
l Automatic file upload (AFU) overview
l Choose files to include in AFU
l Enable and set timing for AFU
And the following specific configurations based on the location of upload:
l AFU to an FTP server
l AFU using RSync
l AFU using CIFS
l AFU to a secure FTP server
l AFU using SCP
l AFU or copy to USB drive
l Automatic
l As a one-time copy
l Manually
Lastly, this section describes how to view file upload logs and manage the AFU queue:
l View the AFU log
l Manage the AFU queue
Automatic file upload (AFU) overview
Pearl can automatically upload files to an accessible off-system storage location.
The following types of off-system storage are supported for AFU: FTP, CIFS, RSync, SFTP, SCP and
USB Drive.
Only one type of AFU can be used at once.
241
Pearl User Guide
Choose files to include in AFU
Files are uploaded once (i.e. are automatically not re-uploaded during future sessions) and a log is kept
showing the file transfers (see below for details on viewing the log). The first transfer occurs after the
configured amount of time expires, or after the current file completes recording. If connection is lost during
the transfer, the transfer is automatically restarted when the connection is reestablished.
By default, channels and recorders are not configured to support automatic file upload for their recorded
files. You must enable this feature for each channel or recorder you wish to include in your automatic file
transfers.
If recorded files are selected for upload while the AFU is at maximum upload capacity or when the AFU is
unavailable, they are added to an upload queue. Files and their relevant information are displayed in a list
format, and each file will be uploaded when upload capacity becomes available.
Choose files to include in AFU
When configuring automatic file upload (AFU) you need to tell the system which channels and recorders you
want included in the upload schedule.
When you log into the system and attempt to configure your desired type of AFU you see the following
warning in the Automatic File Upload configuration page if no channels or recorders are configured to be part
of AFU.
For each channel or recorder you want to add to your AFU schedule:
242
Pearl User Guide
Enable and set timing for AFU
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. For a channel recording:
a. Click the desired channel; the channel menu expands.
b. Select the Recording link for the channel; the Recording page opens.
4. For a recorder:
a. Click the desired recorder link from the Recorders section; the recorder configuration page
opens.
5. Select the change link under Recorder Setup; the recorder setup section expands. (The setup page
looks slightly different for Recorders, but the options are the same.)
6. Check the Automatic file upload check box.
7. Click Apply; the Recording page is refreshed and the new settings are reflected.
Now that AFU is enabled for your desired set of files, enable AFU and configure your desired mechanism.
Enable and set timing for AFU
After configuring the channels and recorders to include in your AFU schedule, you must enable AFU and
configure the frequency of transfers.
Files saved before you complete automatic file upload configuration are not part of the automatic
upload. Manual file transfer is required for these files. See Recorded files.
243
Pearl User Guide
Enable and set timing for AFU
To enable and configure frequency automatic uploads:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select Automatic File Upload from the Configuration section; the Automatic File Upload
configuration page opens.
If your screen does not indicate that AFU is enabled for at least one channel or recorder, return
to Enable and set timing for AFU
4. Select the Enable Automatic File Upload checkbox.
5. Specify how often automatic updates should happen.
The first transfer occurs after the specified amount of time expires, or after the current file completes
recording. I.e. if the value is set to every hour and five videos are saved the first hour, those five videos
are uploaded after the first hour, and one hour later the videos saved in the second hour are uploaded.
The following table describes the available options.
244
Pearl User Guide
Enable and set timing for AFU
Table 26 Automatic File Upload Interval Options
Name
Description
The system uploads each file after it stops recording it. You can control file size
On file rotation
and length to determine when files are done recording. You can also use the
reset button to close the current file and open a new one. See What is a recording?.
Every hour
The system uploads completed recordings every hour.
Every 6 hours
The system uploads completed recordings every six hours.
Every 12 hours
The system uploads completed recordings every 12 hours.
Every 24 hours
The system uploads completed recordings every 24 hours.
6. Indicate the remote path, if desired. If no path is specified, the files are copied to the root folder of the
destination file system.
If the remote path does not exist on the remote server or USB drive, the file transfer fails.
7. If desired, check Remove after upload to have the files deleted from local storage when upload
completes.
8. If desired, check Mark file as downloaded to have the color of the file link in the recording list change
to show the files are downloaded. This only applies if the files are not deleted after upload is complete.
9. Select the protocol or destination for upload. The following table describes the options.
Table 27 Automatic File Upload Interval Options
Name
Description
FTP Client
The system uploads to an FTP server.
RSync Client
The system uploads to a network location using RSync to copy the file.
CIFS Client
SFTP Client
SCP Client
The system uploads to a network location using CIFS (also known as SMB or
samba) such as a shared folder on a Windows machine.
The system uploads to a secure FTP server. Authentication is done either by
password or uploaded SSH key.
The system performs secure copy (SCP) to a remote server. Authentication is
done either by password or uploaded SSH key.
245
Pearl User Guide
Name
External
USB Drive
AFU to an FTP server
Description
The system uploads to a USB drive connected directly to the system.
10. Follow one of the procedures below to configure your selected protocol or transfer type.
l AFU to an FTP server
l AFU using RSync
l AFU using CIFS
l AFU to a secure FTP server
l AFU using SCP
l AFU or copy to USB drive
AFU to an FTP server
This procedure assumes you have completed the steps in Enable and set timing for AFU and wish to continue
with configuration of upload to an FTP Server.
To configure upload to an FTP server:
1. Select FTP Client from the protocol drop down list in the Automatic File Upload configuration page;
the lower half of the page reflects the selection.
2. Specify the target Server address. If your system is configured with DHCP or has a valid DNS
configuration (see Configure DHCP), you can use the server’s fully qualified domain name instead of
the IP address.
3. Specify the Server Port used for the target FTP server. The standard port is 21.
246
Pearl User Guide
AFU using RSync
4. Enter the FTP account username in the Login field.
5. Enter the FTP account password in the Password field; the characters are masked with dots.
6. Select Use temp file to name files with a temporary filename extension (.part) on the server until
upload is complete.
7. Click Apply; if there are any problems the system notifies you with a message: One or more parameter
values are not valid and those were not applied!
The following table describes the options applicable to configuring upload to an FTP server.
Table 28 FTP Automatic Upload Configuration Options
Name
Server
address
Description / Options
The IP address (or fully qualified domain name) of the FTP server.
Server port
The port used by the target FTP server. Standard port is 21.
Login
Username for the FTP server.
Password
Password for the FTP user.
Causes files to be named with .part extension on the server during active upload. When
Use temp file
the upload completes, the file is renamed to the appropriate extension (.mov, .mp4 or
.avi).
AFU using RSync
This procedure assumes you have completed the steps in Enable and set timing for AFU and wish to continue
with configuration of upload using RSync.
To configure upload using RSync:
1. Select RSync Client from the protocol drop down list in the Automatic File Upload configuration page;
the lower half of the page reflects the selection.
247
Pearl User Guide
AFU using RSync
2. Specify the target Server address. If your system is configured with DHCP or has a valid DNS
configuration (see Configure DHCP), you can use the server’s fully qualified domain name instead of
the IP address.
3. Specify the Server module. This is the name of the shared folder on the server. If needed, request this
value from your network administrator.
4. Specify a username for the RSync Server in the Login field. The user must have write permissions for
the module.
5. Specify the password for the user in the Password field; the value is masked by dots.
6. If desired, select the Checksum check box to add a checksum validation to the transfer between the
system and the recipient server.
7. Click Apply; if there are any problems the system notifies you with a message: One or more parameter
values are not valid and those were not applied!
The following table describes the options applicable to configuring upload to an RSync server.
Table 29 RSync Automatic File Upload Configuration Options
Name
Server
address
Description / Options
The IP address (or fully qualified domain name) of the RSync server.
Server module The name of the shared folder on the RSync server.
Login
Username for the RSync server.
Password
Password for the RSync user.
Checksum
Select to enable checksum checking during file transfer. This increases the time taken to
transfer, but also increases reliability of the transfer.
248
Pearl User Guide
AFU using CIFS
AFU using CIFS
This procedure assumes you have completed the steps in Enable and set timing for AFU and wish to continue
with configuration of upload using CIFS (also known as SMB or samba).
To configure upload using CIFS:
1. Select CIFS Client from the protocol drop down list in the Automatic File Upload configuration page;
the lower half of the page reflects the selection.
2. Specify the target Server address. If your system is configured with DHCP or has a valid DNS
configuration (see Configure DHCP), you can use the server’s fully qualified domain name instead of
the IP address.
3. Enter the target Server port, if you have configured the server to use something non-standard. Leave
this value blank to use the default port.
4. Specify the Server share. This is the CIFS share name or the name of the shared folder on the server.
If needed, request this value from the network administrator.
5. If the system is in a different domain than the server or if it is part of Active Directory, enter the
Domain name of the CIFS server.
6. Specify a username for the CIFS Server in the Login field. The user must have write permissions for the
share folder.
7. Specify the password for the user in the Password field; the value is masked by dots.
8. Select Use temp file to name files with a temporary filename extension (.part) on the server until
upload is complete.
249
Pearl User Guide
AFU to a secure FTP server
9. Click Apply; if there are any problems the system notifies you with a message: One or more parameter
values are not valid and those were not applied!
The following table describes the options applicable to configuring upload to a CIFS server.
Table 30 CIFS Automatic File Upload Configuration Options
Name
Server Port
Server
address
Server share
Domain
Description / Options
The CIFS server port. Leave blank to use the default port, or enter the port used for your
CIFS server.
The IP address (or fully qualified domain name) of the CIFS server.
The name of the shared folder on the CIFS server.
The CIFS server's Windows domain or Work Group name . Needed if the server is part of
Active Directory or a Domain Controller.
Login
Username for the CIFS server.
Password
Password for the CIFS user.
Causes files to be named with .part extension on the server during active upload. When
Use temp file
the upload completes, the file is renamed to the appropriate extension (.mov, .mp4, .ts or
.avi).
AFU to a secure FTP server
This procedure assumes you have completed the steps in Enable and set timing for AFU and wish to continue
with configuration of upload to a secure FTP Server (SFTP).
To configure upload to a secure FTP (SFTP) server:
1. Select SFTP Client from the protocol drop down list in the Automatic File Upload configuration page;
the lower half of the page reflects the selection.
250
Pearl User Guide
AFU to a secure FTP server
2. Specify the target Server address. If your system is configured with DHCP or has a valid DNS
configuration (see Configure DHCP), you can use the server’s fully qualified domain name instead of
the IP address.
3. Specify the Server Port used for the target SFTP server. The standard port is 22.
4. Enter the SFTP account username in the Login field.
5. Enter the SFTP account password in the Password field; the characters are masked with dots.
(Alternatively you can choose to use a private key instead of a password for authentication.)
6. Select Use temp file to name files with a temporary filename extension (.part) on the server until
upload is complete.
For secure file transfer you can upload an SSH identity for your Pearl. This key must be
trusted by the destination server. Details for generating the key and setting up this trust
are beyond the scope of this document.
7. If desired, scroll down to the section labelled SSH identity for SCP and SFTP clients.
1. If no identity is uploaded, or to upload a new identity (overwrites the old identity):
a. Click Choose File; a file selection dialog opens.
b. Select the private key file from your hard drive and click Open.
The system accepts RSA keys for SSH-1; DSA, ECDSA, EC25519 and RSA for SSH-2.
Keys must be in OpenSSH format.
251
Pearl User Guide
AFU using SCP
c. Click Upload to upload the file.
2. Use the Test your key field to test your uploaded key against the secure server, if desired.
8. Click Apply; if there are any problems the system notifies you with a message: One or more parameter
values are not valid and those were not applied!
The following table describes the options applicable to configuring upload to a SFTP server.
Table 31 SFTP Automatic Upload Configuration Options
Name
Server
address
Description / Options
The IP address (or fully qualified domain name) of the SFTP server.
Server port
The port used by the target SFTP server. Standard port is 22.
Login
Username for the SFTP server.
Password
Password for the SFTP user.
Causes files to be named with .part extension on the server during active upload. When
Use temp file
the upload completes, the file is renamed to the appropriate extension (.mov, .mp4 or
.avi).
AFU using SCP
This procedure assumes you have completed the steps in Enable and set timing for AFU and wish to continue
with configuration of upload via secure copy (SCP).
To configure upload via SCP:
1. Select SCP Client from the protocol drop down list in the Automatic File Upload configuration page;
the lower half of the page reflects the selection.
252
Pearl User Guide
AFU using SCP
2. Specify the target Server address. If your system is configured with DHCP or has a valid DNS
configuration (see Configure DHCP), you can use the server’s fully qualified domain name instead of
the IP address.
3. Specify the Server Port used for the destination SCP server. The standard port is 22.
4. Enter the SCP account username in the Login field.
5. Enter the SCP account password in the Password field; the characters are masked with dots.
(Alternatively you can choose to use a private key instead of a password for authentication.)
For secure copy you can upload an SSH identity for your Pearl. This key must be trusted by
the destination server. Details for generating the key and setting up this trust are beyond
the scope of this document.
6. If desired, scroll down to the section labelled SSH identity for SCP and SFTP clients.
1. If no identity is uploaded, or to upload a new identity (overwrites the old identity):
a. Click Choose File; a file selection dialog opens.
b. Select the private key file from your hard drive and click Open.
The system accepts RSA keys for SSH-1; DSA, ECDSA, EC25519 and RSA for SSH-2.
Keys must be in OpenSSH format.
c. Click Upload to upload the file.
2. Use the Test your key field to test your uploaded key against the secure server, if desired.
253
Pearl User Guide
AFU or copy to USB drive
7. Click Apply; if there are any problems the system notifies you with a message: One or more parameter
values are not valid and those were not applied!
The following table describes the options applicable to configuring upload using SCP.
Table 32 SCP Automatic Upload Configuration Options
Name
Description / Options
Server address The IP address (or fully qualified domain name) of the destination server.
Server port
The SCP port used by the target server. Standard port is 22.
Login
Username for the SFTP server.
Password
Password for the SFTP user.
AFU or copy to USB drive
The system is equipped with USB ports that can be used to copy files from internal storage to external USB
flash drives or hard drives. An example use of this feature is to provide speakers with a copy of their
presentation before they leave the presentation venue.
The external drive must be formatted with one of the following file systems:
l FAT16
l FAT32
l XFS
l EXT2
l EXT3
l EXT4
l NTFS
Only the first attached USB drive is used for automatic file upload. If more than one USB drive is
attached before system power up, behavior is unpredictable.
File transfer to a USB drive occurs in one of the following ways. This section describes the procedures.
l AFU to a USB drive
l One-time copy/move of all recorded files to USB drive
l Manually copy recorded files to USB drive
l View available USB storage space
l Safely eject the USB drive
254
Pearl User Guide
AFU or copy to USB drive
Only one copy or move to USB operation is permitted at a time, even though the UI may appear
to let you start a second one. Please wait until the first is complete before starting a new
operation.
AFU to a USB drive
This procedure assumes you have completed the steps in Enable and set timing for AFU and wish to continue
with configuration of upload to a USB drive.
To configure automatic upload to a USB drive:
1. Insert the properly formatted USB drive into one of the system’s USB ports.
2. Select External USB Drive from the protocol drop down list in the Automatic File Upload
configuration page; the lower half of the page reflects the selection.
3. If your Automatic File Upload setting conflicts with your new USB drive setting, a message is displayed.
4. Click the fix link.
255
Pearl User Guide
AFU or copy to USB drive
Using the fix link disables any other type of automatic file upload you have configured.
When you are done with USB uploads, return to the Automatic File Upload configuration
page and re-configure FTP, RSYNC, or CIFS.
5. Select Create a subfolder for each channel to have recordings organized by channel.
6. Click Apply; the changes are saved.
One-time copy/move of all recorded files to USB drive
When configured to make a one-time copy of files, the system will automatically begin to copy files to an
inserted USB drive, starting with the newest recording. Files will continue to copy until all are copied, the
specified maximum number of files is copied, or the target drive runs out of storage space.
The file currently being recorded (if any) cannot be transferred until recording is completed.
This procedure is separate from automatic file upload and does not need any pre-configuration in the
automatic file upload page.
Ideally only USB drives with visible activity indicators should be used.
To configure a one-time copy of all recorded files to a USB drive:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the External USB Drive link in the Configuration section; the External USB Drive configuration
page is displayed.
4. Select used for one-time move/copy of the recorded files (upon insertion) from the drop down
list.
256
Pearl User Guide
AFU or copy to USB drive
5. Select the appropriate check boxes based on the descriptions provided in the following table. If your
USB drive does not have activity indicators it is suggested you select either remove after copying or
mark file as downloaded so you know when the transfer is complete.
Table 33 One-Time Transfer/Copy to External USB Drive Options
Name
Description
If checked, the transfer process creates a sub-folder with the system’s
create subfolder with
serial number on the USB drive. This is useful if you are using the same
serial number (<serial>)
drive to collect recordings from multiple systems and want to know which
system they came from.
create subfolder for
each channel
remove after copying
If checked, the transfer process creates a sub-folder for each channel and
recorder (within the subfolder for the serial number, if that option is also
selected). Files are copied to their respective folders.
If checked, the file(s) are removed after being copied to the USB drive.
Checking this box makes the transfer a move instead of a copy.
If checked, the files that are downloaded are marked with a downloaded
mark file as downloaded
icon when viewing file lists. This has no effect if remove after copying is
checked.
ignore already down-
If checked, files that were previously downloaded or marked as down-
loaded files
loaded are not included in subsequent downloads.
6. Click Apply; the changes are saved.
If a conflict is reported regarding the Automatic file upload, go to the Automatic File Upload
configuration page and disable automatic file upload or switch it to a non-USB based
upload type. Repeat the steps above.
7. Insert the properly formatted USB drive into one of the system’s USB ports; the drive is recognized and
the transfer begins. If the drive has an activity indicator light, it flashes during the transfer.
8. When the activity light stops flashing, remove the USB drive.
9. If your USB drive does not have activity indicators:
a. Check the Recording list for each channel and the Recorded Files list for each recorder to
verify if there are files that have yet to be copied.
b. Safely eject the USB drive when you are satisfied all files have been copied, or if you see the USB
drive is out of storage space (View available USB storage space).
257
Pearl User Guide
AFU or copy to USB drive
Manually copy recorded files to USB drive
You can manually copy recorder files to a USB drive connected to Pearl.
This procedure is separate from automatic file upload and does not need any pre-configuration in the
automatic file upload page.
To manually copy recorded files to a USB drive:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the External USB Drive link in the Configuration section; the External USB Drive configuration
page is displayed.
4. Select used to manually move/copy selected files via web interface from the drop down list.
5. Click Apply; the changes are saved.
If a conflict is reported regarding the Automatic file upload, go to the Automatic File Upload
configuration page and disable automatic file upload or switch it to a non-USB based
upload type. Repeat the steps above.
6. Insert your USB drive in an available USB port on the system. (It is recommended you only use one
USB drive at a time.)
7. To download files for a specific channel:
a. Select the desired channel from the Channels list
b. Click the Files Archive link for the selected Channel
8. To download files for a recorder:
a. Select the desired recorder from the Recorders list
9. Select the check box next to the files you wish to download. In the example below the topmost file is
still recording and cannot be downloaded.
258
Pearl User Guide
AFU or copy to USB drive
10. To copy the files to the USB drive:
a. Click Copy Selected to external drive
11. To move the files to the USB drive (i.e. erase the files after the copy)
a. Click Move Selected to external drive
12. Repeat the steps to select a channel or recorder and copy or move files to the external drive until you
have copied all the files you wish.
13. Follow the steps to Safely eject the USB drive.
View available USB storage space
When you insert a USB drive in an available port of Pearl and select an External USB Drive action other than
ignored (i.e. manual copy, automatic copy, etc), the total and free space are calculated and displayed in the
Web Interface.
To see the available USB storage space:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Insert your USB drive in an available USB port on the system. (It is recommended you only use one
USB drive at a time.)
4. Scroll to the bottom of the Web Interface page; external USB storage is displayed under internal
storage space.
259
Pearl User Guide
AFU or copy to USB drive
Safely eject the USB drive
When you have completed work with the USB drive you can safely eject it by using the link at the bottom of
the Web Interface page.
To safely eject the USB drive:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Scroll to the bottom of the Web Interface page; click the eject link below external storage space.
4. When prompted, click OK to confirm that you want to eject the USB drive.
5. Disconnect the USB drive from the system.
260
Pearl User Guide
View the AFU log
View the AFU log
A log is kept of automatic file uploads.
To view the log:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select Automatic File Upload from the Configuration section; the Automatic File Upload
configuration page opens.
4. Click the Show log of automatic file upload link; the log page opens. Note the page will be blank if
there are no logs present.
5. Click the browser's back button when you are done.
Manage the AFU queue
The AFU queue displays a list of recording files waiting to be uploaded. Individual file details can be viewed
using the web interface.
Access the AFU queue
Accessing the AFU queue allows you to view the list of files queued for upload using the web interface.
To access the AFU queue:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
261
Pearl User Guide
Manage the AFU queue
2. Login as admin.
3. From the web interface, click Automatic File Upload; if there are files to be uploaded, they will be
displayed under the Upload Queue header.
View content in the AFU queue
There are several buttons in the web interface that allow you the ability to control how you see your queued
content.
To control how you view content in the AFU queue:
1. Navigate to the bottom of the upload queue list and manipulate the list view using the Newer 5 and
Top of the List buttons.
The upload queue can display only 15 files at one time. Additional content is still stored and
is viewed in increments of five files using the Newer 5 button.
Delete content in the AFU queue
Files can be deleted from the upload queue, either individually or as a group.
To remove content from the upload queue:
262
Pearl User Guide
Manage the AFU queue
1. Navigate to the bottom of the upload queue and click Empty Queue to delete the entire upload
queue, or click the red 'X' icon at the end of each row to remove files individually.
263
Pearl User Guide
Local FTP server
Local FTP server
Pearl can act as an FTP server, allowing you to manually or automatically connect to the system and download
recordings. Depending on configuration of the FTP server, you may also be able to remotely delete files after
download, maximizing available system storage.
This section discusses the following FTP Server topics.
l Configure the local FTP server
l Using the local FTP Server
Configure the local FTP server
To configure your sysetem's local FTP server:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the FTP Server link in the Configuration menu; the FTP Server configuration page opens.
4. To enable the FTP server:
a. Select the Enable FTP access check box.
b. Select a user from the FTP user name drop down.
264
Pearl User Guide
Configure the local FTP server
The ftp password is the regular access password for the selected user. See User
administration for details on user names and passwords.
c. Click Apply.
5. To allow the FTP user to delete files:
a. Select the Enable FTP DELETE command check box.
b. Click Apply.
Any currently logged in ftp users must log out and back in again to have access to
the command.
6. To disable the FTP server:
a. De-select the Enable FTP access check box.
b. Click Apply.
7. To disable file deletion by FTP:
a. De-select the Enable FTP DELETE command check box.
b. Click Apply.
Any currently logged in users will continue to have access to the delete command
until they log out and log in again.
The following table summarizes the options for configuring the local FTP server.
Table 34 FTP Server Configuration Options
Name
Enable FTP access
FTP user name
Enable FTP
DELETE command
Description / Options
The check box controls whether or not the system acts as an FTP server. By default this
is disabled.
Select one of the system users: admin, operator, or viewer. The ftp password will be the
access password for the selected user. By default the admin user is selected.
Controls whether or not FTP users can delete files. By default file deletion is not permitted.
265
Pearl User Guide
Using the local FTP Server
Using the local FTP Server
Once you have configured a local FTP server, you can use the tool of your choice to download files from the
system.
The system stores files in a folder structure with a folder for each channel and a folder for each recorder.
Channel folders are labeled video<channel number> (i.e. video3 for channel 3). Recorder folders are labeled
videom<recorder number> (i.e. videom1 for the first recorder). Channel and recorder numbers are displayed
next to the name of the channel or sources in the web admin interface. See Channels and Recorders.
To get started you will need:
l The IP address of your system (found in the Network configuration menu)
l An FTP tool
l The username and password for your FTP user (See Using the local FTP Server)
In the example below, the IP address of Pearl is 192.168.1.210, the username is admin, there is no password,
and the Windows command line ftp utility is used.
To connect to the FTP server:
1. Open a command window on Windows (alternatively open a terminal window on Linux/Mac, or open
your FTP utility of choice).
2. Establish an ftp connection using the command: ftp 192.168.1.210
3. Provide the username: admin (provide the username of your FTP user)
4. Provide the password: (provide the correct password for your FTP user); the connection is opened.
5. Use the dir command to see the file structure.
266
Pearl User Guide
Using the local FTP Server
6. Use dir or your tool’s GUI to look in each folder for recordings.
7. Use get or your tool’s transfer mechanism to transfer files to your computer.
8. If enabled in the FTP configuration page, delete the file after downloading it by issuing the delete
command, or using your tool’s delete mechanism.
If the delete command is not enabled, attempting to delete a file will result in an Unknown
Command error.
267
PART 5: Maintenance
This section covers topics that will keep your Pearl running smoothly. It also covers the mobile/tablet operator
interface and ways to configure and operate your system using third party tools via HTTP or RS-232.
Specific topics covered are:
l Mobile / tablet operator interface
l Power down and system restart
l Save and restore device configuration
l Perform factory reset
l Firmware upgrade
l Support
l Storage disk maintenance
l Third party integration
268
Pearl User Guide
Mobile / tablet operator interface
Mobile / tablet operator interface
Epiphan's tablet interface is designed for touch-screen devices. Use your tablet or mobile device to perform
confidence checks and basic operator tasks such as verifying disk space or starting and stopping recording.
This section describes procedures for the following topics:
l Connect to the tablet interface
l Confidence monitoring using the tablet interface
l Verify disk space via the tablet interface
l Control recording via the tablet interface
l Switch to the full admin interface
Connect to the tablet interface
To get started with the tablet interface you can connect to it in one of the following ways.
The device connecting to the tablet interface must be on the same network as the Pearl or must
be physically connected to it via USB.
l Use the browser over Ethernet
l Use tethering on your device
l Use the mobile version of Epiphan Connect
Use the browser over Ethernet
You can connect to the tablet interface with a browser on your admin computer, tablet, or touch-screen
device.
To connect to the tablet interface:
1. Connect to the admin interface using your preferred connection mechanism. SeeConnect to the admin
interface.
2. Login as admin or operator.
3. Modify the URL in the browser to have /m after the existing text and press Enter; the tablet interface
opens. (If you forget the /m, the system will direct you to the mobile or standard interface, depending
on information sent by your device's browser).
269
Pearl User Guide
Connect to the tablet interface
http://<ip address of system>/admin/m
or
http://<serial number of device>.local/admin/m
For example: http://192.168. 1.163/admin/m or http://95dd40d5.local/admin/m
In the future you can go directly to the IP address above and login from the mobile interface without ever
seeing the usual admin interface.
Use tethering on your device
You can use tethering on your mobile device or tablet to connect to the tablet interface. This option requires
some configuration through the full admin interface.
To configure use of tethering (perform this once):
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Network link in the Configuration menu; the network configuration page opens.
4. Select No tethering or any option except Disabled from the Use phone/tablet connection. See
Tether to a mobile network for descriptions of the options.
5. Click Apply.
To use your mobile device or tablet via tethering:
1. Turn on tethering on your device. (See device user manual for instructions.)
2. Connect the device to your Pearl via USB.
3. Use the EpiphanConnect utility (from the Google Play or Apple App store) to find the system and open
the tablet admin interface.
Use the mobile version of Epiphan Connect
Epiphan has iOS and Android versions of the Epiphan Connect discovery utility. The mobile versions of the
discovery utility automatically open the tablet interface when connecting to the Pearl for administration.
See instructions below for installing the application. The iOS version is available from the Apple App Store and
the Android version is available from the Google Play store.
To install the application on your iOS or Andriod device (perform this once):
270
Pearl User Guide
Confidence monitoring using the tablet interface
1. Open the App Store (for Apple devices) or Google Play store (for Android devices).
2. Search for EpiphanConnect (all one word).
3. Download and install the free Epiphan Connect application.
To connect to the device:
1. Once Epiphan Connect is installed, connect to the wifi network where you can access your Pearl.
2. Launch Epiphan Connect; the application searches your network and shows you a list of available
Epiphan systems.
3. Find your system in the list. If you have several Epiphan systems, look for the serial number of the one
to which you'd like to connect.
4. Select the system by touching the system name; a login prompt is presented.
5. Login as admin or operator; the tablet interface appears.
Confidence monitoring using the tablet interface
When connected to the tablet interface, you can use the INPUTS section to monitor the inputs to your
system. An auto-updating snapshot of video inputs and an audio level meter is provided for each source.
The top of the tablet interface gives you a warning if there are video inputs with no signal. In the example
below, 4 video inputs have no signal.
For more detailed information, you can look at each input individually.
To monitor each input:
1. Connect to the tablet interface. See Connect to the tablet interface.
2. Login as admin or operator.
3. Scroll to the INPUTS section.
271
Pearl User Guide
Confidence monitoring using the tablet interface
4. For audio inputs without signal, nothing appears in the audio input bars.
5. For audio inputs with signal, the level is shown next to the source name in the audio input bar.
6. If a video source has no signal, the name appears red and a note next to the name says NO SIGNAL.
272
Pearl User Guide
Verify disk space via the tablet interface
7. If the source has a signal, it's frame size and frame rate are displayed beside the source name.
8. View a preview of the source by clicking the down arrow in the row for source. (The names of the
sources match the names set in the main admin interface. )
Verify disk space via the tablet interface
The INFO section of the tablet interface lets you know the firmware version, serial number and IP Address of
your system. It also shows you the currently available disk space.
To monitor inputs:
1. Connect to the tablet interface. See Connect to the tablet interface.
2. Login as admin or operator.
3. Scroll to the INFO section; the currently available disk space is shown.
4. If disk space is low, the green bar will be nearly full.
Control recording via the tablet interface
The tablet interface provides a simple way to control recording for your Pearl. You can control recordings for
both channels and recorders from the same interface.
273
Pearl User Guide
Switch to the full admin interface
To control recording from the tablet interface:
1. Connect to the tablet interface. See Connect to the tablet interface.
2. Login as admin or operator.
3. Scroll to the CHANNELS section.
4. Find the channel or recorder from the list under CHANNELS. (The names of the channels and recorders
match the names set in the full admin interface.)
5. Click the down arrow in the row for the desired channel or recorder
6. Use the START, STOP, and RESET buttons to control recording.
Switch to the full admin interface
To switch from the tablet interface to the full admin interface:
1. Connect to the tablet interface. See Connect to the tablet interface.
2. Login as admin or operator.
3. Click the arrow button at the top right of the screen. Depending on the width of the screen, the button
may say extended view.
274
Pearl User Guide
Power down and system restart
Power down and system restart
This section covers the following topics:
l Restarting the device via the web interface
l Shutting down the Device via the Web Interface
l Shutting down the device manually
Restarting the device via the web interface
Pearl's web interface allows you to reboot the system.
To restart the system:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Maintenance link in the Configuration menu; the maintenance page opens.
4. Click the Reboot Now button; a confirmation dialog appears.
5. Click OK.
275
Pearl User Guide
Shutting down the Device via the Web Interface
Shutting down the Device via the Web Interface
The Pearl web interface allows you to shut down the system.
To shut down the system:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Maintenance link in the Configuration menu; the maintenance page opens.
4. Click the Shutdown Now button; a confirmation dialog appears.
5. Click OK.
Shutting down the device manually
You can manually shut down the Pearl via the button physically located on the system.
To shut down the system manually:
1. Press and release the power button on the system to initiate a safe power down; the system shuts
down.
If the system is unresponsive, press and hold the power button for 4 seconds to force an
immediate power down.
276
Pearl User Guide
Save and restore device configuration
Save and restore device configuration
After completing configuration of your Pearl, it is good practice to save the system configuration so you may
restore it at a later date (i.e. after a change that wasn’t wanted, or after a factory reset). In addition to full
configuration backups, you can also save and restore configuration preset groups - see Configuration presets
for details about that feature.
This section covers the following topics:
l Save device configuration
l Load a saved device configuration
Save device configuration
Pearl's web interface allows you to save the current system configuration to your admin computer's hard
drive. It’s good practice to do this before making any major changes to a working configuration and before
doing a firmware update.
The resulting backup file includes all non-default configuration settings for the system, except the
user passwords which are reset when a configuration is restored.
Configuration backup files are only guaranteed to work with the same firmware version with
which they were created. Normally there is no issue loading an older configuration file on a newer
release, but the reverse is not true and there are exceptions where older configuration files are
not supported in a new release.
To save the current system configuration:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Maintenance link in the Configuration menu; the maintenance page opens.
4. Click the Backup button next to Backup Current Configuration; the system performs a backup and
depending on your browser the file is either automatically downloaded or you are asked to save the
file.
277
Pearl User Guide
Load a saved device configuration
5. Save the file in a secure location.
6. Rename your saved configuration file to indicate the specifics of the configuration, if desired.
Load a saved device configuration
After making changes to the system configuration, you may find that the results are not what you expected or
that they serve a different need and you wish to return to a previous configuration. Via Pearl's web interface
you can load a previously saved configuration file.
Configuration files are by default named <serial number>.cfg. You may have more than one configuration file
saved from the system. Select the correct configuration file and know where it is accessible from your local
computer before starting this procedure.
Backup files include all non-default configuration settings for the system, except the user
passwords. All passwords are reset to blank after the configuration is loaded.
To load a saved system configuration:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Maintenance link in the Configuration menu; the maintenance page opens.
4. Click the Choose File button beside Restore Configuration from File; you are prompted to choose the
configuration file.
5. Select the desired configuration file from storage on your local computer and click Open.
278
Pearl User Guide
Load a saved device configuration
6. Click the Restore button; the system configuration is restored and a new page appears asking you to
reboot the system.
7. Reboot the system by clicking the link in the message on the web page, or by using the power button
on the system; when the system comes back up the restoration is complete.
8. Login as admin (with no password).
9. Reset your user passwords. See User administration.
279
Pearl User Guide
Perform factory reset
Perform factory reset
If you’ve been testing with your Pearl and are ready to reset it back to factory settings, you can do this
through the web interface.
This section covers the following topics:
l Restore factory configuration via the web interface
Restore factory configuration via the web interface
The web interface allows you to restore the factory configuration to return your Pearl back to the original
settings it had when you purchased it.
Restoring the factory settings erases everything on the system. This includes all your source
settings, channels, configuration presets, network settings, and all saved files.
Consider using the factory default configuration preset if you want to preserve files. See
Configuration presets.
EDIDs are not restored to factory settings with the factory resets. Re-apply factory EDIDs
manually using the Source's configuration page.
Only proceed if you know this is what you want to do.
To restore the factory configuration via the web interface:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Maintenance link in the Configuration menu; the maintenance page opens.
4. Click the Reset button next to Factory Reset; a warning dialog appears asking you to confirm this
destructive action.
280
Pearl User Guide
Restore factory configuration via the web interface
5. Click OK on the warning dialog; the system resets to factory defaults and reboots.
6. Wait for the system to reboot and begin re-configuration.
281
Pearl User Guide
Firmware upgrade
Firmware upgrade
Epiphan will from time to time issue an updated firmware revision to bring new features to your Pearl. To take
advantage of these new features, you will need to install the new firmware on the system.
This section covers:
l Check for Firmware Updates
l Install firmware
Check for Firmware Updates
When you register your product with Epiphan you are given a choice to be notified by email of firmware
updates for your system. If you selected this choice, you will be notified of updates applicable to Pearl.
If your Pearl has internet access, you can check for updates directly by following the procedure below.
The system will also automatically check for firmware updates if the Maintenance page option Enable
connection to maintenance server is checked.
This is the preferred method of checking for firmware updates. The built-in firmware update
mechanism checks for updates that match your specific product and hardware revision.
To check for new firmware:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Firmware Upgrade link in the Configuration menu; the firmware upgrade page opens.
4. Click the check for updates link next to your current firmware version; the system connects to Epiphan
servers to look for updates.
5. If an update is found a red box appears in the top left side of the web interface with a link to download
and install the firmware.
282
Pearl User Guide
Install firmware
6. Follow the steps below to download and install the firmware.
Install firmware
When you’ve received a new firmware file from Epiphan’s support team, schedule a time where you can
update the firmware without negatively impacting viewers or file recordings.
It is good practice to take a backup of your current configuration before applying a firmware
update. In the rare case that you wish to downgrade the firmware, you will be able to apply this
configuration backup and restore your previous state. See Save and restore device
configuration.
There are two ways to install new firmware: from a the download link via the web interface, or from a file
provided by Epiphan.
Installing new firmware takes a few minutes. Broadcasting and recording is not available until the
upgrade is complete.
While the firmware update is applied, the touch screen displays a firmware update in-progress notice and no
other interaction is possible.
Install firmware directly from the web interface:
If your Pearl has internet access, the easiest method of installing new firmware is to use the download link
provided when you check for new firmware.
To download new firmware directly:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Save a copy of the current system configuration, if desired. See Save and restore device configuration.
4. Select the Firmware Upgrade link in the Configuration menu; the firmware upgrade page opens.
5. Click the check for updates link next to your current firmware version; the system connects to Epiphan
servers to look for updates.
6. Click download from the red box that appears at the top left of the admin interface; the firmware is
downloaded and immediately starts to install and the firmware update box changes to have a cancel
button.
283
Pearl User Guide
Install firmware
7. The touch screen, if enabled, also displays a notice that the firmware update is in progress.
Do not interrupt power to the system during the firmware upgrade.
8. When the firmware update is complete, the message lets you know it is going to reboot.
9. Wait for the system to restart. Depending on the upgrade, a disk rebuild may be required, causing the
restart process to take much longer than usual.
10. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
11. Login as admin.
12. Select the Firmware Upgrade link in the Configuration menu; the firmware upgrade page opens.
13. Verify that the firmware version is the expected new version.
Although unexpected, it is possible the firmware update fails. In this case, the touch screen reports the failure.
Please collect system information such as device serial number and, if known, the previous firmware version
along with the new firmware version and contact [email protected]
284
Pearl User Guide
Install firmware
Install firmware from a file
Before getting started, ensure you have the firmware file accessible from your admin computer.
To install new firmware from a file:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Save a copy of the current system configuration, if desired. See Save and restore device configuration.
4. Select the Firmware Upgrade link in the Configuration menu; the firmware upgrade page opens.
5. Note the current firmware version listed.
6. Click the Choose File button next to Select firmware upgrade file; a file selection box opens.
7. Select the firmware upgrade file from your local computer.
8. Click Apply; the file is uploaded. The system unpacks and verifies the file. If the file is valid, the upgrade
begins.
9. The touch screen, if enabled, also displays a notice that the firmware update is in progress.
Do not interrupt power to the system during the firmware upgrade.
285
Pearl User Guide
Install firmware
10. Wait for the system to restart.
11. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
12. Login as admin.
13. Select the Firmware Upgrade link in the Configuration menu; the firmware upgrade page opens.
14. Verify that the firmware version is the expected new version.
Although unexpected, it is possible the firmware update fails. In this case, the touch screen reports the failure.
Please collect system information such as device serial number and, if known, the previous firmware version
along with the new firmware version and contact [email protected]
286
Pearl User Guide
Support
Support
Epiphan provides a complimentary one-year support plan with your purchase (starting one year from the
original product shipment date) as well as two extended support plans, ServicePlan and ServicePlan+. Both
plans add two more years to extend the support to three years from original product shipment date.
To contact Epiphan support:
l Email: [email protected]
l Online chat: www.epiphan.com/support (Monday to Friday between 9am and 5pm
Eastern)
l Call: 1-877-599-6581 / 613-599-6581
From time to time, Epiphan support may ask you for logs from your system. Follow the instructions in this
section to download the log files for support.
l Download logs and "allinfo"
Pearl also supports remote troubleshooting by Epiphan’s support team. This service is only available to
systems covered by ServicePlan+.
Remote support allows Epiphan to assist in troubleshooting issues you experience with the system and can
also assist with resetting lost admin passwords. No private information is sent to the Epiphan maintenance
server.
By default, all systems are setup with remote support configuration enabled.
This section describes procedures for the following topics:
l Configure remote support
l Disable Remote Support
Remote support is only provided for systems covered by SupportPlan+. For more information
about our service plans, see www.epiphan.com/supportplan.
Download logs and "allinfo"
If requested by Epiphan support, you can download the logs files and/or "allinfo" data from your system.
These files help our support team troubleshoot problems.
To download the logs and allinfo file:
287
Pearl User Guide
Download logs and "allinfo"
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Maintenance link in the Configuration menu; the maintenance page opens.
4. Select the Permanent Logs check box.
5. Click Apply; the page updates to let you know the changes were applied.
6. Select the Maintenance link again; the maintenance page opens.
7. Click Download permanent logs; a zip file containting system logs begins to download.
8. From your browser, run the allinfo script; a file is saved to your computer
288
Pearl User Guide
Configure remote support
http://<ip address of your system>/admin/allinfo.cgi
9. Share the log files and allinfo results with Epiphan support.
Configure remote support
Remote support is configured by default to connect to the Epiphan maintenance server with the domain
name epiphany.epiphan.com. The system must be able to resolve this domain name to connect to the server
and permit remote support. Remote support uses port 30, therefore this port must be available for
communication. If your system is protected from the Internet by a firewall, speak to your network
administrator to configure the firewall appropriately.
Remote support is available from Epiphan only if your device is covered by ServicePlan or
ServicePlan+.
To configure remote support:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Maintenance link in the Configuration menu; the maintenance page opens.
289
Pearl User Guide
Disable Remote Support
4. Click Enable remote support if the check box is not selected. This setting controls incoming links
from Epiphan.
5. Click Enable connection to maintenance server if the check box is not selected. This setting
configures outgoing links to Epiphan.
6. Ensure the server address is epiphany.epiphan.com, unless Epiphan support directs you to change it.
7. Ensure the port is 30, unless Epiphan support directs you to change it.
8. Click Apply.
9. Test that the system can access the maintenance server:
a. Select the Network link under Configuration.
b. Type epiphany.epiphan.com Network Diagnostics box.
c. Click ping.
d. Ensure the result shows an IP address for epiphany.epiphan.com and report any packet loss to
Epiphan support.
10. If the system cannot reach the maintenance server, check the network settings (see Configure DHCP)
to ensure DHCP is selected or a DNS server is listed and try again. Consult with your network
administrator if problems persist.
11. If the system reaches the maintenance server, ensure your firewall, if you have one, has port 30 open
for the system.
12. Confirm with Epiphan support that they are able to access your Pearl for remote troubleshooting.
Disable Remote Support
By default, remote support is on. If you want to turn it off, you may use the following procedure.
Disabling remote support for Pearl removes the ability for Epiphan to reset a lost admin
password. If you forget the admin password and remote support feature is off, you will need to
return the system to Epiphan for reprogramming.
To disable remote support:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Maintenance link in the Configuration menu; the maintenance page opens.
4. Click Enable remote support check box to deselect it. This prevents incoming links from Epiphan.
290
Pearl User Guide
Disable Remote Support
5. Click Enable connection to maintenance server to deselect it. This prevents outgoing links to
Epiphan.
6. Click Apply.
291
Pearl User Guide
Storage disk maintenance
Storage disk maintenance
Your Pearl is equipped with a hard drive for storage of recordings. Occasionally, maintenance is required for
these disks. This section describes procedures for the following topics:
l Check disk storage space
l Check disk storage space via the touch screen
l Schedule disk check
l Perform disk check
Check disk storage space
Pearl has a finite amount of storage This storage space holds a lot of recordings, but it can get full. It’s a good
idea to monitor your current disk usage.
If available storage is low, consider removing some unneeded recordings or setting up an automatic file
transfer with deletion after transfer. See Recorded files and File and recording transfer.
Disk space can also be checked via the tablet interface. See Verify disk space via the tablet
interface.
To check disk storage space:
1. Connect to the admin interface using your preferred connection mechanism. SeeConnect to the admin
interface.
2. Login as admin or operator.
3. Check the Internal Storage section at the bottom of the menu column. The bar will be mostly green if
there is lots of space left, or mostly red if storage space is nearly full.
4. If available storage is low, take action to remove files as discussed in Recorded files and File and
recording transfer.
292
Pearl User Guide
Check disk storage space via the touch screen
Check disk storage space via the touch screen
Pearl's touch screen can show you the system's disk space on the system information screen.
To show system information on the touch screen:
1. If the system information button does not appear on the screen, tap the screen once to turn on the
control buttons.
2. If the system information button is still not visible, it is disabled in the system's Touch screen
configuration. See Configure the touch screen to enable system information.
3. Touch the system information button (i)on the screen
.
To close the system information screen:
1. Touch anywhere on the screen to return to the previous screen.
Schedule disk check
A disk maintenance schedule is used to check the system storage drives for errors. Two values are supplied,
one to specify the number of system restarts that should occur before disk check, and the second to specify
the number of months before performing a disk check. The disk check happens based on whichever event
occurs first.
For example, the restart setting is set to 50 and the months setting is set to 6. If six months pass and less than
50 restarts happened, a disk check will occur on the next restart. However if you do 50 restarts in one month,
the disk check will happen after the fiftieth restart.
Disk check occurs during start up and can cause a lengthy delay in starting up the system.
To set the disk check schedule:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
293
Pearl User Guide
Perform disk check
2. Login as admin.
3. Select the Disk Check link in the Configuration menu; the disk maintenance page opens.
4. Set the number of restarts to occur before the next check. Set to 0 if you don’t want to force a
disk check after a specific number of restarts.
5. Set the number of months to pass before the next check. Set to 0 if you don’t want to force a
disk check after a specific number of months.
6. Click Save.
Perform disk check
A disk maintenance schedule is used to periodically check the system storage drives for errors. If you prefer,
you can run the disk check manually at a time that is convenient for you.
Running the disk check manually resets the timers for the scheduled disk check (i.e. next check won’t happen
automatically until either the number of restarts or months passes).
If the system is recording when you start a disk check, it will stop recording and resume after the
check is complete. Frames presented during the disk check are not part of any recording.
To start a manual disk check:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Disk Check link in the Configuration menu; the disk maintenance page opens.
4. Click the Check Now button; a new page opens showing you the progress of the disk check.
Do not interrupt power to the system during the disk check.
5. When the disk check is complete, the main page returns and a summary is shown.
6. If any unrecoverable errors are detected, contact Epiphan support.
294
Pearl User Guide
Third party integration
Third party integration
Pearl has a comprehensive set of APIs to allow integration with third party tools.
You can use either the HTTP or RS-232 commands to configure your system exactly how you need it. For
example you can start and stop recordings, you can configure meta data on a channel, or even change a
channel's frame size and encoding settings.
The following topics are covered in this section:
l Control with RS-232 / serial port
l Control with HTTP commands
l Configuration keys for third party APIs
295
Pearl User Guide
Control with RS-232 / serial port
Control with RS-232 / serial port
Pearl presents an RS-232 / serial port control interface (via USB) for integration with existing control room and
board room equipment. This section covers the following topics:
l Connect and configure the RS-232 cable
l Control Pearl with RS-232
l RS-232 / Serial port command examples
Connect and configure the RS-232 cable
To connect your control equipment to Pearl you will need a standard RS-232 null-modem cable and a USB to
RS-232 serial adapter cable. Adapter cables are not included with Pearl. Only certain adapter chipsets are
supported, Epiphan recommends this adapter cable from Startech.
To connect the serial port cable:
1. Attach the null modem cable to the control interface.
2. Connect the USB to RS-232 serial adapter to the null-modem cable.
3. Connect the USB to RS-232 serial adapter to one of the system’s USB ports.
The only configuration available for the serial port is flow control. Flow control changes the rate of data
transfer over the cable. Some communication settings are static and cannot be changed. The static settings
are:
l Baud rate set at 19200
l Parity set to none
l Stop bits set to one
To configure serial port flow control:
1. Connect to the admin interface using your preferred connection mechanism. See Connect to the admin
interface.
2. Login as admin.
3. Select the Serial Port link in the Configuration menu; the serial port configuration page opens.
4. Select Hardware, Software, or None from the drop-down menu. Refer to the table below for a
description of the options.
296
Pearl User Guide
Control with RS-232 / serial port
Table 35 Serial Port Flow Control Options
Label
Description / Options
Hardware
Software
None
A hardware handshake mechanism is used for flow control. This is also called RTS / CTS flow
control. Select this when your control terminal requires it (see control terminal manual).
A software handshake that uses XON/XOFF characters to control the flow of data. Select this
when your control terminal requires it (see control terminal manual).
No flow control is used. Only select this if your control terminal requires it (see control terminal manual).
5. Click Apply.
Control Pearl with RS-232
You can use the null-modem cable and your control terminal software to issue commands to Pearl such as
when to start or stop recording, or to retrieve or set the value for various settings.
Each command sent to Pearl via RS 232 must be terminated with a line feed (LF) character
(ASCII code 10). Your software may need to be configured to add the line feed to each command.
Some commands require a channel or recorder name as an argument. In those commands, the channel or
recorder name is separated from the command name by a period, as shown in the table. The channel name
value can be either the name or the index of the recorder or channel. Use of the index is recommended.
A channel's index is found by looking at the Channels list in the web interface. In the screen capture below, the
channel with index 1 is currently recording (it's index number is red). To address this channel via RS-232
commands, use the index 1.
For commands requiring a recorder index, determine your recorder's index by combining the recorder's
number with the prefix m. In the example below, the second recorder's index is 2. To access this recorder via
RS232 commands, use the index m2.
297
Pearl User Guide
Control with RS-232 / serial port
The table describes the RS-232 commands supported by Pearl.
Table 36 Supported RS-232 Commands
Command Name
Description
Recording Commands
Starts recording for the provided channel or recorder. This can alternatively be
accomplished with the following set commands:
START.<channel>
SET.<channel>.rec_enabled=on
START.<recorder>
SAVECFG
If the channel is already recording, the current recording file is closed and a new
file is started.
Starts recording for all channels and recorders.
START
For channels already recording, the current recording file is closed and a new file is
started.
Stops recording for the provided channel or recorder. This can alternatively be
STOP.<channel>
accomplished with the following set commands:
START.<recorder>
SET.<channel>.rec_enabled=""
SAVECFG
STOP
Stops recording for all channels and recorders.
Takes a snapshot image of the current channel (supported only if the channel is
SNAPSHOT.<channel>
configured to use the Motion JPEG codec). Snapshots are saved with recording
files on the system.
Takes a snapshot image of all channels (supported only for channels configured to
SNAPSHOT
use the Motion JPEG codec). Snapshots are saved with recording files on the system.
Configuration Commands (see Configuration keys for third party APIs for available keys)
298
Pearl User Guide
Command Name
Control with RS-232 / serial port
Description
GET.<channel>.<key>
Gets the saved value of a given parameter for the specified channel or recorder.
GET.<recorder>.<key>
SET.<channel>.<key>
Sets the value of a given parameter for the specified channel or recorder. The
SET.<recorder>.<key>
value is not saved until the SAVECFG command is sent.
SAVECFG
Saves the parameters modified by the SET command.
Status Commands
Reports the recording status of the specified channel or recorder.
STATUS.<channel>
Status is one of:
l RUNNING
STATUS.<recorder>
l STOPPED
l UNINITIALIZED
Reports the recording status of each channel and recorder.
Status is one of:
STATUS
l RUNNING
l STOPPED
l UNINITIALIZED
FREESPACE
Reports the free storage space, in bytes.
RECTIME.<channel>
Reports the elapsed recording time for the current file on the specified channel or
RECTIME.<recorder>
recorder.
RECTIME
Reports the elapsed recording time for the current file on each channel.
Additionally, the system automatically reports its status changes back along the RS-232 connection using the
following automatic messages:
Table 37 RS-232 Status Changed Messages
Command Name
Description
Provides the status of the recording service for the channel's as one of:
STATUS.<channel> <status>
l Running
l Stopped
l Uninitialized
299
Pearl User Guide
Command Name
Control with RS-232 / serial port
Description
The Uninitialized status is sent when there is an internal error. Check the
system for more details.
RS-232 / Serial port command examples
The following examples demonstrate how to use some of the RS-232 commands supported by the system.
The list of supported SET and GET parameters are found in Configuration keys for third party APIs .
Each command sent to Pearl via RS 232 must be terminated with a line feed (LF) character
(ASCII code 10). Your software may need to be configured to add the line feed to each command.
For values with spaces, enclose the value in quotation marks. For empty values, use empty quotation marks
with nothing between.
1. To start recording on channel 2:
START.2
2. To stop recording on channel 2:
STOP.2
3. To start recording on all channels and recorders:
START
4. To get the value of the frame size (resolution) for channel 2:
GET.2.framesize
5. To set the frame size (resolution) on channel 2, enclose the parameter in quotes to preserve the spaces:
SET.2.framesize="640 x 480"
SAVECFG
6. To enable broadcasting audio on channel 2:
300
Pearl User Guide
Control with RS-232 / serial port
SET.2.audio=on
SAVECFG
7. To disable broadcasting audio on channel 2:
SET.2.audio=""
SAVECFG
301
Pearl User Guide
Control with HTTP commands
Control with HTTP commands
Pearl has an HTTP API interface for configuration and control by a third party application or with a script that
sends commands to the system as a series of URLs. This section covers the following topics:
l HTTP command syntax
l HTTP command examples
HTTP command syntax
Control of Pearl by HTTP is done by sending commands to one of two URLs and specifying the target
configuration item. Syntax for the get and set commands follows.
Many commands require a channel or recorder index as an argument. A channel's index is found by looking at
the Channels list in the web interface. In the screen capture below, the channel with index 1 is currently
recording (it's index number is red). To address this channel via http commands, use the index channel1.
For commands requiring a recorder index, determine your recorder's index by combining the recorder's
number with the prefix channelm. In the example below, the second recorder's index is 2. To access this
recorder via http commands, use the index channelm2.
To Get configuration settings:
302
Pearl User Guide
Control with HTTP commands
http://<address>/admin/channel<N>/get_params.cgi?key
(or for recorders, add 'm' before the recorder number, i.e. channelm1 for recorder 1)
http://<address>/admin/channelm<N>/get_params.cgi?key
To Set configuration settings:
http://<address>/admin/channel<N>/set_params.cgi?key=value
(or for recorders, add 'm' before the recorder number, i.e. channelm1 for recorder 1)
http://<address>/admin/channelm<N>/get_params.cgi?key
Where <address> is the IP address of the system, channel<N> is the channel number (i.e. channel2 for
channel number two), channelm2 for recorder two, key is the key for the configuration item being checked or
changed (see the list in Configuration keys for third party APIs ), and value is the value to set for the
configuration item.
Multiple Requests at Once
You can include multiple key/value pairs in a single command by separating the statements with &.
For example, the key for product name is product_name and the key for firmware version is firmware_
version. To send a request for both the product name and the firmware version, use the following command:
http://<address>/admin/channel1/get_params.cgi?product_name&firmware_version
Or, to turnoff publishing (set to 0) and set the bitrate (vbitrate) to 256,000:
http://<address>/admin/channel1/set_params.cgi?publish_type=0&vbitrate=256K
Third party applications like wget
If you’re using a third party application like wget to send commands to the system, always include the admin
username and password when viewing or setting configuration items.
The syntax for wget commands is shown below. Specify your system’s IP address, password and the key(s) or
value(s) you wish to query. Note your system may require use of single quotes around the password to
handle special characters such as exclamation marks.
get_param using wget:
303
Pearl User Guide
Control with HTTP commands
wget --http-user=admin --http-passwd=<password> http://<address>/admin/channel<N>/get_
params.cgi?<key>[&<key>]
set_param using wget:
wget --http-user=admin --http-passwd=<password> http://<address>/admin/channel<N>/set_
params.cgi?<key>=<value>[&<key>=<value>]
HTTP command examples
Some configuration of Pearl can be done by non-interactive http commands. The following examples
demonstrate how to use wget to exercise some of the HTTP commands supported by the system.
For values with spaces, encode space as %20. i.e.: set_params.cgi?framesize=640%20x%20480
The examples assume a system IP address of 192.30.23.45 and admin password pass123.
1. To get the type of stream being published and frame size for channel 1:
wget --http-user=admin --http-passwd=pass123 http://192.30.23.45/admin/channel1/get_
params.cgi?publish_type&framesize
2. To set the publish stream type to RTMP Push (6) and at the title “System Stream” for channel 2:
wget --http-user=admin --http-passwd=pass123 http://192.30.23.45/admin/channel2/set_
params.cgi?publish_type=6&title=System%20Stream
3. To start recording on channel 2:
wget --http-user=admin --http-passwd=pass123 http://192.30.23.45/admin/channel2/set_
params.cgi?rec_enabled=on
4. To stop recording on channel 2:
wget --http-user=admin --http-passwd=pass123 http://192.30.23.45/admin/channel2/set_
params.cgi?rec_enabled=""
5. To start recording on recorder 2:
304
Pearl User Guide
Control with HTTP commands
wget --http-user=admin --http-passwd=pass123 http://192.30.23.45/admin/channelm2/set_
params.cgi?rec_enabled=on
305
Pearl User Guide
Configuration keys for third party APIs
Configuration keys for third party APIs
Using HTTP or RS-232, you can send commands to the system to query or configure the system. For the RS232 and HTTP syntax see Control with RS-232 / serial port and Control with HTTP commands.
When setting keys to values with spaces use the following syntax.
For RS-232:
Enclose in quotes: SET.2.framesize="640 x 480"
For HTTP:
Encode each space as %20: set_params.cgi?framesize=640%20x%20480
The following sections describe the API keys supported by the system in each of these categories:
l System-level settings keys (read-only)
l System-level settings keys (read/write)
l Touch screen settings keys (read/write)
l Recording configuration keys
l HTTP server configuration keys
l IP-based access control configuration keys
l UPnP configuration keys
l SAP configuration keys
l Frame grabber configuration keys
l Broadcast configuration keys
l Channel encoder configuration keys
l Channel layout configuration keys
l Channel logo configuration keys
l Configuration keys for third party APIs
l Audio configuration keys
l Stream publishing configuration keys
306
Pearl User Guide
Configuration keys for third party APIs
l RTSP announce configuration keys (Publish type 2)
l RTP/UDP configuration keys (Publish type 3)
l MPEG-TS configuration keys (Publish types 4 and 5)
l RTMP push configuration keys (Publish type 6)
l Content metadata configuration keys
The list of supported keys is also available for viewing from your system. Browse to the following URL (where
<address> is the IP address of the system):
http://<address>/admin/http_api.cgi
System-level settings keys (read-only)
The following read-only system-level setting keys are supported. The channel number can be omitted from
the command when requesting the value for these keys.
Table 38 Supported Read-Only System-level Settings Configuration Keys
Key
Values
String, including the
firmware_version
text FIRMWARE_
VERSION=.
mac_address
String
Description
The system’s firmware version.
The value is read-only.
The system’s mac address. Useful for debugging.
The value is read-only.
The product’s name.
product_name
String
Useful to confirm you are communicating with the right
product or for debugging purposes.
The value is read-only.
Name of the vendor.
vendor
Epiphan Video
The value is always “Epiphan Video”.
The value is read-only.
System-level settings keys (read/write)
The following read/write system-level setting keys are supported. The channel number can be omitted from
the command when requesting the value for these keys.
307
Pearl User Guide
Configuration keys for third party APIs
Table 39 Supported Read/Write System-level Settings Configuration Keys
Key
Values
Description
frmcheck_
on
To enable firmware update checking, set to on.
enabled
empty string ("")
To disable firmware update checking, set to an empty string ("").
description
string
Enables or disables automatic firmware update checking.
To give this system a name in the Epiphan discovery utilty, specify a description string.
Touch screen settings keys (read/write)
The following configuration keys are supported for modifying the touch screen configuration. The channel
number can be omitted from the command when requesting or setting the value for these keys.
Table 40 Supported Touch Screen Settings Configuration Keys
Key
Values
Description
touchscreen_backlight
integer( 0...255)
Specify the touchscreen backlight level.
touchscreen_enabled
on
empty string ("")
Enables or disables the touch screen.
To enable the touch screen, set to on.
To disable the touch screen, set to an empty string ("").
Enables or disables system information from the touch
touchscreen_info
on
empty string ("")
screen.
To enable system info from the touch screen, set to on.
To disable system info from the touch screen, set to an
empty string ("").
Enables or disables channel preview on the touch screen.
touchscreen_preview
on
To enable preview on the touch screen, set to on.
empty string ("")
To disable preview on the touch screen, set to an empty
string ("").
Enables or disables recording control from the touch screen.
touchscreen_recordctrl
on
To enable recording from the touch screen, set to on.
empty string ("")
To disable recording from the touch screen, set to an empty
string ("").
touchscreen_settings
on
Enables or disables settings changes from the touch screen.
empty string ("")
To enable settings changes from the touch screen, set to on.
308
Pearl User Guide
Configuration keys for third party APIs
Key
Values
Description
To disable settings changes from the touch screen, set to an
empty string ("").
touchscreen_timeout
Specify the time in seconds before the touchsreen times out.
integer
For no timeout, use 0.
Recording configuration keys
The following recording settings are supported. When using,, specify the channel or recorder you wish to
configure.
Table 41 Supported Recording Configuration Keys
Key
rec_enabled
Values
on
empty string ("")
Description
Enables or disables recording.
To enable recording, set to on.
To disable recording, set to an empty string ("").
avi
rec_format
mov
mp4
Specifies the format of the saved file.
ts
rec_prefix
string
Specifies a prefix for the recorded filenames.
rec_sizelimit
integer
Specifies the file size limit, in kilobytes (kB).
rec_timelimit
integer
Specifies the time limit, in seconds, before a new recording file is
created.
HTTP server configuration keys
The following settings are supported for configuration of the HTTP server run by the system.
Table 42 Supported HTTP Server Configuration Keys
Key
Values
Description
http_port
integer
Specifies the HTTP server port.
http_sport
integer
Specifies the HTTP server SSL port (HTTPS port).
http_usessl
on
Enables or disables HTTPS (SSL Server)
309
Pearl User Guide
Key
Configuration keys for third party APIs
Values
empty string ("")
Description
To enable SSL, set to on.
To disable SSL, set to an empty string ("").
IP-based access control configuration keys
The following settings are supported for configuring allowed and denied IP addresses for the system ONLY,
not for individual channels. See Restrict viewers by IP address for more information on Allow and Deny lists.
Table 43 Supported IP-Based Access Configuration Keys
Key
Values
Description
string: comma-sepallowips
arated list of
Specifies the IP addresses to permit access.
IP addresses and/or
To restrict access, provide a list of permitted IP addresses.
ranges.
To clear allowed IP restriction, set to an empty string ("").
empty string("")
string: comma-sepdenyips
arated list of
Specifies the IP addresses to deny access.
IP addresses and/or
To restrict access, provide a list of denied IP addresses.
ranges.
To clear denied IP restriction, set to an empty string ("").
empty string("")
UPnP configuration keys
The following settings are supported for UPnP streaming.
Table 44 Supported UPnP Streaming Configuration Keys
Key
share_archive
Values
on
empty string ("")
Description
Enables sharing of recorded files via UPnP.
To enable sharing files over UPnP, set to on.
To disable sharing files over UPnP, set to an empty string ("").
Enables sharing of the live stream via UPnP.
share_livestreams
on
To enable stream sharing over UPnP, set to on.
empty string ("")
To disable stream sharing over UPnP, set to an empty string
("").
server_name
string
Specifies the UPnP server name.
310
Pearl User Guide
Key
Configuration keys for third party APIs
Values
Description
To use the system name, set to an empty string ("").
SAP configuration keys
The following settings are supported for SAP sharing.
Table 45 Supported SAP Configuration Keys
Key
sap
Values
on
empty string ("")
Description
Enables sharing of recorded files via SAP.
To enable sharing files over SAP, set to on.
To disable sharing files over SAP, set to an empty string ("").
sap_channel_no
integer
Specifies the SAP channel number.
sap_group
string
Specifies the SAP group name.
sap_ip
string
Specify the SAP annoucement IP.
Frame grabber configuration keys
The following configuration settings are supported by the system. See Configure a sourcefor more
information on each variable.
Table 46 Supported Frame Grabber Configuration Keys
Key
Values
gain
0...255
Description
Specifies ADC gain adjustments.
0 is brightest, 255 is darkest.
Specifies horizontal shift.
hshift
-999...999
For shifts to the left, use positive values.
For shifts to the right, use negative values.
offset
0...63
phase
0...31
pll
-999...999
Specifies ADC offset.
0 is brightest, 63 is darkest.
Specifies phase adjustments for VGA signals. Generally not
used unless value is provided by Epiphan support.
Specifies PLL adjustment.
Changes the number of pixels in the line.
311
Pearl User Guide
Configuration keys for third party APIs
Key
Values
tune_interval
0...9999
Description
Specifies the number of seconds between auto-adjustments.
To disable auto-adjustments, set to 0.
Specifies vertical shift.
vshift
-20...20
For shifts up, use positive values.
For shifts down, use negative values.
Broadcast configuration keys
The following broadcast configuration settings are supported.
Table 47 Supported Broadcast Configuration Keys
Key
bcast_disabled
rtsp_port
streamport
Values
on
empty string ("")
Description
Enables or disables the broadcast.
To disable broadcast, set to on.
To enable broadcast, set to empty string ("").
1000...65535,
Specifies the port for RTSP streaming. Note port 5557 is used
but not 5557
for network discovery and cannot be used for streaming.
1000...65535,
Specifies the port used for streaming. Note port 5557 is used
but not 5557
for network discovery and cannot be used for streaming.
Channel encoder configuration keys
The following encoder settings are supported for each channel. For more information on individual items
listed, see Configure encoding .
Table 48 Supported channel encoder configuration keys
Key
Values
Description
Enables or disables use of the current signal’s resolution as the
autoframesize
on
empty string ("")
frame size. Is switched to off if a frame size is manually specified.
To use current signal’s frame size, set to on.
To specify frame size directly, set to empty string ("").
h.264
codec
mpeg4
Specifies the stream codec.
mjpeg
312
Pearl User Guide
Configuration keys for third party APIs
Key
Values
fpslimit
1-60
Description
Specifies the frame per second limit.
Set to your desired limit.
640 x 480
720 x 400
720 x 480
720 x 576
768 x 576
1024 x 768
1152 x 864
1280 x 720
framesize
1280 x 768
1280 x 960
1280 x 1024
Specifies the frame size in pixels.
Set to desired size, refer to description above on handling white
space in the value.
1360 x 768
1360 x 1024
1600 x 1200
1920 x 1200
2048 x 2048
2560 x 1600
keep_aspect_ratio
nosignal
timelabel
slicemode
deprecated
deprecated
on
Enables or disables h.264 slicing for RTP. To enable slicing, set
empty string ("")
to on. To disable slicing, set to empty string ("").
Integer
vbitrate
integerK (i.e. 64K)
integerM (i.e. 1M)
vbufmode
vencpreset
deprecated
1 (low delay)
2 (storage)
Gets or changes the video bit rate in kbit/s.
Short forms such as 64K or 1M can be used.
Specifies the broadcast compression level.
For low delay when streaming, specify 1.
For best results or recording, set to 2.
0 (Software)
Specifies a video encoding preset.
5 (Hardware Accel-
For software, set to 0.
erated)
For hardware acceleration (recommended), set to 5
313
Pearl User Guide
Configuration keys for third party APIs
Key
Values
Description
videosource
deprecated
vkeyframeinterval integer
66
vprofile
77
100
qvalue
0...100
Interval time in seconds between key frames in the encoded
stream.
Specifies the h.264 video profiles.
For Baseline profile, select 66.
For Main profile, select 77.
For High profile, select 100.
Specifies quality for M-JPEG videos.
Channel layout configuration keys
The following settings are channel layout configuration.
To work with layouts, you need to know the integer identifier for the layout. To find your layout's identifier,
select the layout from the web UI and look for the identifier in the browser's url bar.
Table 49 Supported channel layout configuration keys
Key
Values
active_layout
integer
Description
Specifies which layout is currently active for the specified channel.
Channel logo configuration keys
All logo configuration keys are deprecated.
314
Pearl User Guide
Configuration keys for third party APIs
Audio configuration keys
The following audio configuration keys are supported. For more information on individual items listed, see
Configure Encoding (Multi-source).
Table 50 Supported Audio Configuration Keys
Key
audio
Values
on
empty string ("")
Description
Enables or disables audio for the stream.
To enable audio, set to on.
To disable audio, set to an empty string ("").
32
64
96
audiobitrate
112
128
Specifies the audio bitrate for the stream.
Not applicable for PCM audio codecs.
160
192
audiochannels
1 (mono)
2 (stereo)
Specifies the number of audio channels.
For mono, set to 1.
For stereo, set to 2.
CODECS:
pcm_s161e (PCM)
libmp3lame (MP3)
libfacc (AAC)
RATES:
audiopreset
32
64
Specifies an audio code preset in the format CODEC;RATE.
i.e. libfaac;128
96
112
128
160
192
Stream publishing configuration keys
The system supports the following stream publishing settings. For more information on publishing the
stream, see What is streaming?.
315
Pearl User Guide
Configuration keys for third party APIs
Table 51 Supported Stream Publishing Configuration Keys
Key
Values
Description
0 (do not publish)
1 (via Epiphan.tv)
2 (RTSP Announce)
3 (multicast RTP/UDP)
4 (multicast MPEG-TS
publish_type
over UDP)
5 (multicast MPEG-TS
Specifies the type of stream publishing, if any.
over RTP/UDP)
6 (RTMP push)
7 (Wowza Streaming
Cloud)
8 (Original
Livestream)
RTSP announce configuration keys (Publish type 2)
The following settings are supported when the publish type is set to RTSP Announce. For more information on
RTSP and these settings, see What is streaming?.
Table 52 Supported RTSP Announce Configuration Keys
Key
announce_by_tcp
Values
Description
on
Enables or disable RTSP over TCP. To enable TCP transport, set
empty string ("")
to on. Otherwise, set to empty string ("").
announce_host
string
announce_name
string
announce_password
announce_port
announce_user-
string
1000...65535,
but not 5557
string
Specifies the RTSP server address. Set to the appropriate IP
address.
Specifies the RTSP resource name. (This field is named Mount
Point in the web interface.)
Specifies the password for the RTSP server's user.
Specifies the RTSP server port to connect to for streaming.
Note port 5557 is used for network discovery and cannot be
used for streaming.
Specifies the username for the RTSP server. Value is provided
316
Pearl User Guide
Key
Configuration keys for third party APIs
Values
name
Description
by the RTSP server.
RTP/UDP configuration keys (Publish type 3)
The following settings are supported when the publish type is set to RTP/UDP. For more information on
RTP/UDP and these settings, see What is streaming?.
Table 53 Supported RTP/UDP Configuration Keys
Key
Values
Description
unicast_address
string (IP address)
Specifies the unicast/multicast address.
unicast_aport
unicast_vport
1000...65535,
but not 5557
1000...65535,
but not 5557
Specifies the UDP port for RTP/UDP audio streaming. Note
port 5557 is used for network discovery and cannot be used
for streaming.
Specifies the UDP port for RTP/UDP video streaming. Note port
5557 is used for network discovery and cannot be used for
streaming.
MPEG-TS configuration keys (Publish types 4 and 5)
The following settings are supported when the publish type is set to MPEG-TS. For more information on
MPEG-TS and these settings, see What is streaming?.
Table 54 Supported MPEG-TS Configuration Keys
Key
Values
Description
unicast_address
string (IP address)
Specifies the unicast/multicast address.
unicast_mport
1000...65535,
but not 5557
Specifies the UDP port for MPEG-TS streaming. Note port 5557
is used for network discovery and cannot be used for streaming.
RTMP push configuration keys (Publish type 6)
The following settings are supported when the publish type is set to RTMP Push. For more information on
RTMP and these settings, see What is streaming?.
317
Pearl User Guide
Configuration keys for third party APIs
Table 55 Supported RTMP Annouce Configuration Keys
Key
Values
announce_host
string
announce_name
string
announce_password
announce_port
announce_username
string
1000...65535,
but not 5557
string
Description
Specifies the RTMP server address. Set to the appropriate IP
address.
Specifies the RTMP resource name. (This field is named Mount
Point in the web interface.)
Specifies the password for the RTMP server's user.
Specifies the RTMP server port to connect to for streaming.
Note port 5557 is used for network discovery and cannot be
used for streaming.
Specifies the username for the RTMP server. Value is provided
by the RTMP server.
Content metadata configuration keys
The following keys are available for configuration of the content's metadata.
Table 56 Supported Content Metadata Configuration Keys
Key
Values
Description
Specifies the name of the author for the stream/recording.
author
string
Refer to description above on handling white space (spaces) in
the string.
comment
string
Specifies a comment for the stream/recording. Refer to description above on handling white space (spaces) in the string.
Specifies the copyright for the streaming/recording. Refer to
copyright
string
description above on handling white space (spaces) in the
string.
Specifies the title for the stream/recording. Refer to description
title
string
above on handling white space (spaces) in the string. (This
string can be displayed by certain viewing applications by looking at the stream's metadata information.)
318
Pearl User Guide
Troubleshooting
Troubleshooting
Use the follow table for help if you are experiencing problems or unexpected behavior from your Pearl.
Problem
Action(s) to Resolve
Check each source's input from the source preview in the Web
Interface.
Not sure if the connected video inputs
are being captured.
OR
Check the touchscreen interface to view confidence monitoring
for each channel. See Touchscreen overview.
Verify that you are using the correct audio input by following
the steps in Configure encoding .
OR
No sound is coming from an audio
source.
Check the audio meter from the tablet UI (accessible from any
web browser). See Mobile / tablet operator interface.
OR
Check the touchscreen interface for audio monitoring or use
the 3.5 mm audio jack on the front of Pearl to verify audio. See
Touchscreen overview.
Too much noise is present in the audio
output.
Modify the Input Amplifier Volume parameter in the Audio
menu. Start with setting it to 40% and reduce until the noise is
no longer present. See for details on this setting.
The following tips can help improve image quality:
1. Ensure the source resolution is used as the output or
recorded resolution. Up-scaling and down-scaling can
Image quality is poor or insufficient.
affect picture quality.
2. Increase the Bitrate value and/or decrease the Limit
frame rate value in the Encoding menu. See Configure
encoding .
The following tips can help improve frames per second (fps):
Frames per second are lower than expected.
1. Increase the Limit frame rate value and/or decrease
the Bitrate value in the Encoding menu. See Configure
319
Pearl User Guide
Problem
Troubleshooting
Action(s) to Resolve
encoding .
2. Reduce the number of actions happening
simultaneously on the system (i.e. if streaming,
recording, and copying files, consider waiting to copy
files until after streaming and recording are complete).
3. Enter a low negative value (i.e. -5) in the Frame Grabber's
Vertical Shift field.
4. Reduce the number of channels encoding data.
5. Ensure the hardware-accelerated H.264 encoding preset
is chosen for all channels.
Verify that the Stream Type matches with the media player
used and that you have the correct url or SDP file for the
player. See Stream content using HTTP or RTSP and Stream to a
Stream won't play in my media player or
browser.
media player.
If you still cannot see the stream, try disabling your local
computer firewall.
If the issue is still not resolved, contact Epiphan Support at
[email protected]
The following tips can help diagnose image problems:
1. Ensure the source resolution is used as the output or
recorded resolution. Up-scaling and down-scaling can
affect picture quality. Configure encoding .
The stream interrupts or the image
breaks up.
2. Increase the Bitrate value and/or decrease the Limit
frame rate value in the Encoding menu. See Configure
encoding .
3. Check network settings including filters, routers and
application settings. Packet loss can result in stream
failure.
If recording will not start, check the Disk Status Information to
Recording issues.
see if the system is out of disk space. See Check disk storage
space and Recorded files.
Firmware upgrade fails.
Reboot the system and try again. If the problem persists, contact Epiphan support at [email protected]
320
Releases and Features
This section outlines the features introduced with previous product release.
Release 3.15.1 Features (Pearl only)
Firmware release 3.15.1 was a big release with a lot of new features for Pearl, making it your perfect, go-to favorite
when recording or streaming live video events.
l Front-mounted audio jack for Pearl
l Live video switching
l Audio monitoring on Pearl
l Video source cropping
l Use a picture as a video source
l Transparent PNG overlays
l Stream background, logo and text overlay improvements
l New multi-source layout designer
Release 3.14.4 Features
l Live Streaming via Wowza Cloud
Release 3.14.3 Features
l Configuration presets
l Network configuration via the touch screen
l Stereo audio encoding
l Support for 256 kbps and 320 kbps audio sampling
l LDAP support
l SCP and SFTP file transfer
Release 3.14.1 Features
l Capture 4 HD sources simultaneously
l 48 kHz audio support
l Simplified H.264 video encoding presets
l Configurable EDID
l MP4 support
Release 3.14.0 Features
l Touch screen display
l HDMI input
l Automatic channels
l Hardware acceleration for H.264 encoding
l Stream access control improvements
Release 3.12 Features
l RTMP live streaming
l SAP Announce
Software and Documentation License
ATTENTION: THE SOFTWARE AND DOCUMENTATION PROVIDED UNDER THIS AGREEMENT ARE BEING
LICENSED TO YOU BY EPIPHAN SYSTEMS INC. (“LICENSOR”) AND ARE NOT BEING SOLD. THIS AGREEMENT
CONTAINS LIMITATIONS ON REPRESENTATIONS, WARRANTIES, CONDITIONS, REMEDIES, AND LIABILITIES
THAT ARE APPLICABLE TO THE SOFTWARE AND DOCUMENTATION.
Epiphan Systems Inc. Software License
IMPORTANT: BEFORE DOWNLOADING, INSTALLING, OR USING THE SOFTWARE AND DOCUMENTATION,
PLEASE CAREFULLY READ THIS AGREEMENT WHICH CONTAINS THE TERMS AND CONDITIONS UNDER WHICH
YOU ARE ACQUIRING A LICENSE TO USE THE SOFTWARE AND DOCUMENTATION. IF YOU DO NOT ACCEPT
THE TERMS AND CONDITIONS OF THIS AGREEMENT PLEASE DO NOT DOWNLOAD, INSTALL, OR USE THE
SOFTWARE AND DOCUMENTATION AND PROMPTLY RETURN OR DESTROY THE SOFTWARE AND
DOCUMENTATION. IF YOU DOWNLOAD, INSTALL, OR USE THE SOFTWARE AND/OR DOCUMENTATION, YOU
WILL HAVE ACCEPTED AND AGREED TO THESE TERMS AND CONDITIONS. THE SOFTWARE AND
DOCUMENTATION ARE ALSO PROTECTED BY COPYRIGHT LAWS AND INTERNATIONAL COPYRIGHT TREATIES,
AS WELL AS OTHER INTELLECTUAL PROPERTY LAWS. IF YOU ARE AN AGENT OR EMPLOYEE OF AN ENTITY,
YOU REPRESENT AND WARRANT THAT (I) THE INDIVIDUAL ACCEPTING THIS AGREEMENT IS DULY
AUTHORIZED TO ACCEPT THIS AGREEMENT ON SUCH ENTITY’S BEHALF AND TO BIND SUCH ENTITY, AND (II)
SUCH ENTITY HAS FULL POWER, CORPORATE OR OTHERWISE, TO ENTER INTO THIS AGREEMENT AND
PERFORM ITS OBLIGATIONS UNDER THIS AGREEMENT.
1. Definitions: In this Agreement:
“Agreement” means this Epiphan Software License;
“Documentation” means the technical publications delivered to You with the Software relating to the
installation and operation of the Software, such as reference, user, installation and technical guides and
release notes;
“Epiphan” means Epiphan Systems Inc.;
“Software” means the Licensor binary and/or bytecode software programs that (i) are made available to You
for download after acceptance of this Agreement, (ii) are packaged with this Agreement, or (iii) pre-installed on
Epiphan products, or (iv) embed this Agreement in their installer(s) and which are installed after acceptance of
this Agreement, and which binary and/or bytecode software programs include any Documentation; and
“You” or “Your” means the individual acquiring the Software license or any entity on whose behalf such
individual is acting. In the case of an entity, "You" includes any entity that by majority voting interest controls,
is controlled by, or is under common control with You.
2. Grant of Software License: Subject to the terms and conditions of this Agreement, Licensor grants You a
non-exclusive, non-transferable, non-sublicensable, internal license to use a reasonable number of copies of
the Software. All copies of the Software made by You shall include all trademarks, copyright notices, restricted
rights legends, proprietary markings and the like exactly as they appear on the copy of the Software originally
provided to You. No other rights in the Software or Documentation are granted to You.
3. Open Source Software: Binary, bytecode and source code versions of certain open source software
packages may be embedded in or distributed with the Software (“Open Source Software”). If a separate
license agreement for an item of open source software is: delivered to You with the Software; included in the
download package for the Software; referenced in any material (including the Documentation) that is included
in the download or distribution package for the Software; or listed at www.epiphan.com/opensource, then
such open source software shall be Open Source Software and such separate license agreement shall govern
Your use of that item or version of such open source software. The Open Source Software may include free
software (i.e. software licensed under the GNU Lesser General Public License or other free software licenses)
for which the applicable free software license may also require that the source code for such free software be
made available to those receiving only executable versions of such free software. If the source code for any
free software distributed with the Software is not provided with the Software, then upon request, within a
three (3) year period from the original receipt of such Open Source Software from Licensor, for a fee that shall
not exceed Licensor's costs associated with the shipping of the source code for such free software, Licensor
will provide a copy of the source code for such free software to You.
4. Restrictions: The terms set forth in this Section 4 shall constitute conditions to the licenses granted in
Section 2. You shall not reverse engineer, disassemble, reverse translate, decompile or in any other manner
decode the Software except to the extent the Software is distributed with any Open Source Software that
prohibits the imposition of such a restriction or to the extent the foregoing restriction is expressly prohibited
by applicable law notwithstanding a contractual obligation to the contrary. You acknowledge and agree that
no rights in respect to the source code of the Software are granted to You. You acknowledge and agree that
the rights in respect to use of the Software and Documentation are granted only for use in conjunction with
Epiphan hardware. You shall not distribute, lease, rent, grant a security interest in, assign, or otherwise
transfer the Software except as expressly provided in this Agreement. You shall not modify or create any
derivatives works of the Software or merge all or any part of the Software with another program. You shall
not use the Software or make the Software available to any third parties as part of any service bureau, time
sharing service, application service provider offering, software-as-a-service offering or any other managed
service offering. You shall not disclose any performance, benchmarking, or feature-related information about
the Software. You further agree not to disclose, transfer or otherwise provide to any third party any portion
of the Software, except as expressly permitted herein.
5. Disclaimer of Warranties: Licensor does not make any representations or provide any
warranties or conditions in respect to the Software. EXCEPT FOR ANY WARRANTIES THAT MAY BE
PROVIDED IN ANY COMMERCIAL AGREEMENT BETWEEN YOU AND LICENSOR, THE SOFTWARE AND
DOCUMENTATION ARE PROVIDED “AS IS”, WITHOUT ANY REPRESENTATIONS, CONDITIONS, OR
WARRANTIES OF ANY KIND. WITHOUT LIMITATION, LICENSOR AND ITS LICENSORS, SUPPLIERS,
SUBCONTRACTORS AND DISTRIBUTORS DISCLAIM ANY EXPRESS OR IMPLIED REPRESENTATIONS,
CONDITIONS, AND/OR WARRANTIES OF MERCHANTABILITY, MERCHANTABLE QUALITY, NONINFRINGEMENT, DURABILITY, TITLE, SATISFACTORY QUALITY, OR FITNESS FOR A PARTICULAR
PURPOSE WHETHER ARISING BY STATUTE, COURSE OF DEALING, USAGE OF TRADE, OR OTHERWISE.
EXCEPT AS OTHERWISE EXPRESSLY PROVIDED IN ANY COMMERCIAL AGREEMENT, THE ENTIRE RISK
OF THE USE OF THE SOFTWARE AND DOCUMENTATION SHALL BE BORNE BY YOU. EXCEPT AS
OTHERWISE EXPRESSLY PROVIDED IN ANY COMMERCIAL AGREEMENT, NEITHER LICENSOR NOR ANY
OF ITS LICENSORS, SUPPLIERS, SUBCONTRACTORS AND/OR DISTRIBUTORS MAKE ANY
REPRESENTATIONS OR PROVIDE ANY CONDITIONS AND/OR WARRANTIES ABOUT THE SUITABILITY
OF THE SOFTWARE AND/OR DOCUMENTATION OR ABOUT ANY INFORMATION AND/OR DATA THAT
MAY BE PROCESSED BY OR MADE AVAILABLE USING THE SOFTWARE.
6. LIMITATION OF LIABILITY: NEITHER LICENSOR NOR ANY OF ITS LICENSORS, SUPPLIERS,
SUBCONTRACTORS AND/OR DISTRIBUTORS SHALL HAVE ANY LIABILITY TO YOU OR ANY OTHER
PERSON OR ENTITY FOR ANY DAMAGES ARISING FROM THIS AGREEMENT, RELATING TO THE
SOFTWARE OR DOCUMENTATION, OR RELATING TO ANY SERVICES PROVIDED TO YOU BY LICENSOR
(INCLUDING ITS LICENSORS, SUPPLIERS, SUBCONTRACTORS AND/OR DISTRIBUTORS) IN RELATION
TO THE SOFTWARE AND/OR DOCUMENTATION FOR ANY INDIRECT, RELIANCE, INCIDENTAL,
SPECIAL, PUNITIVE, EXEMPLARY OR CONSEQUENTIAL DAMAGES, INCLUDING, BUT NOT LIMITED TO,
LOSS OF REVENUE OR PROFIT, LOSS OF OR DAMAGE TO DATA, BUSINESS INTERUPTION, LOSS OF
DATA, REPLACEMENT OR RECOVERY COSTS, OR OTHER COMMERCIAL OR ECONOMIC LOSS,
WHETHER ARISING FROM CONTRACT, EQUITY, TORT (INCLUDING NEGLIGENCE OR STRICT
LIABILITY) OR ANY OTHER THEORY OF LIABILITY, EVEN IF LICENSOR (INCLUDING ITS LICENSORS,
SUPPLIERS, SUBCONTRACTORS AND DISTRIBUTORS) HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES, OR THEY ARE FORESEEABLE. THE LIMITATIONS IN THIS SECTION SHALL APPLY
WHETHER OR NOT THE ALLEGED BREACH OR DEFAULT IS A BREACH OF A FUNDAMENTAL
CONDITION OR TERM OR FUNDAMENTAL BREACH. SOME JURISDICTIONS DO NOT ALLOW THE
EXCLUSION OR LIMITATION OF LIABILITY FOR CONSEQUENTIAL OR INCIDENTAL DAMAGES, SO
THESE LIMITATIONS MAY NOT APPLY TO YOU. IN NO EVENT SHALL THE TOTAL CUMULATIVE
LIABILITY OF LICENSOR (INCLUDING ITS LICENSORS, SUPPLIERS, SUBCONTRACTORS AND
DISTRIBUTORS) TO YOU OR ANY OTHER PERSON OR ENTITY FOR ANY DAMAGES ARISING FROM
THIS AGREEMENT, RELATING TO THE SOFTWARE, DOCUMENTATION AND/OR RELATING TO ANY
SERVICES PROVIDED TO YOU BY LICENSOR (INCLUDING ITS LICENSORS, SUPPLIERS,
SUBCONTRACTORS AND DISTRIBUTORS) IN RELATION TO THE SOFTWARE AND/OR
DOCUMENTATION, EXCEED THE LICENSE FEES PAID BY YOU FOR THE SOFTWARE.
THE DISCLAIMER OF REPRESENTATIONS, WARRANTIES AND CONDITIONS AND LIMITATION OF
LIABILITY CONSTITUTE AN ESSENTIAL PART OF THIS AGREEMENT. YOU ACKNOWLEDGE THAT BUT
FOR THE DISCLAIMER OF REPRESENTATIONS, WARRANTIES AND CONDITIONS AND LIMITATION OF
LIABILITY, NEITHER LICENSOR NOR ANY OF ITS LICENSORS OR SUPPLIERS WOULD GRANT THE
RIGHTS GRANTED IN THIS AGREEMENT.
7. Term and Termination: This Agreement shall continue for as long as You use the Software, however, it
may be terminated sooner as provided in this Section 7. You may terminate this Agreement by destroying all
copies of the Software and Documentation under Your control and providing certification of such destruction
to Licensor or by returning the Software to Licensor. Licensor may terminate this Agreement immediately by
providing You with written notice if: (a) You are in material breach of any provision of this Agreement, which
breach, if capable of being cured, is not cured within thirty (30) days after Licensor gives You written notice
thereof; or (b) You have committed a non-curable material breach of this Agreement. Upon termination You
shall destroy all copies of the Software. In addition to this Section, the Sections entitled Definitions, Disclaimer
of Warranties, Limitation of Liability, Title, High-Risk Activities, Intellectual Property, and General shall continue
in force even after any termination of this Agreement. No termination of this Agreement will entitle You to a
refund of any amounts paid by You to Licensor or affect any obligations You may have to pay any
outstanding amounts owing to Licensor. Upon any termination by Licensor, You shall destroy all copies of the
Software and Documentation under Your control and certify such destruction to Licensor.
8. Support and Updates: This Agreement does not grant You the right to any updates or enhancements of
the Software or the right to receive any technical support for the Software. Such updates and other technical
support services, if available, may be purchased separately from Licensor. Use of any updates or
enhancements to the Software provided pursuant to any technical support You may procure from Licensor
shall be governed by the terms and conditions of this Agreement. Licensor reserves the right at any time not
to release or to discontinue the release of any Software and to alter prices, features, specifications,
capabilities, functions, licensing terms, release dates, general availability or other characteristics of the
Software.
9. Title: All right, title, and interest (including all intellectual property rights) in, to, and under the Software
(including all copies thereof) shall remain with Licensor and its licensors.
10. High-Risk Activities: The Software is not fault-tolerant and is not designed, manufactured or intended
for use in or in conjunction with on-line control equipment in hazardous environments requiring fail-safe
performance, such as in the operation of nuclear facilities, aircraft navigation systems, air traffic control, or
direct life support machines. Licensor, its licensors, suppliers, subcontractors and distributors specifically
disclaim any express or implied representations, warranties and/or conditions for such uses.
11. U.S. Government End-Users: The Software and Documentation are each a "commercial item" as that
term is defined at FAR 2.101, consisting of "commercial computer software" and "commercial computer
software documentation" as such terms are defined in FAR 12.212, and are provided to the U.S. Government
only as commercial end items. Government end users acquire the rights set out in this Agreement for the
Software and Documentation consistent with: (i) for acquisition by or on behalf of civilian agencies, the terms
set forth in FAR12.212; or (ii) for acquisition by or on behalf of units of the Department of Defense, the terms
set forth in DFARS 227.7202. Use of the Software and Documentation is further restricted by the terms and
conditions of this Agreement. For the purposes of any applicable government use, the Software and
Documentation were developed exclusively at private expense, and are trade secrets of Epiphan Systems Inc.
for the purpose of any Freedom of Information legislation or any other disclosure statute, regulation or
provision.
12. Export Restrictions: The Software, Documentation and related information are subject to export and
import restrictions. By downloading, installing, or using the Software, Documentation and/or related
information, You are representing and warranting that You are not located in, are not under the control of,
and are not a national or resident of any country to which the export of the Software, Documentation and/or
related information would be prohibited by the laws and/or regulations of Canada or the United States. You
are also representing and warranting that You are not an individual to whom the export of the Software,
Documentation or related information would be prohibited by the laws and/or regulations of Canada or the
United States. You shall comply with the export laws and regulations of Canada and the United States that are
applicable to the Software, Documentation and related information and You shall also comply with any local
laws and/or regulations in Your jurisdiction that may impact Your right to export, import, or use the Software,
Documentation or related information, and You represent and warrant that You have complied with any such
applicable laws and/or regulations. The Software, Documentation and related information shall not be used
for any purposes prohibited by export laws and/or regulations, including, without limitation, nuclear, chemical,
or biological weapons proliferation. You shall be responsible for procuring all required permissions for any
subsequent export, import, or use of the Software, Documentation or related information.
13. Intellectual Property: Epiphan is a trademark or a registered trademark of Epiphan Systems Inc. in
certain countries. All Licensor product names and logos are trademarks or registered trademarks of Epiphan
Systems Inc. in certain countries. All other company and product names and logos are trademarks or
registered trademarks of their respective owners in certain countries. You shall not disclose, transfer or
otherwise provide to any third party any portion of the Software, except as expressly permitted in this
Agreement.
14. General: This Agreement is the entire agreement between You and Licensor in respect to the Software,
superseding any other agreements or discussions, oral or written. The terms and conditions of this Agreement
shall prevail over any pre-printed terms on any quotes, orders, purchase orders, or purchase order
acknowledgements, and shall prevail over any other communications between the parties in relation to the
Software. You may not assign this Agreement whether voluntarily, by operation of law, or otherwise without
Licensor’s prior written consent. Licensor may assign this Agreement at any timewithout notice. The failure of
a party to claim a breach of any term of this Agreement shall not constitute a waiver of such breach or the
right of such party to enforce any subsequent breach of such term. If any provision of this Agreement is held
to be unenforceable or illegal, such decision shall not affect the validity or enforceability of such provisions
under other circumstances or the remaining provisions of this Agreement and such remaining provisions shall
be reformed only to the extent necessary to make them enforceable under such circumstances. This
Agreement shall be governed by the laws of the Province of Ontario and the laws of Canada applicable
therein. No choice or conflict of laws rules of any jurisdiction shall apply to this Agreement. You shall only be
entitled to bring any action or proceeding arising out of or relating to this Agreement, the Software,
Documentation or any services provided in respect to the Software and/or Documentation in a court in
Ottawa, Ontario, Canada, and You consent to the jurisdiction of such courts for any such action or proceeding.
You waive all rights that You may have or that may hereafter arise to contest the jurisdiction of such courts for
any action or proceeding brought by You. You hereby waive any right. You may have to request a jury trial
with respect to any action brought by You in connection with this Agreement, the Software or any services
provided in respect to the Software. The application of the United Nations Convention on Contracts for the
International Sale of Goods to this Agreement is expressly excluded.
March 28, 2014
Environmental Information
The equipment that you bought has required the extraction and use of natural resources for its production. It
may contain hazardous substances that could impact health and the environment. In order to avoid the
dissemination of those substances in our environment and to diminish the pressure on the natural resources,
we encourage you to use the appropriate take-back systems. Those systems will reuse or recycle most of the
materials of your end life equipment in a sound way. The crossed-out wheeled bin symbol invites you to use
those systems. If you need more information about collection, reuse and recycling systems, please contact
your local or regional waste administration. You can also contact us for more information on the
environmental performance of our products.
FCC & CE Compliance Statement
This device complies with Part 15 of the FCC Rules. Operation is subject to the following two conditions:
1. This device may not cause harmful interference
2. This device must accept any interference received, including interference that may cause undesired
operation.
Marking by the symbol
indicates compliance of this device with EMC directive of the European Community
and meets or exceeds the following technical standard.
EN 55022 - Limits and Methods of Measurement of Radio Interference Characteristics of Information
Technology Equipment.
Other Jurisdictional Issues
Epiphan makes no representation that its products or information in this document or its web site is
appropriate or available for use in your jurisdiction. Those who choose to access the Epiphan web site or use
Epiphan products do so on their own initiative and are responsible for compliance with local laws, if and to the
extent local laws are applicable
Submissions to Epiphan and Affiliated Servers
Any information, including but not limited to remarks, suggestions, ideas, graphics, or other submissions,
communicated to Epiphan through their Epiphan web site is the exclusive property of Epiphan. Epiphan is
entitled to use any information submitted for any purpose, without restriction (except as stated in Epiphan's
Privacy Statement) or compensation to the person sending the submission. The user acknowledges the
originality of any submission communicated to Epiphan and accepts responsibility for its accuracy,
appropriateness, and legality.
Third Parties and Links to Third-Party Web Sites
Mention of non-Epiphan Systems Inc. products or services on their website, or this document site is for
informational purposes and does not constitute an endorsement or recommendation.
This document may contain links to non-Epiphan web sites. These links are provided to you as a convenience,
and Epiphan is not responsible for the content of any linked web site. Any outside web site accessed from the
Epiphan web site is independent from Epiphan, and Epiphan has no control over the content of that web site.
In addition, a link to any non-Epiphan web site does not imply that Epiphan endorses or accepts any
responsibility for the content or use of such a web site.
In no event shall any reference to any third party or third party product or service be construed as an
approval or endorsement by Epiphan of that third party or of any product or service provided by a third
party.
Miscellaneous
It is the user's responsibility to ascertain whether any information downloaded from the Epiphan web site or
other websites is free of viruses, worms, trojan horses, or other items of a potentially destructive nature.
Enforcement of Terms and Conditions
These Terms and Conditions for use of this document and the associated Epiphan Product are governed and
interpreted pursuant to the laws of the province of Ontario, Canada, notwithstanding any principles of
conflicts of law.
All disputes arising out of or relating to these Terms and Conditions shall be finally resolved by arbitration
conducted in the English language in Ottawa, Ontario, Canada under the commercial arbitration rules of the
Canada. The parties shall appoint as sole arbitrator a retired judge who presided in the province of Ontario.
The parties shall bear equally the cost of the arbitration (except that the prevailing party shall be entitled to an
award of reasonable attorneys' fees incurred in connection with the arbitration in such an amount as may be
determined by the arbitrator). All decisions of the arbitrator shall be final and binding on both parties and
enforceable in any court of competent jurisdiction. Notwithstanding this, application may be made to any
court for a judicial acceptance of the award or order of enforcement. Notwithstanding the foregoing, Epiphan
shall be entitled to seek injunctive relief, security, or other equitable remedies from any court of competent
jurisdiction.
If any part of these terms is unlawful, void, or unenforceable, that part will be deemed severable and will not
affect the validity and enforceability of the remaining provisions. Epiphan may, at its sole discretion and
without notice, revise these terms at any time by updating this posting.
Copyright © 2015 Epiphan Systems Inc.
All Rights Reserved.
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement