Viz Social User Guide

Version 1.1 | Published January 26, 2022 ©

Standard Field Identifiers

Most of the content of the messages in a Viz Social feed can be accessed from the scene designs using the following standard field identifiers:

  • id: The Atom ID of the message.

  • author: The name of the message author: for example, the username of the person who posted the original message on Twitter, Facebook etc.

  • thumbnail: An image associated with the message. Depending on the source of the message, it may either contain a picture of the author or a picture related to the subject of the message. You need to put an image in the container and also set the image location prefix in the image control plug-in.

  • title: The message content.

  • summary: Some messages may include additional content in this field. Some RSS and Facebook items, for example, may include content in this field.

  • contributor: The name of the message’s source service/network. For example Facebook, Twitter or RSS.

  • image_url: The URL or path to image files that are part of the message.

  • video_url: The URL or path to video files that are part of the message.

  • audio_url: The URL or path to audio files that are part of the message.

  • media_type: The media item (e.g. video or image) if a message contains media.

  • enclosure: This field can contain a URL to an external website, or the URL or path to files that are part of the message but which are NOT image, video or audio files.

  • content: Some messages may contain extra non-standard information in this field, packed into a VDF payload document. For more about this, see Accessing VDF Payload Data.

  • geolocation: Some messages may include geolocation data. The format is on latitude and longitude.

  • feed: When moderating a source in Live Playout mode, always populate the ‘feed’ with the name of the current source. When moderating a group in Live Playout, populate the ‘feed’ with the name of the current group in the right-hand panel, and populate the ‘feed’ with the names of all sources this message belongs to, separating the source names with a comma.

    Note: In general, designers should have a basic knowledge of the feed type they are designing scenes for, in order to decide which are the relevant fields for the desired scene.