Dynamic Playlist APIs

Owned by BrightSign TechDocs
Last updated: Jun 28, 2023
9 min read

 

ImageVideoDynamicPlaylist Entity

The ImageVideoDynamicPlaylist entity represents a Dynamic Playlist containing image or video files only. It has the following properties.

  • Id int:(read only) The identifier and primary key of the ImageVideoDynamicPlaylist instance.

  • Name string: The user-defined name of the ImageVideoDynamicPlaylist instance. This string value is an alternate key that is unique in the scope of the BrightSign Network account.

  • PhysicalPath string:(read only) The external URL of the Dynamic Playlist MRSS file in persistent storage.

  • FileSize long:(read only) The size of the associated MRSS file in bytes.

  • FileHash string:(read only) The SHA1 hash of the associated MRSS file contents.

  • CreationDate DateTime: (read only) The UTC timestamp indicating when the current ImageVideoDynamicPlaylist instance was created in the BrightSign Network.

  • Content List<DynamicPlaylistContent>: A list of DynamicPlaylistContent entity-relations that reference content instances contained within the Dynamic Playlist. This list is set to Null when not initialized by the server.

  • Presentations PresentationInfo[]:(read only) An array of PresentationInfo structures that denote parent presentations.

AudioDynamicPlaylist Entity

The AudioDynamicPlaylist entity represents a Dynamic Playlist containing audio files only. It has the following properties:

  • Id int:(read only) The identifier and primary key of the AudioDynamicPlaylist instance.

  • Name string: The user-defined name of the AudioDynamicPlaylist instance. This string value is an alternate key that is unique in the scope of the BrightSign Network account.

  • PhysicalPath string:(read only) The external URL of the Dynamic Playlist MRSS file in persistent storage.

  • FileSize long: (read only) The size of the associated MRSS file in bytes.

  • FileHash string:(read only) The SHA1 hash of the associated MRSS file contents.

  • CreationDate DateTime:(read only) The UTC timestamp indicating when the current AudioDynamicPlaylist instance was created in the BrightSign Network.

  • Content List<DynamicPlaylistContent>: A list of DynamicPlaylistContent entity-relations that reference content instances contained within the Dynamic Playlist. This list is set to Null when not initialized by the server.

  • Presentations PresentationInfo[]:(read only) An array of PresentationInfo structures that denote parent presentations.

Dynamic Playlist Management Web Methods

PagedList<DynamicPlaylist> GetDynamicPlaylists(string marker, int pageSize)

Retrieves the next page of the Dynamic Playlist list, sorted alphabetically by Name string. AudioDynamicPlaylist and/or ImageVideoDynamicPlaylist instances are sorted alphabetically by Name string. The returned list will contain no more items than the defined page size.

Required Permissions

Dynamic Playlist: View Dynamic Playlists

Parameters

  • marker string: The Name string of the last instance on the previous page. If the value is Null, then the method will retrieve the first page.

  • pageSize int: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds the pageSize int limit, the returned list will indicate that it is truncated. If the integer is not positive, then the method will return the maximum allowed number of objects. Attempting to request more objects than is allowed will lead to the same result, but without an error.

PagedList<ImageVideoDynamicPlaylist> GetImageVideoDynamicPlaylists(string marker, int pageSize)

Retrieves the next page of the Dynamic Playlist list, sorted alphabetically by Name string. The ImageVideoDynamicPlaylist instances are sorted alphabetically by Name string. The returned list will contain no more items than the defined page size.

Required Permissions

Dynamic Playlist: View Dynamic Playlists

Parameters

  • marker string: The Name string of the last ImageVideoDynamicPlaylist instance on the previous page. If the value is Null, then the method will retrieve the first page.

  • pageSize int: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds the pageSize int limit, the returned list will indicate that it is truncated. If the integer is not positive, then the method will return the maximum allowed number of objects. Attempting to request more objects than is allowed will lead to the same result, but without an error.

PagedList<AudioDynamicPlaylist> GetAudioDynamicPlaylists(string marker, int pageSize)

Retrieves the next page of the Dynamic Playlist list, sorted alphabetically by Name string. AudioDynamicPlaylist instances are sorted alphabetically by Name string. The returned list will contain no more items than the defined page size.

Required Permissions

Dynamic Playlist: View Dynamic Playlists

Parameters

  • marker string: The Name string of the last AudioDynamicPlaylist instance on the previous page. If the value is Null, then the method will retrieve the first page.

  • pageSize int: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds the pageSize int limit, the returned list will indicate that it is truncated. If the integer is not positive, then the method will return the maximum allowed number of objects. Attempting to request more objects than is allowed will lead to the same result, but without an error.

List<DynamicPlaylist> GetSpecifiedDynamicPlaylists(int[] dynamicPlaylistIds)

Retrieves a list of ImageVideoDynamicPlaylist and/or AudioDynamicPlaylist instances matching the specified identifiers. Instances are sorted alphabetically by Name string. The identifiers of nonexistent instances will be ignored.

Required Permissions

Dynamic Playlist: View Dynamic Playlists

