Remote Snapshot APIs
3 min
This section outlines management of remote snapshot images. To modify the remote snapshot settings on a player, use the UpdateDeviceRemoteSnapshotSettings() Device Management method.
DeviceScreenShot Structure
The DeviceScreenShot structure represents a single remote snapshot image of a presentation display. It has the following values:
- Id int:(read only) The identifier and primary key of the remote snapshot image.
- GroupName string:(read only) The name of the group entity that the player belonged to when it posted the remote snapshot image to the server. Note that this name can be different from the group entity to which the player currently belongs.
- PresentationName string:(read only) The name of the presentation entity that the player was running when it posted the remote snapshot image to the server.
- Timestamp DateTime:(read only) A UTC timestamp indicating when the player posted the remote snapshot image to the server.
- Width short: (read only) The width of the image (in pixels).
- Height short:(read only) The height of the image (in pixels).
- FilePath string:(read only) An external URL of the image file in the persistent storage.
- FileSize int:(read only) The size of the image file (in bytes)
Remote Snapshot Management Web Methods
PagedList<DeviceScreenShot> GetDeviceScreenShots(int deviceId, string marker, int pageSize)
Retrieves the next page of the DeviceScreenShot list, sorted by timestamp. This method will return no more items than the defined page size.
Required Permissions
Device: View Device Screenshots
Parameters
- deviceId int: The identifier and primary key of the device posting the requested screenshots. The method returns Null if a device instance with the specified identifier does not exist.
- marker string: The timestamp of the last DeviceScreenShot 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.