Live Media Feed Entity (2022/06)

Owned by BrightSign TechDocs
Last updated: Nov 10, 2023
2 min read

All live media feed entities are structured as follows:

entity:

  • Id int read-only: The unique identifier for the live media feed entity

  • Name string read-write: The name of the live media feed entity. The maximum length for this string is 50 characters.

  • TTL TimeSpan read-write: The frequency with which players will query BSN.cloud servers to determine if there is any new live media to include or exclude in the feed. 

  • PhysicalPath string read-only: The location of the live media feed file in the server directory

  • FileSize long read-only:  The size of the live media feed file (in bytes)

  • FileHash string read-only: The hash value of the live media feed file

  • CreationDate DateTime read-only: A timestamp indicating when the live media feed was created on BSN.cloud. See DateTime for more information about this data type.

  • LastModifiedDate DateTime read-only: A timestamp indicating when the live media feed was last modified on BSN.cloud. See DateTime for more information about this data type.

  • Content LiveMediaFeedContent[] read-write:

    • ContentId int read-write: The unique identifier and primary key of the associated content instance. This value can be set by either the client or the server.

    • FileName string read-only: The file name of the live media feed content

    • Title string read-write: The key (that is, MRSS item title) of the associated media item in the related live media feed

    • Description string read-write: The value (that is, MRSS item description) of the associated media item in the related live media feed

    • Disabled bool read-write: Whether or not the live media feed is disabled

    • DisplayDuration TimeSpan read-write: The amount of time the content will be displayed before transitioning to the next entry. See TimeSpan for more information about this data type.

    • ValidityStartDate Nullable<DateTime> read-write: The validity start date for the entry (that is, the point at which it will start being included in the live media feed). A null value specifies that the item is valid immediately when added to the live media feed. See DateTime for more information about this data type.

    • ValidityEndDate Nullable<DateTime> read-write: The validity end date for the associated entry (that is, the point at which it will no longer be included in the live media feed).  A null value specifies that the item will be valid until it is removed from the live media feed manually by a user. See DateTime for more information about this data type.

    • CustomFields Dictionary<string, string> read-write: An object containing key:value pairs. Each pair corresponds to a custom field associated with the media item in the MRSS file of the related live media feed.

  • Permissions Permission[] read-write: A list of permission object instances representing permissions rules assigned to the live media feed instance

  • Presentations PresentationInfo[] read-only: An array of Presentation Info entities for each presentation associated with the live media feed instance