Parameters

  • dynamicPlaylistIds int[]: An array of Id int values for the instances being requested. The maximum number of items is limited to 100 by the server. Attempting to request more than the maximum allowed number of objects will cause an error, while passing an empty array will lead to an immediate empty response without an error.

PagedList<DynamicPlaylist> FindDynamicPlaylists(string namePattern, string marker, int pageSize)

Retrieves the next page of a Dynamic Playlist list containing names matched with the specified pattern. The returned list is organized alphabetically by Name string and may not contain more items than the defined page size. This method retrieves both ImageVideoDynamicPlaylist and AudioDynamicPlaylist instances; these instances can be differentiated by data type.

Required Permissions

Dynamic Playlists: View Dynamic Playlists

Parameters

  • namePattern string: The exact Name string of the ImageVideoDynamicPlaylist or AudioDynamicPlaylist instance (or its wildcard-based pattern). Supported wildcards currently include “*”, “?”, and “[‘and’]”.

  • marker string: The Name string of the last instance on the previous page. If the value is Null, then the method will retrieve the first page.

  • pageSize int: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds the pageSize int limit, the returned list will indicate that it is truncated. If the integer is not positive, then the method will return the maximum allowed number of objects. Attempting to request more objects than is allowed will lead to the same result, but without an error.

PagedList<ImageVideoDynamicPlaylist> FindImageVideoDynamicPlaylists(string namePattern, string marker, int pageSize)

Retrieves the next page of an ImageVideoDynamicPlaylist instance list containing names matched with the specified pattern. The returned list is organized alphabetically by Name string and may not contain more items than the defined page size.

Required Permissions

Dynamic Playlists: View Dynamic Playlists

Parameters

  • namePattern string: The exact Name string of the ImageVideoDynamicPlaylist instance (or its wildcard-based pattern). Supported wildcards currently include “*”, “?”, and “[‘and’]”.

  • marker string: The Name string of the last instance on the previous page. If the value is Null, then the method will retrieve the first page.

  • pageSize int: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds the pageSize int limit, the returned list will indicate that it is truncated. If the integer is not positive, then the method will return the maximum allowed number of objects. Attempting to request more objects than is allowed will lead to the same result, but without an error.

PagedList<AudioDynamicPlaylist> FindAudioDynamicPlaylists(string namePattern, string marker, int pageSize)

Retrieves the next page of an AudioDynamicPlaylist instance list containing names matched with the specified pattern. The returned list is organized alphabetically by Name string and may not contain more items than the defined page size.

Required Permissions

Dynamic Playlists: View Dynamic Playlists

Parameters

  • namePattern string: The exact Name string of the AudioDynamicPlaylist instance (or its wildcard-based pattern). Supported wildcards currently include “*”, “?”, and “[‘and’]”.

  • marker string: The Name string of the last instance on the previous page. If the value is Null, then the method will retrieve the first page.

  • pageSize int: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds the pageSize int limit, the returned list will indicate that it is truncated. If the integer is not positive, then the method will return the maximum allowed number of objects. Attempting to request more objects than is allowed will lead to the same result, but without an error.

DynamicPlaylist GetDynamicPlaylist(int dynamicPlaylistId, bool loadContent)

Retrieves a single ImageVideoDynamicPlaylist or AudioDynamicPlaylist instance with the specified identifier. This method returns Null if the instance with the specified identifier does not exist.

Required Permissions

Dynamic Playlist: View Dynamic Playlists, View Content – Content: View Content

Parameters

  • dynamicPlaylistId int: The identifier and primary key of the requested instance.

  • loadContent bool: A flag that specifies whether the method should also initialize and return a list of all Content instances in use by the requested Dynamic Playlist.

If the Dynamic Playlist was created using a legacy version of BrightAuthor, the [int] DisplayDuration of image files may be returned set to 0.

DynamicPlaylist GetDynamicPlaylistByName(string name, bool loadContent)

Retrieves a single ImageVideoDynamicPlaylist or AudioDynamicPlaylist instance with the specified name. This method returns Null if the instance with the specified name does not exist.

Required Permissions

Dynamic Playlist: View Dynamic Playlists, View Content – Content: View Content

Parameters

  • name string: The user-defined name (and alternate key) of the instance.

  • loadContent bool: A flag that specifies whether the method should also initialize and return a list of all Content instances in use by the requested Dynamic Playlist.

If the Dynamic Playlist was created using a legacy version of BrightAuthor, the [int] DisplayDuration of image files may be returned set to 0.

bool CheckDynamicPlaylistName(string name)

Determines if the specified Dynamic Playlist name is in use within the BrightSign Network account. If there is a Dynamic Playlist with the specified name, this method will return True. Otherwise, it will return False.

Note that when using this method to check whether a Dynamic Playlist instance can be created, a False status may change in the time between calling this method and calling CreateDynamicPlaylist().

Required Permissions

Dynamic Playlist: View Dynamic Playlists

Parameters

  • name string: The Dynamic Playlist name value to be evaluated.

bool CheckDynamicPlaylistUsage(int dynamicPlaylistId)

