Lingo Dictionary > D-F > frameReady() |  |

frameReady()

Syntax

    frameReady(frameN)
    frameReady(frameN, frameZ)
    frameReady()
    frameReady(sprite whichFlashSprite, frameNumber)

Description

Function; determines whether a streaming movie is ready for display. If enough of a sprite has streamed into memory to render the frame (integer for frame number, string for label) specified in the `frameNumber` parameter, this function is `TRUE`; otherwise it is `FALSE`. For a Director movie, this function determines whether all the cast members for `frameN` (the number of the frame)`` are downloaded from the Internet and available locally.

This function is useful only when streaming a movie, range of frames, cast, or linked cast member. To activate streaming, set the Movie:Playback properties in the Modify menu to Use Media as Available or Show Placeholders.

For Director movies, projectors, and Shockwave movies:

| `frameReady (``frameN``)—`Determines whether the cast members for `frameN` are downloaded.
| `frameReady (``frameN, frameZ``)—`Determines whether the cast members for `frameN` through `frameZ` are downloaded.
| `frameReady()—`Determines if cast member used in any frame of the Score are downloaded.

When using this property to query whether the media of an internal cast member that resides in an externally linked cast is available on disk, the entire linked cast will be downloaded as a result.

For a demonstration of the `frameReady` function used with a Director movie, see the sample movie "Streaming Shockwave" in Director Help.

This function can be tested but not set.

Example

This statement determines whether the cast members for frame 20 are downloaded and ready to be viewed:

    on exitFrame
    	if frameReady(20) then
    		-- go to frame 20 if all the required
    		--castmembers are 				locally available
    		go to frame 20
    	else
    		-- resume animating loop while background
    		--is streaming
    		got to frame 1
    	end if
    end

Example

This frame script checks to see if frame 25 of a Flash movie sprite in channel 5 can be rendered. If it can't, the script keeps the playback head looping in the current frame of the Director movie. When frame 25 can be rendered, the script starts the movie and lets the playback head proceed to the next frame of the Director movie.

    on exitFrame
    	if the frameReady(sprite 5, 25) = FALSE then
    		go to the frame
    	else
    		play sprite 5
    	end if
    end

See also

`mediaReady`