Difference between revisions of "IVS Wiki:BEAM Manual"

From IVS Wiki
Jump to: navigation, search
 
(30 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{Article - Manual | content =  
 
{{Article - Manual | content =  
 +
<h1>Getting Started</h1>
 +
 +
{{Manual lvl 2 | title = Logging In | content =
 +
Before using the BEAM application, users must first sign in.
 +
 +
 +
<ol>
 +
<li>Enter your <b>username</b></li>
 +
<ul>
 +
<li><em>BEAM usernames are the same as the username used to log into VALT.</em></li>
 +
</ul>
 +
{{hr - 2}}
 +
<li>Enter your <b>pincode</b>.</li>
 +
<ul>
 +
<li><em>Not all user accounts have a pincode. If you are unsure of your pincode, please reach out to your local VALT administrator.</em></li>
 +
</ul>
 +
</ol>
 +
 +
 +
{{img - resize | file = BEAM Manual 2.0 Login 00.png}}
 +
  
 
Once logged into BEAM, you will be greated to a camera view with a variety of buttons to perform actions.
 
Once logged into BEAM, you will be greated to a camera view with a variety of buttons to perform actions.
 +
 +
 
{{img - resize | file = BEAM Manual 2.0 Navigation 00.png}}
 
{{img - resize | file = BEAM Manual 2.0 Navigation 00.png}}
−
<h1>Navigation</h1>
 
−
{{Manual lvl 2 | title = Connection Status | content =
 
−
Displays the current status of communication with the VALT server.
 
−
{{img - resize | file = BEAM Manual 2.0 Navigation 01.png}}
 
 
}}
 
}}
  
Line 13: Line 32:
 
{{hr}}
 
{{hr}}
  
−
{{Manual lvl 2 | title = Switch Server | content =  
+
{{Manual lvl 2 | title = Buttons & Navigation | content =  
−
The {{img - icon | file = Beam icob(sign-out-option).png | width = 16px}} <strong>Logout</strong> button will allow you to logout or disconnect BEAM from your VALT server or to change the server settings.
+
<table class="wikitable" style="margin:auto">
 +
  <tr>
 +
    <th>Status</th>
 +
    <th>Meaning</th>
 +
  </tr>
 +
  <tr>
 +
    <td style="width:50px;text-align:center">{{img - no click | file = Beam online status-00.png | width = 100px}}</td>
 +
    <td style="width:230px;">BEAM can connect to VALT</td>
 +
  </tr>
 +
  <tr>
 +
    <td style="text-align:center">{{img - no click | file = Beam online status-01.png | width = 100px}}</td>
 +
    <td style="">BEAM cannot connect to VALT</td>
 +
  </tr>
 +
</table>
 +
 
 +
{{hr - 2}}
 +
 
 +
<table class="wikitable" style="margin:auto">
 +
  <tr>
 +
    <th>Icon</th>
 +
    <th>Description</th>
 +
  </tr>
 +
  <tr>
 +
    <td>{{img - icon | file = Beam icob(sign-out-option).png | width = 20px}}</td>
 +
    <td>This button is used to <strong>logout</strong> of the application, or to [[BEAM_Manual_-_Installation_%26_Configuration#Configuration|switch servers]].</td>
 +
  </tr>
 +
  <tr>
 +
    <td>{{img - icon | file = Beam icon(hour glass).png | width = 20px}}</td>
 +
    <td>This button is used to [[#Prepare a Recording|prepare a recording]].</td>
 +
  </tr>
 +
  <tr>
 +
    <td>{{img - icon | file = Beam icon(flip cam).png | width = 20px}}</td>
 +
    <td>This button is used to filp from the back camera to the front facing camera.</td>
 +
  </tr>
 +
  <tr>
 +
    <td>{{img - icon color | file = Record.png | width = 18px}}</td>
 +
    <td>This button is used to [[#Start a Recording|start a recording]].</td>
 +
  </tr>
 +
  <tr>
 +
    <td>{{img - icon | file = Beam icon(wifi-signal).png | width = 22px}}</td>
 +
    <td>This button is used to [[#Start Streaming|start streaming to VALT]].</td>
 +
  </tr>
 +
  <tr>
 +
    <td>{{img - icon | file = Beam icon(folder).png | width = 20px}}</td>
 +
    <td>This button is to help access [[#File Management|file management]].</td>
 +
  </tr>
 +
</table>
  
−
{{Aside - Warning | hue = 50 | content = Switching servers will <strong>delete</strong> all videos that are not yet uploaded to VALT.}}
 
−
{{img - resize | file = BEAM Manual 2.0 Navigation 02.png}}
 
 
}}
 
}}
  
Line 24: Line 87:
 
{{hr}}
 
{{hr}}
  
−
{{Manual lvl 2 | title = Prepare Recording | content =  
+
<h1>User Functionality</h1>
−
The {{img - icon | file = Beam icon(hour glass).png | width = 16px}} <strong>Prepare</strong> button is used to arm a room for an active recording. This option allows you to fill in all the information fields ahead of the recording.
+
{{Manual lvl 2 | title = Streaming | content = }}
−
{{img - resize | file = BEAM Manual 2.0 Navigation 03.png}}
+
{{Manual lvl 3 | title = Start Streaming | content = }}
−
}}
+
{{Manual lvl 3 | title = Stop Streaming | content = }}
 +
 
 +
{{Top of Page}}
 +
{{hr}}
  
 +
{{Manual lvl 2 | title = Recording | content = }}
 +
{{Manual lvl 3 | title = Start a Recording | content = }}
 +
{{Manual lvl 3 | title = Stop a Recording | content = }}
 +
{{Manual lvl 3 | title = Prepare a Recording | content = }}
  
 
{{Top of Page}}
 
{{Top of Page}}
 
{{hr}}
 
{{hr}}
  
−
{{Manual lvl 2 | title = Flip Camera | content =  
+
{{Manual lvl 2 | title = File Management | content =  
−
The {{img - icon | file = Beam icon(flip cam).png | width = 16px}} <strong>Flip Camera</strong> buttons allows users to toggle between the front and rear cameras of your device.
+
The {{img - icon | file = Beam icon(folder).png | width = 16px}} {{img - tooltip | file = BEAM Manual 2.0 Navigation 07.png | text = Folder button | width = 800px}} will show you recordings stored on this device and allow users to change their individual sync settings.
−
{{img - resize | file = BEAM Manual 2.0 Navigation 04.png}}
+
 
 +
 
 +
Users will have access to two methods of syncing their files to VALT.
 +
#[[#Manual Upload|Manual Upload]] <em>(Default)</em>
 +
#[[#Auto Sync|Auto Sync]]
 
}}
 
}}
  
  
−
{{Top of Page}}
+
{{Manual lvl 3 | title = Manual Upload | content =
−
{{hr}}
+
If Auto Sync is disabled, users will need to <b>manually sync</b> their recorded videos.
 +
{{Aside - Warning | hue = 50 | content = The iPad must be able to communicate with VALT to be able to upload the video to VALT. [[Network_Requirements#BEAM_.28Mobile_Application.29 | Click here]] to learn about the BEAM network requirements.}}
 +
 
  
−
{{Manual lvl 2 | title = Record | content =  
+
{{Flexbox | left =
−
The {{img - icon color | file = Record.png}} <strong>Recording</strong> button will prompt the user to fill out an Information Template before beginning the reocrding.
+
In the Files folder, you will see a list of your videos.
−
{{img - resize | file = BEAM Manual 2.0 Navigation 05.png}}
+
*The <b>up arrow</b> indicates the video has not been synced to the VALT server.
 +
*You can click the up arrow to initiate uploading the video.
 +
*A <b>progress circle</b> will appear after the arrow is pressed.
 +
*A <b>checkmark</b> will appear when the recording is done uploading to the server.
 +
| right =  
 +
<table class="wikitable" style="margin:auto">
 +
  <tr>
 +
    <th style="width:150px;text-align:right">Ready to upload</th>
 +
    <td style="width:50px;text-align:center">{{img - no click | file = Beam upload icon-01.png | width = 30px}}</td>
 +
  </tr>
 +
  <tr>
 +
    <th style="text-align:right">Preparing to upload</th>
 +
    <td style="text-align:center">{{img - no click | file = Beam upload icon-00.png | width = 30px}}</td>
 +
  </tr>
 +
  <tr>
 +
    <th style="text-align:right">Upload in progress</th>
 +
    <td style="text-align:center">{{img - no click | file = Beam upload icon-02.png | width = 30px}}</td>
 +
  </tr>
 +
  <tr>
 +
    <th style="text-align:right">Upload complete</th>
 +
    <td style="text-align:center">{{img - no click | file = Beam upload icon-03.png | width = 30px}}</td>
 +
  </tr>
 +
</table>
 
}}
 
}}
  
 +
{{img - resize | file = BEAM Manual 2.0 Files 01.png}}
 +
}}
  
−
{{Top of Page}}
+
{{hr - 2}}
−
{{hr}}
 
  
−
{{Manual lvl 2 | title = Stream | content =  
+
{{Manual lvl 3 | title = Auto Sync | content =  
−
The {{img - icon | file = Beam icon(wifi-signal).png | width = 18px}} <strong>Stream</strong> button will allow the user to Stream or Stream and Record. Both options will allow the BEAM video stream to be viewable in VALT. The video will show up as a [[VALT_Manual_Observe#Filter|Stream]] in the VALT application.
+
{{Flexbox | right =
−
{{img - resize | file = BEAM Manual 2.0 Navigation 06.png}}
+
{{Aside - Helpful | content = In BEAM{{dash}}<b>Auto Sync if off, by default</b>.}}
 +
| left =
 +
<b>Auto Sync</b> is a feature in [[BEAM Main Page|BEAM]] that allows a user to automatically upload a video from the BEAM application to the VALT server. This screen will list any recordings that have been made, but not uploaded to the server.
 
}}
 
}}
  
 +
{{hr}}
  
−
{{Top of Page}}
+
{{Flexbox | left =
−
{{hr}}
+
Auto Sync is disbaled by deafult. Users can be enable by toggling <b>Auto Sync Files</b>.
 +
| right =
 +
<table class="wikitable" style="margin:auto">
 +
  <tr>
 +
    <th style="width:150px;text-align:right">Auto Sync Disabled</th>
 +
    <td style="width:50px;text-align:center">{{img - no click | file = Beam auto sync icon-01.png | width = 30px}}</td>
 +
  </tr>
 +
  <tr>
 +
    <th style="text-align:right">Auto Sync Enabled</th>
 +
    <td style="text-align:center">{{img - no click | file = Beam auto sync icon-00.png | width = 30px}}</td>
 +
  </tr>
 +
</table>
 +
}}
  
−
{{Manual lvl 2 | title = Files | content =
+
{{img - resize | file = BEAM Manual 2.0 Files 02.png}}
−
The {{img - icon | file = Beam icon(folder).png | width = 16px}} <strong>Folder</strong> button will show you recordings stored on this device and allow users to change their individual [[BEAM_-_Auto_Sync|sync settings]].
 
−
{{img - resize | file = BEAM Manual 2.0 Navigation 07.png}}
 
 
}}
 
}}
  
  
 
{{Top of Page}}
 
{{Top of Page}}
 +
{{hr}}
 
}}
 
}}

Latest revision as of 15:04, 5 May 2025

Getting Started

Logging In

Before using the BEAM application, users must first sign in.


  1. Enter your username
    • BEAM usernames are the same as the username used to log into VALT.
  2. Enter your pincode.
    • Not all user accounts have a pincode. If you are unsure of your pincode, please reach out to your local VALT administrator.


BEAM Manual 2.0 Login 00.png


Once logged into BEAM, you will be greated to a camera view with a variety of buttons to perform actions.


BEAM Manual 2.0 Navigation 00.png


⇧ Back to Top

Buttons & Navigation

Status Meaning
Beam online status-00.png BEAM can connect to VALT
Beam online status-01.png BEAM cannot connect to VALT
Icon Description
icon This button is used to logout of the application, or to switch servers.
icon This button is used to prepare a recording.
icon This button is used to filp from the back camera to the front facing camera.
icon This button is used to start a recording.
icon This button is used to start streaming to VALT.
icon This button is to help access file management.


⇧ Back to Top

User Functionality

Streaming

Start Streaming

Stop Streaming

⇧ Back to Top

Recording

Start a Recording

Stop a Recording

Prepare a Recording

⇧ Back to Top

File Management

The icon Folder buttonBEAM Manual 2.0 Navigation 07.png🖼️ will show you recordings stored on this device and allow users to change their individual sync settings.


Users will have access to two methods of syncing their files to VALT.

  1. Manual Upload (Default)
  2. Auto Sync


Manual Upload

If Auto Sync is disabled, users will need to manually sync their recorded videos.

⚠The iPad must be able to communicate with VALT to be able to upload the video to VALT. Click here to learn about the BEAM network requirements.


In the Files folder, you will see a list of your videos.

  • The up arrow indicates the video has not been synced to the VALT server.
  • You can click the up arrow to initiate uploading the video.
  • A progress circle will appear after the arrow is pressed.
  • A checkmark will appear when the recording is done uploading to the server.
Ready to upload Beam upload icon-01.png
Preparing to upload Beam upload icon-00.png
Upload in progress Beam upload icon-02.png
Upload complete Beam upload icon-03.png

BEAM Manual 2.0 Files 01.png

Auto Sync

Auto Sync is a feature in BEAM that allows a user to automatically upload a video from the BEAM application to the VALT server. This screen will list any recordings that have been made, but not uploaded to the server.

🕮In BEAM—Auto Sync if off, by default.

Auto Sync is disbaled by deafult. Users can be enable by toggling Auto Sync Files.

Auto Sync Disabled Beam auto sync icon-01.png
Auto Sync Enabled Beam auto sync icon-00.png

BEAM Manual 2.0 Files 02.png


⇧ Back to Top

Retrieved from "https://ipivs.info/wiki/index.php?title=IVS_Wiki:BEAM_Manual&oldid=16025"