| Panel | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
ON THIS PAGE
|
...
[int] Id:(read only) The identifier and primary key of the Content entity.[string] FileName: The virtual name of the file represented by the current Content instance. This string may differ from the file name on the client device before being uploaded. This property can be set by both client and server, and is used in many capacities both within BSN and on devices.[string] PhysicalPath:(read only) An external URL for the associated file contained in persistent storage.[string] VirtualPath: A virtual path to the associated file within the Library of the BSN account.[ContentType] Type:(read only) The simplified content type of the associated file. This property is represented with a ContentType enumeration value.[long] FileSize:(read only) The size of the associated file in bytes.[string] FileHash:(read only) The SHA1 hash of the associated file.[string] ThumbPath:(read only) An external URL for the file thumbnail image contained in persistent storage.[DateTime] UploadDate:(read only) A UTC timestamp indicating when the associated file was uploaded to BSN.[DateTime] FileLastModifiedDate: A value representing the last time the associated file was modified on the user storage (e.g. the "Date modified" value in Windows). This property is set during the content upload process. It can also be set by the client or server at any time.[DynamicPlaylistInfo[]]DynamicPlaylists: (read only) An array of DynamicPlaylistInfo structures that denote parent Dynamic Playlists.[PresentationInfo[]] Presentations: (read only) An array of PresentationInfo structures that denote parent presentations.
...
The DynamicPlaylistContent entity-relation represents associations between Content and ImageVideoDynamicPlaylist or AudioDynamicPlaylist instances. It has the following properties:
...
The PresentationContent entity-relation represents the association between Content and Presentation instances. It has the following properties:
[int] Id: (Read Only) The identifier and primary key of the PresentationContent entity-relation.[string] Name: The user-defined name of the related Presentation item. This value can represent the name of a content file, feed, Video Stream, Live Video, or RF In object. When the entity-relation represents the relationship between a Presentation instance and a Content instance, this property contains the virtual name of the content file. Alternatively, when the entity-relation represents the relationship between a Presentation instance and a ImageVideoDynamicPlaylist/AudioDynamicPlaylist instance, this property contains the[string] Nameof the Dynamic Playlist.[string] StateName: The name of the playlist state that corresponds to the associated Content instance. This value is optional.
...
The ImageContent entity-relation represents the association between a Presentation instance and an image Content instance.
[int] ContentId: The identifier and primary key of the associated Content instance.[TimeSpan] DisplayDuration: The amount of time that the device displays the associated image.[ContentTransition] Transition: A ContentTransition enumeration representing the screen effect that is shown during the transition between the previous presentation state and the current content state (i.e. the associated content state).
...
The BackgroundImageContent entity-relation represents the association between a Presentation instance and an image Content instance.
[int] ContentId: The identifier and primary key of the associated Content instance.
...
The VideoContent entity-relation represents the association between a Presentation instance and a video Content instance.
[int] ContentId: The identifier and primary key of the associated Content instance.[byte] Volume: The volume level of the video as a percentage.
...
The AudioContent entity-relation represents the association between a Presentation instance and an audio Content instance.
[int] ContentId: The identifier and primary key of the associated Content instance.[byte] Volume: The volume level of the audio track as a percentage.
...
The MediaRssFeedContent entity-relation represents the association between a Presentation instance and a DynamicPlaylist instance.
[int] DynamicPlaylistId: The identifier and primary key of the associated DynamicPlaylist instance.
...
The WebPageContent entity-relation represents the association between a Presentation instance and a WebPage instance.
[int] WebPageId: The identifier and primary key of the associated WebPage instance.[TimeSpan] DisplayDuration: The amount of time that the player will display the page. A zero value specifies an unlimited playback interval.
...
The VideoStreamContent entity-relation represents the association between a Presentation instance and a streaming video object.
...
The LiveVideoContent entity-relation represents the association between a Presentation instance and an HDMI-input object.
...
The RadioInputContent entity-relation represents the association between a Presentation instance and an RF-input object.
[RadioChannel] Channel: A VirtualRadioChannel or CustomRadioChannel structure specifying the channel-tuning settings for the RF-input object.[RadioStateReentryAction] ReentryAction: A RadioStateReentryAction enumeration specifying how the RF tuner should behave when the player returns to the RF-input object.[TimeSpan] PlaybackDuration: The amount of time the player will play video from the RF-input. A zero value specifies an unlimited playback interval.[byte] Volume: The volume level of the RF-input video as a percentage.[bool] Overscan: A flag specifying whether or not overscan settings should be applied to the RF-input video.
...
The DynamicPlaylistInfo structure provides information about a parent ImageVideoDynamicPlaylist or AudioDynamicPlaylist instance. It has the following properties:
...
The PresentationInfo structure provides information about a parent Presentation instance. It has the following properties:
...
PagedList<Content> GetAllContent(string marker, int pageSize)
Retrieves the next page of the Content list, sorted alphabetically by [string] FileName. The returned list will contain no more items than the defined page size. This method only supports retrieval of image, audio, and video file types.
Required Permissions
Content: View Content
...
[string] marker: The[string] FileNameof the last Content instance on the previous page. If the value is Null, then the method will retrieve the first page.[int] pageSize: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds the[int] pageSizelimit, 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.
...
Retrieves all levels of subfolders that are part of the parent ContentFolder entity, which is specified using its virtual path. The returned list will contain no more items than the defined page size.
...
Retrieves the first level of files within the parent ContentFolder entity, which is specified using its virtual path. The returned list is organized by File Name and may not contain more items than the defined page size. This method only supports retrieval of image, audio, and video file types.
...
[string] virtualPath: The virtual path of the parent ContentFolder entity. The root virtual path is “\”.[string] marker: The[string] FileNameof the last Content instance on the previous page. If the value is Null, then the method will retrieve the first page.[int] pageSize: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds the[int] pageSizelimit, 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<Content> GetSpecifiedContent(int[] contentIds)
Retrieves a list of Content instances matching the specified identifiers. The results are sorted alphabetically by Content [string] FileName. The identifiers of nonexistent Content instances will be ignored.
...
Retrieves the next page of a Content list containing file names matched with the specified pattern. The returned list is organized by [string] FileName and may not contain more items than the defined page size. This method only supports retrieval of image, audio, and video file types.
...
[string] fileNamePattern: The exact[string] FileNameof the Content instance (or its wildcard-based pattern). Supported wildcards currently include “*”, “?”, and “[‘and’]”.[string] marker: The[string] FileNameof the last Content instance on the previous page.[int] pageSize: The maximum number of objects returned by the method. If the list of objects that match the search criteria exceeds the[int] pageSizelimit, 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.
Content GetContent(int contentId)
Retrieves a single Content instance with the specified identifier. This method returns Null if there are no Content instances containing the specified identifier. This method only supports retrieval of image, audio, and video file types.
...
[ContentFolder] entity: A ContentFolder instance with an initialized[string] Name,[string] VirtualPath, and[string] ThumbPath(if needed). All other property values for the ContentFolder instance will be ignored. 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
[string] VirtualPathof the initialized ContentFolder does not contain a leading slash(“\”). - The
[string] ThumbPathdoes not begin with an absolute URI (i.e. “http://” or “https://”). - The
[string] Nameof the initialized ContentFolder is more than 128 characters. - A ContentFolder instance within the same parent folder has the same name.
- The
bool MoveContent(int[] contentIds, string newVirtualPath)
Moves the specified Content and/or ContentFolder instances to the specified virtual folder. This method returns True upon success and False upon failure.
...
Determines whether the specified Content instance is referenced by Presentations, Dynamic Playlists, Web Pages, or Device Web Pages. This method returns True if the specified Content instance has parent dependencies (i.e. it is in use).
...
bool DeleteContent(int[] contentIds)
Deletes the specified Content and ContentFolder instances, as well as any associated files, in both the database and persistent storage. This method returns True only if the operation was completely successful. None of the affected instances can be in use by any Presentation, Dynamic Playlist, Web Page, or Device Webpage. In these cases a descriptive error will be returned to the client.
...