AccessKitMediaplayer
Reference for AccessKit Mediaplayer entities.
What is a Mediaplayer?
A Mediaplayer is a device that plays back video or audio for Works in a gallery or museum context. It typically is a BrightSign device, but other devices are supported. When using a BrightSign, additionally functionality is enabled, like remote content updating, onscreen captions, multi-channel synchronized video, realtime controls, custom event timelines, quiet mode, and UDP communication.
BrightSign registration and networking
For help with setting up a BrightSign, see the registration guide as well as the networking guide.
Custom audio and video output configuration
If custom audio or video output configuration is needed, see the audio and video output configuration guide.
Finding a Mediaplayer
A Mediaplayer can be found in the Admin Dashboard in the list of Exhibitions and Works underneath the Work that the mediaplayer is assigned to, or if it is not assigned to a work, then it can be found in the list of Unassigned Mediaplayers at the bottom of the page.
Click the mediaplayer's name (which should be a link that looks like mediaplayer-#id) to access its management page. This will open the mediaplayer's configuration page, where you can update the media file, change the nickname, and more.
A Mediaplayer will always have two relevant permalinks, which are only accessible to logged-in admin users:
| Name | URL Rule | Description |
|---|---|---|
| Admin Dashboard Edit Page | https://<your-subdomain>.accesskit.cc/admin/mediaplayer/<id> | The permalink for the Mediaplayer's edit page on the Admin Dashboard. |
| Controls Page | https://<your-subdomain>.accesskit.cc/admin/mediaplayer/<id>/control | The permalink for the Mediaplayer's realtime control page on the Admin Dashboard. |
Form fields
The following fields are available when editing an existing Mediaplayer.
| Field | Type | Optional | Editable | Description |
|---|---|---|---|---|
| ID | number [1+] | No | No | The unique identifier for the mediaplayer. This is automatically generated when the mediaplayer is first created. It is used in all permalinks related to the mediaplayer, e.g. https://<your-subdomain>.accesskit.cc/admin/mediaplayer/<id> will always resolve to this mediaplayer. |
| Serial Number | string | No | No | The serial number for the mediaplayer. This is used to identify the mediaplayer in the Admin Dashboard and is automatically set during registration. |
| Last Known MAC Address | string | No | No | The last known MAC address for the mediaplayer. This is used to identify the mediaplayer and is automatically set during registration. |
| Last Known IP Address | string | No | No | The last known IP address for the mediaplayer. This is used to identify the mediaplayer on the admin dashboard and is automatically set during registration. Clicking it in the Admin Dashboard will open a new tab to the mediaplayer's local network diagnostic page. |
| Last Timestamp | datetime | No | No | The last time the mediaplayer started a playback loop of whatever content it is currently playing. |
| Last Known Duration | number [0+] | No | No | The last known duration of the mediaplayer's current media file. |
| Action Events | link | No | No | A link to the event timeline for the mediaplayer which can be used to configure the mediaplayer as a controller of other devices. |
| Nickname | string | Yes | Yes | The nickname for the mediaplayer. This is used to identify the mediaplayer in the Admin Dashboard. |
| Linked Work | enum/dropdown | Yes | Yes | A link to the Work that the mediaplayer is assigned to provide synchronization for. |
| Synchronize Linked Work to this Player | boolean | No | Yes | If checked, the linked Work will be synchronized to the start of media playback loops on this player. For single-channel works, this box should always be checked. For multi-channel works, this box should be checked on the sync group leader, and unchecked on the followers. |
| Remote Video URL | string [url] | Yes | Yes | A link to a .mov or .mp4 resource on the internet. This field should be a link to the raw media file. If using Dropbox, copy the share link, but replace dl=0 with raw=1 at the end of the link. See the remote content updating guide for more information. |
| New Content Available | boolean | Yes | Yes | If checked, the mediaplayer will automatically download the media file from the Remote Video URL immediately if it is currently playing, or the next time it powers on. |
| Multi-channel Sync Mode | enum [solo, leader, follower] | No | Yes | If the mediaplayer is part of a multi-channel sync group, use the dropdown menu to change from solo to leader or follower. Each multi-channel sync group should have one leader which will provide the start trigger to all of the other mediaplayers. These other mediaplayers should be configured as followers. By default, all mediaplayers assigned to the same work are placed into the same sync group. See the multi-channel synchronization guide for more information. |
| Volume | number [0-100] | Yes | Yes | The volume for the mediaplayer. This is a number between 0 (minimum volume) and 100 (maximum volume). It can also be adjusted via the realtime controls page. |
| Quiet Mode | number [0-2] | Yes | Yes | If checked, the mediaplayer will be set to a quieter volume level as a proportion of the original volume setting. This is especially useful for temporarily setting a BrightSign or Mediaplayer to a quieter level for accessible neurodivergent hours or a social gathering. Quiet Mode can also be activated at an exhibition-wide level from the Exhibition management page. See the quiet mode guide for more information. |
Remember to click Update Mediaplayer to commit your changes.
The following advanced fields are also available. Genereally, you should not need to alter any of these settings, and should do so only after first consulting with the AccessKit team.
| Field | Type | Optional | Editable | Description |
|---|---|---|---|---|
| Poll for Code Injection | boolean | No | Yes | If checked, the mediaplayer will respond to real-time controls issued from the control page for the Mediaplayer or Work. In general, this should never be disabled. |
| Poll for Config Changes | boolean | No | Yes | If checked, the mediaplayer will automatically receive any configuration changes from the Mediaplayer's management page. In general, this should never be disabled. If it is disabled, the Mediaplayer will only be able to receive configuration changes (including re-enabling this option) when it boot cycles. |
| Command Port | number [0-9999] | Yes | Yes | Port number used for UDP communication betwen players on the local network. |
| Update Web Timestamps | boolean | Yes | Yes | This field controls whether or not the player submits timestamps to AccessKit. It should be set to true in virtually all circumstances. |
| Captioning Synchronization Server | string [url] | Yes | Yes | The URL of the captioning synchronization server. This should be set to the URL of the AccessKit server, e.g. https://yourmuseum.accesskit.cc. |
| Firmware URL | string [url] | Yes | Yes | The URL of the firmware file for the mediaplayer. |
| Startup Leader Delay | number [ms] | Yes | Yes | The leader Mediaplayer in a sync group will wait this amount of time when first powering on to ensure that all followers have finished booting up before the first loop is triggered. |
| Loop Point Leader Delay | number [ms] | Yes | Yes | The leader Mediaplayer in a sync group will wait this amount of time when between loops to ensure that all followers have completed arming media before the next loop is triggered. |
| Video Filepath on Removable Drive | string | Yes | Yes | The filepath of the video file to play on the mediaplayer's SD card. If multiple files are on the SD card, then use this to set which file to play. |