Determines if the ImageVideoDynamicPlaylist or AudioDynamicPlaylist instance (specified with its primary key) is referenced by one or more presentations. If the specified instance has parent dependencies (i.e. it is in use), this method will return True. Otherwise, it will return False.

Note that when using this method to check whether a instance can be deleted, a False (“not in use”) status may change in the time between calling this method and calling DeleteDynamicPlaylist().

Required Permissions

Dynamic Playlist: View Dynamic Playlists

Parameters

  • dynamicPlaylistId int: The identifier and primary key of the ImageVideoDynamicPlaylist or AudioDynamicPlaylist instance to be evaluated. If an instance with the specified identifier does not exist, the method will return False without error.

bool CheckDynamicPlaylistUsageByName(string name)

Determines if the ImageVideoDynamicPlaylist or AudioDynamicPlaylist instance (specified with its alternate, user-defined key) is referenced by one or more presentations. If the specified instance has parent dependencies (i.e. it is in use), this method will return True. Otherwise, it will return False.

Note that when using this method to check whether an instance can be deleted, a False (“not in use”) status may change in the time between calling this method and calling DeleteDynamicPlaylist().

Required Permissions

Dynamic Playlist: View Dynamic Playlists

Parameters

  • name string: The user-defined name (i.e. the alternate key) of the Dynamic Playlist to be evaluated. If an instance with the specified identifier does not exist, the method will return False without error.

DynamicPlaylist CreateDynamicPlaylist(DynamicPlaylist entity)

Creates a new ImageVideoDynamicPlaylist or AudioDynamicPlaylist instance and a related MRSS file with the specified name and Content entities. This method returns the newly created object with all initialized properties if successful. If object creation is unsuccessful, this method will return a Null value.

Required Permissions

Dynamic Playlist: Create Dynamic Playlist – Content: Assign Content

Parameters

  • entity DynamicPlaylist: An ImageVideoDynamicPlaylist or AudioDynamicPlaylist object instance with initialized Name string and Contents List<DynamicPlaylistContent> properties. All other properties will be ignored during object creation. If this parameter is set to Null, then the method will immediately return Null without error. A descriptive error will be returned to the client if any of the following conditions occur:

    • The name of the Dynamic Playlist is more than 50 characters.

    • The content files do not match the type of Dynamic Playlist instance that has been passed to the method (e.g. an AudioDynamicPlaylist contains image or video files, or vice versa).

    • Another ImageVideoDynamicPlaylist or AudioDynamicPlaylist instance has the same name.

    • The DisplayDuration int of a DynamicPlaylistContent entity-relation is set to less than 1 second. This only applies to entity-relations representing image files.

bool UpdateDynamicPlaylist(DynamicPlaylist entity)

Updates the Name string and Contents List<DynamicPlaylistContent> properties of the specified ImageVideoDynamicPlaylist or AudioDynamicPlaylist instance and its related MRSS file. This method returns True upon success and False upon failure.

Required Permissions

Dynamic Playlist: Update Dynamic Playlist – Content: Assign Content, Unassign Content

Parameters

  • entity DynamicPlaylist: An ImageVideoDynamicPlaylist or AudioDynamicPlaylist object instance with initialized Name string and Contents List<DynamicPlaylistContent> properties. All other properties will be ignored. If the instance is set to Null, then the method will immediately return Null without error. A descriptive error will be returned to the client if any of the following conditions occur:

    • The passed string is more than 50 characters.

    • The passed string does not match a preexisting Dynamic Playlist.

    • The DisplayDuration int of a DynamicPlaylistContent entity-relation is set to less than 1 second. This only applies to entity-relations representing image files.

bool RenameDynamicPlaylist(int dynamicPlaylistId, string newName)

Updates the Name string of the specified ImageVideoDynamicPlaylist or AudioDynamicPlaylist instance. This method returns True upon success and False upon failure.

Required Permissions

Dynamic Playlist: Update Dynamic Playlist, Rename Dynamic Playlist

Parameters

  • dynamicPlaylistId int: The identifier and primary key of the instance. If an instance with the specified identifier does not exist, the method will return False without error.

  • newName string: The new name for the specified instance. A descriptive error will be returned to the client if the passed string is more than 50 characters.

bool DeleteDynamicPlaylists(int[] dynamicPlaylistIds)

Deletes the specified ImageVideoDynamicPlaylist and/or AudioDynamicPlaylist instances from both the database and persistent storage. Related MRSS files are also removed. This method returns True upon success and False upon failure.

Required Permissions

Dynamic Playlist: Delete Dynamic Playlist

Parameters

  • dynamicPlaylistIds int[]: An array of Id int values for the instances to be deleted. The number of items that can be deleted is limited to 100 by the server. Requesting more than the maximum allowed number of objects will cause an error. An error will also be returned if one or more specified Id int value refers to a non-existent ImageVideoDynamicPlaylist or AudioDynamicPlaylist instance. Passing an empty array or Dynamic Playlist identifiers that don’t exist will lead to an immediate empty response without an error.

ON THIS PAGE