Tagged Playlists Entity (2022/06)
0 min
All Tagged Playlist entities are structured as follows:
entity:
- Id int read-only: A unique identifier for the tagged playlist instance. This value is generated by the server when the tagged playlist is created.
- Name string read-write: The name of the tagged playlist. The maximum length of this string is 50 characters.
- PhysicalPath string read-only: The location of the file in the server directory
- ContentsVirtualPath string read-write: The virtual directory location of files in the tagged playlist. Tagged playlists can only use files contained in this directory.
- Rule string read-write: A set of tagging conditions that determines tagged media to include in the playlist.
- TTL TimeSpan read-write: The frequency with which players will query BSN.Cloud servers to determine if there is any new tagged media to include/exclude in the tagged playlist (TTL is an acronym for time to live). See TimeSpan for more information about this data type.
- WaitingForApprove bool read-write: A flag that determines whether recent changes to media tags have been approved for the tagged playlist. By default, changing media tags will not automatically add or remove media from a tagged playlist. A user with the "Update Tagged Playlist" permission (Administrators, Creators, General Managers) will need to set this flag to false for changes to go into effect.
- CreationDate DateTime read-only: A timestamp indicating when the tagged playlist was created on BSN.Cloud. See DateTime for more information about this data type.
- LastModifiedDate DateTime read-only: A timestamp indicating when the tagged playlist was last modified on BSN.Cloud. See DateTime for more information about this data type.
- Content TaggedPlaylistContent[] read-write: An array of content object instances representing content files in the tagged playlist:
- ContentId int read-write: The unique identifier for the tagged playlist content
- FileName string read-write: The filename of the tagged playlist content
- DisplayDuration Nullable<TimeSpan> read-write: The amount of time the content will be displayed before transitioning to the next entry (the default is six seconds). 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 tagged playlist). A null value specifies that the item is valid immediately when added to the tagged playlist. 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 tagged playlist). A null value specifies that the item will be valid until it is removed from the tagged playlist manually. See DateTime for more information about this data type.
- State TaggedPlaylistContentState read-write: The content state enumeration has three possible values: "Approved", "Pending Addition", and "Pending Deletion".
- Presentations PresentationInfo[] read-only: An array of Presentation Info entities for each presentation associated with the tagged playlist instance
- Permissions Permission[] read-write: A list of permission object instances representing permissions rules assigned to the tagged playlist