Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

All dynamic playlist entities are structured as follows:

entity:

  • [int] Id: A unique identifier for the dynamic playlist instance. This value is generated by the server when the dynamic playlist is created.
  • [string] Name:  The name of the dynamic playlist

  • [string] PhysicalPath: The location of the dynamic playlist feed XML file in the server directory

  • [long] FileSize: The size of the dynamic playlist feed XML file (in bytes)

  • [string] FileHash: The hash algorithm and the value that results from performing the hash algorithm on the file. The string is formatted as "{algorithm}:{value}" (e.g. "SHA1:6DB465879088280AAC52DC22B07ED0AD493A99D4")

  • [DateTime] CreationDate: A UTC timestamp indicating when the dynamic playlist was created on BSN.cloud. See Custom Data TypesDateTime for more information on this data type.

  • [DateTime] LastModifiedDate: A UTC timestamp indicating when the dynamic playlist was last modified on BSN.cloud. See Custom Data TypesDateTime for more information on this data type.

  • [bool] SupportsAudio A flag indicating whether the dynamic playlist supports audio files

  • [bool] SupportsVideo: A flag indicating whether the dynamic playlist supports video files

  • [bool] SupportsImages: A flag indicating whether the dynamic playlist supports image files

  • [DynamicPlaylistContent[]] Content: An array of content object instances representing content files in the dynamic playlist: 

    • [int] ContentId: The unique identifier for the dynamic playlist content

    • [string] FileName: The name assigned to the dynamic playlist content

    • [TimeSpan] DisplayDurationThe amount of time the content will be displayed before transitioning to the next entry. See TimeSpan for more information about this data type.

    • [DateTime?] ValidityStartDateThe validity start date for the entry (that is, the point at which it will start being included in the dynamic playlist). A null value specifies that the item is valid immediately when added to the dynamic playlist. See DateTime for more information about this data type.

    • [int] Id:  A unique identifier for the file. 
    • [string] Name: The filename
    • [Uri] Link:  The path to the file URI

      [DateTime?] ValidityEndDate

    [PresentationInfo[]] Presentations: An array of presentation object instances representing presentations that use the dynamic playlist:

    • The validity end date for the associated entry (that is, the point at which it will no longer be included in the dynamic playlist).  A null value specifies that the item will be valid until it is removed from the dynamic playlist manually by a user. See DateTime for more information about this data type.

  • [PresentationInfo[]] Presentations: An array of Presentation Info entities for each presentation associated with the dynamic playlist instance

  • [List<Permission>] Permissions: A list of permission object instances representing permissions rules assigned to the dynamic playlist instance