pgLoadFlashStream() Parameters

Help for using specific functions

pgLoadFlashStream() Parameters

Postby Clifton » Thu Jan 23, 2014 2:39 am

The parameters for this function are not documented in the popup help system.
PURPOSE OF FUNCTION:
Loads a video stream inside a Flash player shell. Uses the popular SMP (Strobe Media Playback) system.
(Tablets and handheld devices are not supported by this function.)
Here is a description of the parameters and their usage:
  1. tbObjName :: (required) name of ToolBook object in which the Flash video stream should be loaded. Name must be unique.
  2. loadDelay :: (optional integer) represents milliseconds to delay the loading of the stream. Defaults to 0 for no delay.
  3. source_url :: (required) File path (url) of video stream. (Supports http and rmtp streams.) File types supported are flv, f4v, mov (h.263), and mp4
  4. autoPlay :: (Boolean true/false) Default is false.
  5. loop :: (Boolean true/false) Default is false.
  6. notifyOnComplete :: (Boolean true/false) Default is false.
    If true, then [tbObjName] will receive a user event when the video has completed. The format of the [value] parameter is "video,[total length of video in seconds],ended"
  7. timeMarkers :: (string) comma-separated list/stack of integers in milliseconds wherein [tbObjName] should receive a user event. The format of the [value] parameter is "video,[timeMarker / 1000],time"
  8. showPlayButton :: (Boolean true/false) Default is false if [autoPlay] = true
  9. prePlayImg_url :: (string url) Image file to use for poster image before video play button is clicked. Image types supported are jpg (recommended), png, bmp.
  10. postPlayImg_url :: (string url) Image file to use AFTER stream has completed/ended. Supports same image types as in [prePlayImg_url].
  11. controlBarVisible :: (Boolean true/false) Default is true.
  12. controlBarAutoHide :: (Boolean true/false) Default is true and means the control bar will hide (fade out) after about 3 seconds of no mouse movement.
  13. scaleMode :: (string as "letterbox" or "stretch") Default is "stretch" and will force the video stream to fit in the area occupied by [tbObjName].
  14. initialVolume :: (integer 0-100)
  15. startTime :: (integer as seconds) Default is 0.
  16. endTime :: (integer as seconds) Default is unset and plays entire stream.
  17. useBufferingOverlay :: (Boolean true/false) Default is true and means a notification will appear over the video when buffering is occurring.
  18. showErrorDetails :: (Boolean true/false) Default is false and means only basic error messages will be displayed when the player encounters a problem.
Download working sample:
pgLoadFlashStream.zip
ToolBook v9.01 example
(32.95 KiB) Downloaded 104 times

You will need this archive of videos too (or modify the tbk above and use your own videos):
Clifton
Site Admin
 
Posts: 732
Joined: Tue Jan 14, 2014 1:04 am

Return to Function Help

Who is online

Users browsing this forum: No registered users and 1 guest