Play List Format - SOS Version 3.1.x
The play list is a Science On a Sphere construct for organizing and grouping together content for a presentation. Play lists are analogous to a play list on an MP3 player. Play lists are simple text files and are read and interpreted by the main SOS application interface.
Sample Play List With Descriptions
################ BEGIN PLAYLIST KEYWORDS ############################# # # Description of Keyword used in playlist of SOS # # # include = Include a play list snippet for a data set. # list snippet must contain only a single clip. Usually included # from the data directory where it resides. # # name = Name show on menu ( must specify ) # Name or label for the playlist entry. The name is used as text for the # play list item button on sos_stream_gui # # rename = Over ride "name =" # This is a way to over ride the "name=" from an included play list # # data = /path/to/data/directory ( must specify ) # For time series data, the /path needs to end in /path/P1, # if opengl = 1, then it must end in a ".jpg" or some other # image file name. # datadir = Depricated keyword. Replaced by the new keyword "data =" # # # background = path to a single frame of data # Specifies the path to a background image (e.g. such as a topography image). # Can be used in conjunction with "data=", where the "data=" specifies a time # sequence of cylindrical data files that have an alpha transparency channel # set (usually .png files). This gives a basic overlay capability. # # fps = frames per second ( 30 if not specified ) # How quickly the animation sequences through data frames. # # pip = /path/to/embeded/image # The pip, is an image or MPEG4 file that will appear in a picture # in a picture window on the sphere. The pip window appears based on # the values set by the other pip control keywords. Multiple pip's may # be specified # # piptimer = 10 # Length of time pip is displayed excluding fadein/fadeout (seconds) # Use a value of 0 for "duration of clip." # # pipdelay = 5 # Time delay before pip is displayed (seconds) # # pipwidth = 45 # Width in degrees of longitude # # pipheight = 45 # Height in degrees of longitude # # pipalpha = 0.8 # Opacity of pip over underlying image # # pipfadein = 1 # Length of time pip takes to fade in (seconds) # # pipfadeout = 2.5 # Length of time pip takes to fade out (seconds) # # pipvertical = -10 # Vertical position of pip center above equator (degrees) # # piphorizontal = 0 # Horizontal position of pip center east of projector # subpoint (degrees) # # slide = /path/to/slide/image # slide show image come via the 2nd port of Graphic Card to # side wall projector or big screen monitor. # # firstdwell = number in millisecond # lastdwell = number in millisecond # firstdwell and lastdwell. Specify time in milliseconds that # the animation will stop on the first and last frame. # Defaults to 0 milliseconds. # # startframe = [some frame number] ( default is 1 if not specified ) # Trim a long animation. If specified, the animation will only display frames # beginning at "startframe" and going through "endframe". # # endframe = [some frame number] (default is the last frame) # Trim a long animation. If specified, the animation will only display frames # beginning at "startframe" and going through "endframe". Endframe values can # be absolute frame numbers, or if they are negative, the frame number is relative # to the end of the animation. The endframe can also be the key value of "end" to # specify the end of the animation # # label = [default ( displays frame filename ) | /path/to/labels.txt ] # No labels will show, if not specified, otherwise the label file contains on line # per frame of that animation. This is usually used to specify a data/time stamp for # a frame sequence. Label files are ignored for singe texture clips. # # audio = /path/to/audio/file ( no audio if not specified ) # The audio file can be anything that Linux audio player "Mplayer" can decode. Examples of # valid audio file formats are: .mp3, .wav, .ogg, or .mp4 # # opengl = [true | 1 | 0] (Depricated keyword) # This keyword is no longer used and this capability is figured out dynamically based on the # value of "data=" # # skip = n (where n is the skip factor for a directory of files. # skip = 1 will skip every other file in a animation, # skip = 2 will play every third file, etc). # As skip gets bigger, total files animated over, goes down. # # tiltx = number of degrees of tilt in x-axis. # tiltx only works if the data specifies a cylindrical data set (either in # mp4 or an image sequence) # tilty = number of degrees of tilt in y-axis. # tilty only works if the data specifies a cylindrical data set (either in # mp4 or an image sequence) # tiltz = number of degrees of tilt in z-axis. # tiltz only works if the data specifies a cylindrical data set (either in # mp4 or an image sequence) # # zrotationenable = [0 | 1] # An SOS data set (time series data) can be rotated while the data is animating # through time. Only supports animating around the z-axis (generally the axis # that passes through the north and south poles. # Zrotation only works if the data specifies a cylindrical data set (either in # mp4 or an image sequence) # # zfps = frames per second (default 50) # Rate at which the zrotation feature animates. Only valid if zrotationenable is 1 # # zrotationangle = angle in degrees (.1 degrees by default) # Number of degrees of rotation for each time step during the zrotation. # Only valid if zrotationenable is 1 # # timer = number of seconds (180 sec if not specified ) # timer is used in "auto presentation mode only". # Specfies how long to play a presentation. # # labelColor = R, G, B, Alpha ( "White" if not specified ) # (also can use symbolic names: white, black, red, green, blue) # # labelposition = [ default | x,y (range from -1, -1 ~ 1, 1 ) ] # ( -0.3, -0.5 if not specified ) # # animate = [ 0 | 1 ] # (if 0, then don't immediately start animating when # item is loaded (must hit play). Otherwise, automatically # animate when playlist entry loads. In auto presentation mode, # always animate, even if animate = 0 # # category = "a string identifier" # Categorization of this data # # keywords = comma separated list of keywords # keywords to aid in searching # # publisher = a string identifier # The name of the person or organization who published this data # # creator = a string identifier # The name of the person or organization who created this data # # stopframe = (some frame number) # Stop animating when the animation reaches this frame number # ################ END PLAYLIST KEYWORDS ############################# # # name = Hot Topo (Wild Fires) creator = NOAA publisher = NOAA category = land keywords = land, topography, bathymetry, ngdc, etopo2 data = /sos/media/hot_1800/P1 audio = /shared/sos/media/audio/CoupeStudios/Music/Topography.mp3 fps = 30 name = IPCC GFDL TEMP data = /shared/sos/media/models/ipcc_temp/gfdl/gfdl_temp_change.mp4 fps = 30 zrotationangle=0.1 zrotationenable=1 zfps=30 label = default include = /shared/sos/media/oceans/chile_tsunami/playlist.sos fps=20 name = Test Overlay background = /shared/sos/bg/world.topo.bathy.200407.3x5400x2700.jpg data = /shared/sos/bg/pngdata animate = 1 fps = 15 name = January Blue Marble datadir = /shared/sos/render/gsfc/4kx2k/world2004013x4kx2k.jpg tiltx = 23.5 fps = 30 timer = 60 name = EarthLiteColor (23 degree tilt) datadir = /sos/media/textures/EarthLiteColor.jpg tiltx = 23.0 fps = 30