AccessKitWork
Reference for AccessKit Work entities.
What is a Work?
A Work is a piece of media (possibly with multiple video channels) that is displayed in an Exhibition.
It can be a video piece, audio piece, or even a 3D object which has audio associated with it!
Works typically have a single caption track (though possibly with multiple languages) and possibly an audio track or Audio Description track.
Guests can access synchronized versions of the captions and audio tracks from the gallery via the Guest View for that Work, which they typically access via a QR code or direct link.
If no synchronization mediaplayer is connected to the Work, then guests will see any uploaded captions in a static transcript format rather than as synchronized captions.
Finding a Work
A Work can be found in the Admin Dashboard in the list of Exhibitions underneath the Exhibition it is assigned to.
Click the [edit] button next to the Work you would like to edit to access its management page, or click on its name to access the Work's public-facing guest view.
A Work will always have two relevant permalinks:
| Name | URL Rule | Description |
|---|---|---|
| Guest View Permalink | https://<your-subdomain>.accesskit.cc/work/<id> | The permalink for the work on the public-facing guest web application. |
| Admin Dashboard Edit Page | https://<your-subdomain>.accesskit.cc/admin/work/<id> | The permalink for the Work's edit page on the admin dashboard. |
Form fields
The following fields are available when creating a new Work or editing an existing Work.
| Field | Type | Optional | Editable | Description |
|---|---|---|---|---|
| Title | string, rich text | No | Yes | The title of the work. Displays on the public-facing guest view and can be styled with italics, bold, and underline, e.g. Bruce Nauman: Dancing or Exercise on the Perimeter of a Square (1968). |
| Exhibition | enum/dropdown | Yes | Yes | The Exhibition that the work is assigned to. |
| Add additional captions | button | Yes | Yes | Click this button to add a new SRT caption file to the work. |
| SRT Caption File | button/file/string | Yes | Yes | The .srt file for the work which will provided captions for synchronized content on an AccessKit mediaplayer. See the guide on adding captions for more help. |
| SRT Language Display Code | string | No | Yes | The language code for the caption file (e.g. EN-US). This will be displayed in the language selector menu on the work's Guest View if multiple languages are available. |
| SRT Language Descriptor (Long) | string | No | Yes | The full language name for the caption file (e.g. English). |
| Automatic Translation Languages | enum/dropdown | Yes | Yes | The languages to automatically translate captions to. Multiple languages can be selected using ctrl-/cmd- or shift-clicking. The first caption track in the list of uploaded captions will be used as the source. See the multilingual content guide for more information. |
| Audio Track | button/file | Yes | Yes | The .mp3 file for the work which will provided audio for synchronized content on an AccessKit mediaplayer. This can be the direct audio, a dub, or Audio Description. |
| Audio Track Type | enum [Audio Track, Audio Description] | No | Yes | The type of audio track. This will determine what icon appears in the audio player on the work's Guest View. |
| Duration | number, ms [0.0+] | Yes | Yes | The duration of the work in milliseconds. This will be automatically set when a mediaplayer is assigned to this work and begins synchronizing, and generally can be left blank until then. |
| Looping Work | boolean | Yes | Yes | For works that will be presented at a specific time, uncheck this box to prevent the captions and audio from looping in the guests' web application. |
| Published? | boolean | No | Yes | Whether the work is published. When false, the work is not visible to the public in the public-facing guest web application. |
Remember to click Update Exhibition 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 |
|---|---|---|---|---|
| Nudge | number, ms | Yes | Yes | Some mediaplayers need a default latency adjustment based off of their sync method. Use this field to move the captions/audio forward or backward if needed. |
| Dilation | number, ratio | Yes | Yes | Some mediaplayers, like 16mm projectors or audio cassettes, may not run at a constant speed, or may run faster/slower than advertised. Use this field to scale the captions playback accordingly. |
| Backlink URL | string [url] | Yes | Yes | A link to a page on your institutional website that will be opened when the Back button is clicked on the work's Guest View. |
| Alternative Audio URL | string [url] | Yes | Yes | This field represents a template link for the pre-chunked audio files corresponding to your Work. You should never need to populate this field. It will be populated automatically from your audio file upload. |
Records
The following records are available for Works.
| Record | Description |
|---|---|
Guest View Permalink | The permalink for the work on the public-facing guest web application. |
QR Code | A QR code for the work. This can be used to link to the work on a mobile device. |