Difference between revisions of "BEAM User Guide 1.2.0"

From IVS Wiki
Jump to: navigation, search
(Created page with "=Starting Beam= 1) Touch the IVS Beam App icon. 300x400px 2) You should be prompted to log in. If you are not, touch the words Log Out in the upper right c...")
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
=Starting Beam=
+
=Starting BEAM=
1) Touch the IVS Beam App icon.
+
: 1. ) Touch the '''IVS Beam''' app icon.
  
 
[[File:iOS3.PNG|300x400px]]
 
[[File:iOS3.PNG|300x400px]]
  
2) You should be prompted to log in. If you are not, touch the words Log Out in the upper right corner. This will ensure that your recordings are associated with your username.
+
: 2. ) You should be prompted to log in. If you are not, touch the words '''Log Out''' in the upper right corner. This will ensure that your recordings are associated with your username.
  
 
[[File:iPad7.PNG|400x300px]]
 
[[File:iPad7.PNG|400x300px]]
  
3) Enter your username and touch Log In.
+
: 3. ) Enter your username and touch '''Log In'''.
::'''Important:''' Your username is case sensitive.
+
:::'''Important:''' Your username is case sensitive.
  
 
[[File:iPad8.PNG|400x300px]]
 
[[File:iPad8.PNG|400x300px]]
Line 16: Line 16:
 
[[File:iPad9.PNG|800x600px]]
 
[[File:iPad9.PNG|800x600px]]
  
#) Touch the gear to open the [[Changing Settings on the IVS Beam App|settings]].
+
#) Touch the gear to open the '''[[Changing Settings on the IVS Beam App|Settings]]'''.
 
#) Displays the current status of communication with the server.
 
#) Displays the current status of communication with the server.
 
#) Touch to log out and log in as another user.
 
#) Touch to log out and log in as another user.
 
#) Touch to toggle between the front and rear cameras of your device.
 
#) Touch to toggle between the front and rear cameras of your device.
#) Touch to start [[IVS Beam Recording|recording]].
+
#) Touch to start '''[[IVS Beam Recording|Recording]]'''.
#) Touch to see recordings stored on this device and change [[IVS Beam File Synchronization|sync settings]].  
+
#) Touch to see recordings stored on this device and change '''[[IVS Beam File Synchronization|Sync Settings]]'''.  
 
:::{|
 
:::{|
 
|-
 
|-
Line 33: Line 33:
 
| Automatic Sync is currently disabled.
 
| Automatic Sync is currently disabled.
 
|}
 
|}
::7. ) Touch to place the device into streaming mode.
+
::7. ) Touch to place the device into Streaming Mode.
  
 
=Recording=
 
=Recording=
 
[[File:IPad10.PNG|400x300px]]
 
[[File:IPad10.PNG|400x300px]]
  
1) Touch the recording button
+
: 1. ) Touch the '''Recording''' button.
  
 
[[File:IPad11.PNG|400x300px]]
 
[[File:IPad11.PNG|400x300px]]
  
2) You will be prompted to enter a name for the recording as well as for any custom fields that have been defined for your user.
+
: 2. ) You will be prompted to enter a name for the recording as well as for any custom fields that have been defined for your user.
  
3) Touch Start Recording
+
: 3. ) Touch '''Start Recording'''.
  
4) Your recording time will be displayed in the upper left corner of the screen.
+
: 4. ) Your recording time will be displayed in the upper left corner of the screen.
  
 
[[File:iPad12.PNG|400x300px]]
 
[[File:iPad12.PNG|400x300px]]
  
4) Touch the stop button to stop recording.
+
: 5. ) Touch the '''Stop''' button to stop recording.
  
5) Your recording will be stored locally on your device. If you have [[IVS Beam File Synchronization|Auto Sync]] enabled, the recording will be automatically uploaded to the server.
+
: 6. ) Your recording will be stored locally on your device. If you have [[IVS Beam File Synchronization|Auto Sync]] enabled, the recording will be automatically uploaded to the server.
  
 
=File Synchronization=
 
=File Synchronization=
 
[[File:iPad14.PNG|800x600px]]
 
[[File:iPad14.PNG|800x600px]]
  
This screen will list any recordings that have been made, but not uploaded to the server. These recordings can be deleted by touching the word DELETE.
+
This screen will list any recordings that have been made, but not uploaded to the server. These recordings can be deleted by touching the word '''DELETE'''.
  
 
In the upper left corner of the screen, the current sync settings are displayed. Touch it to toggle sync on and off.
 
In the upper left corner of the screen, the current sync settings are displayed. Touch it to toggle sync on and off.
Line 70: Line 70:
 
|}
 
|}
  
