Difference between revisions of "IVS Wiki:BEAM Manual"

From IVS Wiki
Jump to: navigation, search
(Replaced content with "{{Article - Manual | content = <h1>Getting Started</h1> {{Manual lvl 2 | title = Logging In | content = }} {{Top of Page}} {{hr}} {{Manual lvl 2 | title = Streaming |...")
Line 1: Line 1:
 
{{Article - Manual | content =  
 
{{Article - Manual | content =  
 
<h1>Getting Started</h1>
 
<h1>Getting Started</h1>
{{Manual lvl 2 | title = Logging In | content =
 
Before using the BEAM application, users must first sign in.
 
  
 +
{{Manual lvl 2 | title = Logging In | content = }}
  
<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.
 
 
 
{{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>
 
 
{{Manual lvl 2 | title = Connection Status | content =
 
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.}}
 
| right =
 
{{Aside - Helpful | hue = 260 | content = <center>Interactive <b>BEAM Navigation</b>.
 
{{Try it out | link = https://app.storylane.io/share/icfqzqy9tchh}}</center>}}
 
}}
 
<table class="wikitable" style="margin:auto">
 
  <tr>
 
    <th style="width:230px;text-align:right">BEAM can connect to VALT</th>
 
    <td style="width:50px;text-align:center">{{img - no click | file = Beam online status-00.png | width = 100px}}</td>
 
  </tr>
 
  <tr>
 
    <th style="text-align:right">BEAM cannot connect to VALT</th>
 
    <td style="text-align:center">{{img - no click | file = Beam online status-01.png | width = 100px}}</td>
 
  </tr>
 
</table>
 
  
 
{{Top of Page}}
 
{{Top of Page}}
 
{{hr}}
 
{{hr}}
  
{{Manual lvl 2 | title = Logout | content =  
+
{{Manual lvl 2 | title = Streaming | content = }}
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.
 
 
 
{{Aside - Warning | content = Switching servers will <b>delete</b> all videos that are not yet uploaded to VALT.}}
 
}}
 
  
  
Line 69: Line 14:
 
{{hr}}
 
{{hr}}
  
{{Manual lvl 2 | title = Prepare Recording | content =  
+
{{Manual lvl 2 | title = Recording | content = }}
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.
 
}}
 
  
  
Line 77: Line 20:
 
{{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}} {{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.
 
}}
 
  
  
 
{{Top of Page}}
 
{{Top of Page}}
 
{{hr}}
 
{{hr}}
 
{{Manual lvl 2 | title = Record | content =
 
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 Template 01.png}}
 
}}
 
 
 
{{Top of Page}}
 
{{hr}}
 
 
{{Manual lvl 2 | title = Stream | content =
 
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.
 
}}
 
 
 
{{Top of Page}}
 
{{hr}}
 
 
{{Manual lvl 2 | title = Files | content =
 
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.
 
 
 
Users will have access to two methods of syncing their files to VALT.
 
#[[#Manual Upload|Manual Upload]] <em>(Default)</em>
 
#[[#Auto Sync|Auto Sync]]
 
}}
 
 
 
{{Manual lvl 3 | title = Manual Upload | content =
 
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.}}
 
 
 
{{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 01.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}}
 
 
{{Flexbox | left =
 
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>
 
}}
 
 
{{img - resize | file = BEAM Manual 2.0 Files 02.png}}
 
}}
 
 
 
{{Top of Page}}
 
 
}}
 
}}

Revision as of 14:26, 5 May 2025