VideoTileProvider

Inherits TileProvider

Renders a video on the globe.

The video can either be played back based on a given simulation time (PlaybackMode MapToSimulationTime) or through the user interface (for PlaybackMode RealTimeLoop). It is also possible to control whether the video should loop or just be played once.

Note that, unless playback is mapped to simulation time, the video must be started manually via the user interface.

Members

Name	Documentation	Type	Description	Optional
Video	The video file that is played.	File	Value of type ‘File’	No
EndTime	The date and time that the video should end in the format ‘YYYY MM DD hh:mm:ss’.	Date and time	Value of type ‘Date and time’	Yes
LoopVideo	If checked, the video is continues playing from the start when it reaches the end of the video.	Boolean	Value of type ‘Boolean’	Yes
PlayAudio	Decides whether to play audio when playing back the video.	Boolean	Value of type ‘Boolean’	Yes
PlaybackMode	The mode of how the video is played back. The Default is RealTimeLoop, which means that the video is played in realtime using the Play command in the user interface.	String	In list { MapToSimulationTime, RealTimeLoop }	Yes
PlayDelay	The delay, in milliseconds, that the system will wait before issuing the play command. A higher value will increase the time it takes for the video to start but may result in a more synchronized playback start.	Integer	Value of type ‘Integer’	Yes
StartTime	The date and time that the video should start in the format ‘YYYY MM DD hh:mm:ss’.	Date and time	Value of type ‘Date and time’	Yes

Asset Examples

Basic

Adds a video as a layer on a globe, in this case Earth.

local earthAsset = asset.require("scene/solarsystem/planets/earth/globe")

-- The video file is here downloaded from a URL. This code returns the path to a folder
-- where the file is stored after download
local data = asset.resource({
  Name = "Example Video",
  Type = "UrlSynchronization",
  Identifier = "example_video",
  Url = "https://liu-se.cdn.openspaceproject.com/files/examples/video/chlorophyll_model_2048.mp4"
})

-- For a local file, use "asset.resource("path/to/local/video.mp4")" here instead
local video = data .. "chlorophyll_model_2048.mp4"

local Layer = {
  Name = "VideoLayer Example",
  Type = "VideoTileProvider",
  Identifier = "VideoLayer_Example",
  Enabled = true,
  Video = video
}


asset.onInitialize(function()
  openspace.globebrowsing.addLayer(earthAsset.Earth.Identifier, "ColorLayers", Layer)
end)

asset.onDeinitialize(function()
  openspace.globebrowsing.deleteLayer(earthAsset.Earth.Identifier, "ColorLayers", Layer)
end)

Mapped to Time

Adds a video as a layer on a globe (Earth) where the video playback is mapped to the simulation time. In this case, the video will play from 20:00 to 21:00 on January 29, 2023 in the simulation.

local earthAsset = asset.require("scene/solarsystem/planets/earth/globe")

-- The video file is here downloaded from a URL. This code returns the path to a folder
-- where the file is stored after download
local data = asset.resource({
  Name = "Example Video",
  Type = "UrlSynchronization",
  Identifier = "example_video",
  Url = "https://liu-se.cdn.openspaceproject.com/files/examples/video/chlorophyll_model_2048.mp4"
})

-- For a local file, use "asset.resource("path/to/local/video.mp4")" here instead
local video = data .. "chlorophyll_model_2048.mp4"

local Layer = {
  Name = "VideoLayer Example Mapped to Time",
  Type = "VideoTileProvider",
  Identifier = "VideoLayer_Example_MappedToTime",
  Enabled = true,
  Video = video,
  StartTime = "2023 01 29 20:00:00",
  EndTime = "2023 01 29 21:00:00",
  PlaybackMode = "MapToSimulationTime",
  Description = [[
    Video mapped to the simulation time in OpenSpace. The video will play from 20:00 to
    21:00 on January 29, 2023.
  ]]
}


asset.onInitialize(function()
  openspace.globebrowsing.addLayer(earthAsset.Earth.Identifier, "ColorLayers", Layer)
end)

asset.onDeinitialize(function()
  openspace.globebrowsing.deleteLayer(earthAsset.Earth.Identifier, "ColorLayers", Layer)
end)