Touch the X in the upper right corner to return to the main UI.
+
Touch the '''X''' in the upper right corner to return to the main UI.
  
 
=Changing Settings=
 
=Changing Settings=
Line 77: Line 77:
 
[[File:IPad6.PNG|400x300px]]
 
[[File:IPad6.PNG|400x300px]]
  
2) The current configuration will be displayed. Update the Server Address, Device UID, username and password as necesary
+
2) The current configuration will be displayed. Update the Server Address, Device UID, username and password as necessary.
  
 
:{|border="1" style="border-collapse:collapse"
 
:{|border="1" style="border-collapse:collapse"
 
|-
 
|-
 
|style="width:150px;"|Server Address
 
|style="width:150px;"|Server Address
|Enter the IP address or FQDN of the server. It must be entered as http://192.168.0.81 or https://192.168.0.81 if you are using SSL
+
|Enter the IP address or FQDN of the server. It must be entered as '''http://192.168.0.81''' or '''https://192.168.0.81''' if you are using SSL.
 
|-
 
|-
 
| Device UID
 
| Device UID
Line 96: Line 96:
 
:Note: If you are utilizing SSL, you must have a cert signed by a trusted CA in order to connect an iOS device.
 
:Note: If you are utilizing SSL, you must have a cert signed by a trusted CA in order to connect an iOS device.
  
3) Touch Sync User Data
+
3) Touch '''Sync User Data'''
  
 
4) You will now be prompted to enter your username. This should be the username of the individual that will be utilizing the device, as that is the user the videos will be stored under. The user can log out and another user can log in at any time.
 
4) You will now be prompted to enter your username. This should be the username of the individual that will be utilizing the device, as that is the user the videos will be stored under. The user can log out and another user can log in at any time.
Line 102: Line 102:
 
[[File:iPad7.PNG|400x300px]]
 
[[File:iPad7.PNG|400x300px]]
  
5) Enter the username
+
5) Enter the username.
  
6) Touch Login
+
6) Touch '''Login'''.

Latest revision as of 11:57, 26 July 2022

Starting BEAM

1. ) Touch the IVS Beam app icon.

IOS3.PNG

2. ) You should be prompted to log in. If you are not, touch the words Log Out in the upper right corner. This will ensure that your recordings are associated with your username.

IPad7.PNG

3. ) Enter your username and touch Log In.
Important: Your username is case sensitive.

IPad8.PNG

Beam User Interface

IPad9.PNG

  1. ) Touch the gear to open the Settings.
  2. ) Displays the current status of communication with the server.
  3. ) Touch to log out and log in as another user.
  4. ) Touch to toggle between the front and rear cameras of your device.
  5. ) Touch to start Recording.
  6. ) Touch to see recordings stored on this device and change Sync Settings.
SyncGood.png Sync is enabled, configured properly and no recordings are currently syncing.
SyncInProgress.png Sync of recordings is currently underway.
SyncPause.png Automatic Sync is currently disabled.
7. ) Touch to place the device into Streaming Mode.

Recording

IPad10.PNG

1. ) Touch the Recording button.

IPad11.PNG

2. ) You will be prompted to enter a name for the recording as well as for any custom fields that have been defined for your user.
3. ) Touch Start Recording.
4. ) Your recording time will be displayed in the upper left corner of the screen.

IPad12.PNG

5. ) Touch the Stop button to stop recording.
6. ) Your recording will be stored locally on your device. If you have Auto Sync enabled, the recording will be automatically uploaded to the server.

File Synchronization

IPad14.PNG

This screen will list any recordings that have been made, but not uploaded to the server. These recordings can be deleted by touching the word DELETE.

In the upper left corner of the screen, the current sync settings are displayed. Touch it to toggle sync on and off.

Turn Auto Sync Off Automatic Sync is currently enabled. Touch to disable.
Turn Auto Sync On Automatic Sync is currently disabled. Touch to enable.

Touch the X in the upper right corner to return to the main UI.

Changing Settings

1) Touch the gear in the upper left corner of the screen.

IPad6.PNG

2) The current configuration will be displayed. Update the Server Address, Device UID, username and password as necessary.

Server Address Enter the IP address or FQDN of the server. It must be entered as http://192.168.0.81 or https://192.168.0.81 if you are using SSL.
Device UID You can obtain this by pulling up the iPad device on the server.
Username
Password
Note: If you are utilizing SSL, you must have a cert signed by a trusted CA in order to connect an iOS device.

3) Touch Sync User Data

4) You will now be prompted to enter your username. This should be the username of the individual that will be utilizing the device, as that is the user the videos will be stored under. The user can log out and another user can log in at any time.

IPad7.PNG

5) Enter the username.

6) Touch Login.