Difference between revisions of "IVS Wiki:BEAM Manual"

From IVS Wiki
Jump to: navigation, search
 
(16 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}}
 +
}}
 +
 +
 +
{{Top of Page}}
 +
{{hr}}
 +
 +
{{Manual lvl 2 | title = Main Screen | content =
 
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}}
 +
}}
 +
 +
 +
{{Top of Page}}
 +
{{hr}}
 +
 +
{{Flexbox - Basis | left_size = 5 | right_size = 3 | left =
 
<h1>Navigation</h1>
 
<h1>Navigation</h1>
 +
 
{{Manual lvl 2 | title = Connection Status | content =  
 
{{Manual lvl 2 | title = Connection Status | content =  
−
Displays the current status of communication with the VALT server.
+
The {{img - tooltip | file = BEAM Manual 2.0 Navigation 01.png | text = Connection Status | width = 800px}} displays the current status of communication with the VALT server.
−
{{img - resize | file = BEAM Manual 2.0 Navigation 01.png}}
+
}}
 +
| right =
 +
{{Aside - Helpful | hue = 260 | content = <center>Interactive <b>BEAM Navigation</b>.
 +
{{Try it out | link = https://app.storylane.io/share/icfqzqy9tchh}}</center>}}
 
}}
 
}}
  
Line 14: Line 52:
  
 
{{Manual lvl 2 | title = Switch Server | content =  
 
{{Manual lvl 2 | title = Switch Server | content =  
−
The {{img - icon | file = Beam icob(sign-out-option).png | width = 16px}} <strong>Logout</strong> icon will allow you to logout or disconnect BEAM from your VALT server or to change the server settings.
+
The {{img - icon | file = Beam icob(sign-out-option).png | width = 16px}} {{img - tooltip | file = BEAM Manual 2.0 Navigation 02.png | text = Logout button | width = 800px}} will allow you to logout or disconnect BEAM from your VALT server or to change the server settings.
−
{{img - resize | file = BEAM Manual 2.0 Navigation 02.png}}
+
 
 +
{{Aside - Warning | hue = 50 | content = Switching servers will <strong>delete</strong> all videos that are not yet uploaded to VALT.}}
 
}}
 
}}
  
Line 23: Line 62:
  
 
{{Manual lvl 2 | title = Prepare Recording | content =  
 
{{Manual lvl 2 | title = Prepare Recording | content =  
−
Touch to prepare recording information.
+
The {{img - icon | file = Beam icon(hour glass).png | width = 16px}} {{img - tooltip | file = BEAM Manual 2.0 Navigation 03.png | text = Prepare button | width = 800px}} 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.
−
{{img - resize | file = BEAM Manual 2.0 Navigation 03.png}}
 
 
}}
 
}}
  
Line 32: Line 70:
  
 
{{Manual lvl 2 | title = Flip Camera | content =  
 
{{Manual lvl 2 | title = Flip Camera | content =  
−
Touch to toggle between the front and rear cameras of your device.
+
The {{img - icon | file = Beam icon(flip cam).png | width = 16px}} {{img - tooltip | file = BEAM Manual 2.0 Navigation 04.png | text = Flip Camera button | width = 800px}} allows users to toggle between the front and rear cameras of your device.
−
{{img - resize | file = BEAM Manual 2.0 Navigation 04.png}}
 
 
}}
 
}}
  
Line 41: Line 78:
  
 
{{Manual lvl 2 | title = Record | content =  
 
{{Manual lvl 2 | title = Record | content =  
−
Touch to Start Recording.
+
The {{img - icon color | file = Record.png}} {{img - tooltip | file = BEAM Manual 2.0 Navigation 05.png | text = Recording button | width = 800px}} will prompt the user to fill out an Information Template before beginning the reocrding.
−
{{img - resize | file = BEAM Manual 2.0 Navigation 05.png}}
+
 
 +
{{img - resize | file = BEAM Manual 2.0 Information 00.png}}
 
}}
 
}}
  
Line 50: Line 88:
  
 
{{Manual lvl 2 | title = Stream | content =  
 
{{Manual lvl 2 | title = Stream | content =  
−
Touch to place the device into streaming mode.
+
The {{img - icon | file = Beam icon(wifi-signal).png | width = 18px}} {{img - tooltip | file = BEAM Manual 2.0 Navigation 06.png | text = Stream button | width = 800px}} 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.
−
{{img - resize | file = BEAM Manual 2.0 Navigation 06.png}}
 
 
}}
 
}}
  
Line 59: Line 96:
  
 
{{Manual lvl 2 | title = Files | content =  
 
{{Manual lvl 2 | title = Files | content =  
−
Touch to see recordings stored on this device and change [[BEAM_-_Auto_Sync|sync settings]].
+
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 [[BEAM_-_Auto_Sync|sync settings]].
−
{{img - resize | file = BEAM Manual 2.0 Navigation 07.png}}
+
}}
 +
 
 +
 
 +
{{Manual lvl 3 | title = Manual Upload | content =
 +
By default, [[BEAM - Auto Sync | Autosync]] is turned <b>off</b>. If disabled, users will need to <strong>manually sync</strong> their recorded videos.
 +
 
 +
 
 +
{{Flexbox | left =
 +
In the Files folder, you will see a list of your videos.
 +
*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 00.png}}
 +
}}
 +
 
 +
{{hr - 2}}
 +
 
 +
{{Manual lvl 3 | title = Auto Sync | content =
 +
{{Flexbox | right =
 +
{{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}}
 +
 
 +
{{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.}}
 +
{{img with left key - width | file = Beam storage and manual sync 11.png | width = 800px | list =
 +
<li class="singleLineHeight">Toggle switch to turn <b>Auto Sync</b> on and off.</li>
 +
}}
 
}}
 
}}
  

Latest revision as of 10:15, 10 April 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


⇧ Back to Top

Main Screen

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

Navigation

Connection Status

The Connection StatusBEAM Manual 2.0 Navigation 01.png🖼️ displays the current status of communication with the VALT server.

🕮
Interactive BEAM Navigation.
6 port io block.png

Try it out!


⇧ Back to Top

Switch Server

The icon Logout buttonBEAM Manual 2.0 Navigation 02.png🖼️ will allow you to logout or disconnect BEAM from your VALT server or to change the server settings.

⚠Switching servers will delete all videos that are not yet uploaded to VALT.


⇧ Back to Top

Prepare Recording

The icon Prepare buttonBEAM Manual 2.0 Navigation 03.png🖼️ 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.


⇧ Back to Top

Flip Camera

The icon Flip Camera buttonBEAM Manual 2.0 Navigation 04.png🖼️ allows users to toggle between the front and rear cameras of your device.


⇧ Back to Top

Record

The icon Recording buttonBEAM Manual 2.0 Navigation 05.png🖼️ will prompt the user to fill out an Information Template before beginning the reocrding.

BEAM Manual 2.0 Information 00.png


⇧ Back to Top

Stream

The icon Stream buttonBEAM Manual 2.0 Navigation 06.png🖼️ 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 Stream in the VALT application.


⇧ Back to Top

Files

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.


Manual Upload

By default, Autosync is turned off. If disabled, users will need to manually sync their recorded videos.


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 00.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.

⚠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.

  1. Toggle switch to turn Auto Sync on and off.

Beam storage and manual sync 11.png


⇧ Back to Top
Retrieved from "https://ipivs.info/wiki/index.php?title=IVS_Wiki:BEAM_Manual&oldid=15892"