Tagged Playlist Entity (2017/01)
1 min
All tagged playlist entities are structured as follows:
entity:
- Id int: A unique identifier for the tagged playlist instance. This value is generated by the server when the tagged playlist is created.
- Name string: The name of the tagged playlist
- PhysicalPath string: The location of the file in the server directory
- ContentsVirtualPath string: The virtual directory location of files in the tagged playlist. Tagged playlists can only use files contained in this directory.
- Rule string: A set of tagging conditions that determines tagged media to include in the playlist.
- OrderTag string: Specify a defined tag which can then be used by the playlist to sort the matching content.
- TTL TimeSpan: 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: 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: A timestamp indicating when the tagged playlist was created on BSN.cloud. See DateTime for more information about this data type.
- LastModifiedDate DateTime: A timestamp indicating when the tagged playlist was last modified on BSN.cloud. See DateTime for more information about this data type.
- Content TaggedPlaylistContent[]: An array of content object instances representing content files in the tagged playlist:
- ContentId int: The unique identifier for the tagged playlist content
- FileName string: The filename of the tagged playlist content
- DisplayDuration TimeSpan?: The amount of time the content will be displayed before transitioning to the next entry (the default is six seconds). See TimeSpan or more information about this data type.
- State TaggedPlaylistContentState: The content state enumeration has three possible values: "Approved", "Pending Addition", and "Pending Deletion".
- Presentations PresentationInfo[]: An array of Presentation Info Entity (2017/01) for each presentation associated with the tagged playlist instance
- Permissions List<Permission>: A list of permission object instances representing permissions rules assigned to the tagged playlist