Skip to main content

Queue

This plugin is a list of videos (external media URLs) that users can add to in-game and it will play them in sequence. This plugin is NOT for pre-made lists of URLs. For that, please refer to the Playlist Guide Docs.

Getting Started​

ProTV comes with a pre-made setup for the Queue plugin. This can be found in the Packages/ArchiTech.ProTV/Samples/Prefabs/Plugins folder. Just drag the Queue prefab into the scene and assign your desired TV to it. You can adjust various aspects of the queue as desired.

Inspector​

TV References​

  • TV
    The instance of ProTV that this component will interact with and send media to. You will need to insert the desired TV reference (the game object with the TVManager script on it), or if you are using a ready-made prefab, it should already be connected.

General Settings​

  • Max Queue Length
    The total maximum number of entries allowed for the queue. Switch inspector to debug mode to increase the limit past the slider's range (not recommended).

  • Prevent Duplicate Media
    Disallow the a url to be added to the list when it is already present in another entry.

  • Allow Adding While Locked
    If enabled and the TV is locked, unauthorized users will still be able to add to the Queue, but cannot modify or manipulate entries.

  • Allow Entry Selection by Anyone
    If enabled, it will allow any un-authorized users to switch to other entries.

  • Show URLs in Queue
    Whether to allow the URLs to be visible in the Queue entries.

  • Loop Queue
    Will make the Queue continue playing from the start of the list once the end has been reached. Only matters when some videos are persisted.

Per-User Settings​

  • Max Added Entries Per-User
    Number of entries a single user can have in the Queue at any given point in time. To add more, one of their own entries must be cleared either by the queue's natural pruning or by manual removal. Authorized users ignore this limit. Set to 0 to prevent unauthorized users from adding to the Queue.

  • Burst Entries Per-User
    Number of entries a single user can add to the Queue within a rolling period of time (see Burst Entries Timeout). Effectively an anti-spam measure to 'give everyone a turn'. 0 = feature disabled. Authorized users ignore this limit.

  • Burst Entries Timeout
    How long (in seconds) a single user has to wait to add entries after being throttled for hitting the Max Burst Entries threshold.

QueueUI Inspector​

The Queue has a separate component which handles the UI display logic. This allows you to hook up multiple physical displays of the Queue data in the world with them all being linked together properly.

TV References​

  • Queue
    The instance of Queue that this component will display data for and interact with.

UI References​

There is two template references, one is the container, the other is the actual template itself. These come with default references out of the box in the prebuilt plugin prefabs. Have a look at the Playlist Template Section for more information on how it works.
Specific call-outs here are the following:

  • Entry Select
    This button will send the switch entry command to the attached queue.
  • Entry Remove
    This button will tell the Queue to remove the connected entry.
  • Persist Entry
    This button will tell the Queue to keep the entry even when the entry has completed playing. Normally completed media is auto-removed. Lastly:
  • Info Notification
    This is a simple text component that displays pertinent information about any errors the Queue encounters.