Advanced link options

Various presenter settings can be controller by editing the links you share.

info

To help you quickly build custom links for multiple presenters, download our link builder spreadsheet utility for Google Sheets.

If you'd like to build your own solution, or just need a couple of links, full details are below.

A sample link looks like:

https://app.octocue.com/clicker
?code=a1b2c
&name=Jo+Bloggs
&view=justButtons
&notesSize=20
&wakelockprompt=0

Options available are:

  • code=a1b2c Required. This is your show code, and links this presenter to your show. It's always alpha-numeric, 5- (or 36-) characters, and is not case sensitive.

  • name=Jo+BloggsOptional. This will pre-set the presenter name (Jo Bloggs), so your end user will not need to add this themselves.
    If this parameter is omitted, the clicker will prompt the user to enter a name, or use an existing name if one is stored on the user's device.

    note

    Names need to be URL-encoded; in our example, the whitespace between Jo and Bloggs has been replaced with +. Online tools such as https://www.urlencoder.org/ can help with this process, or use our link builder spreadsheet utility

  • screentimeoutprompt=0 Depreciated - do not use in new deployments

  • view=justButtons Optional. Sets the default view the presenter will see.
    Options are:
    justButtons - the default button-only page
    buttonsAndNotes - start on the combined notes/buttons page
    Note that this field is case-sensitive.

  • notesSize=20 Optional. Pre-sets the size of the notes text (in px). The default is c. 16px.

  • wakelockprompt=0 Optional. Hides the
    Stop device sleeping while using OctoCue? - Yes please / Cancel
    message shown at the bottom of the clicker page on load. If this bar is hidden, presenters will need to use the menu options to set the wakelock - it is not set on by default due to technical limitations.

    note

    Only works in-browser - wakelock is always active when using the app.

  • invite=0 - Optional. Skip the invite system and go straight to a browser clicker. See this news article for details of how the invite system works.

  • logo=[URL] - Optional. Replace the OctoCue header logo with your own. Logos should be transparent PNG files, 160x40px and hosted at a https:// address. Addresses should be URL-encoded.
    Example: https%3A%2F%2Foctocue.com%2Fimg%2Ffix8logo_sample.png

    caution

    The logo-replacement feature is experimental. Use at your own risk!

Using advanced options with permalinks#

All of the options listed above can be used with permalinks, but you'll need to omit the code=xxxxx variable, as this is auto-populated for you by the permalink system.

A sample permalink (with ID: TestLink) would look like:

https://app.octocue.com/permalink/TestLink?name=Jo%20Bloggs&screentimeoutprompt=0&view=justButtons&notesSize=20