web.streamWait

Suspends script execution during stream download until download condition reached.

ExampleStream Functions

Syntax

web.streamWait( {object} );

JavaScript Object

{  
   id:<string>,
   streamingDuration:<value>,
   percentage:<value>
}
Property Name Description
idThe identifier passed to web.streamOpen.
streamingDurationThe time to wait (seconds).
percentage

The position in the stream to wait for in percent. An integer from 0 -100.

Percentage value does not work for live streaming.

Return Values

Not applicable

Parameterization

Standard parameterization is not available for this function.

General Information

The web.streamWait function suspends play of a stream opened with web.streamOpen. When the specified wait condition is reached, the function returns.

Pass exactly one condition: either streamingDuration or percentage.

This function is not recorded. You can insert it manually into your script.

Example

The following example implements the basic streaming flow skeleton:

  1. Play the movie from the beginning (the entire movie duration is XXX).
    web.streamPlay( { id : n, playingDuration : XXX } );

  2. Pause the movie.
    web.streamPause( { id : n, pausingDuration : XXX } );

  3. Stop the movie.
    web.streamStop( { id : n } );

HTTP

Copy code
function Action()
{
    //Open an HTTP stream
    web.streamOpen(                    
    {                        id : 1,
                url : 'http://myhost/streaming-test/video/tiny.mp4',
                protocol : 'HTTP'                    
    }                
    );
    //Play for 10s
    web.streamPlay( { id : 1, playingDuration : 10 } );                
    //Pause for 5s
    web.streamPause( { id : 1, pausingDuration : 5 } );                
    //Seek to 00:00:20
    web.streamSeek( { id : 1, timeOffset : 20 } );
    //Change the speed to 1.5
    web.streamSetParamDouble('1',web.SPEED, 1.5);
    //Play for 10s
    web.streamPlay( { id : 1, playingDuration : 10 } );
    //Get bytes received 
    var bytes = web.streamGetParamInt('1',web.BYTES_RECEIVED);
    //Close streaming
    web.streamClose(                    
    {                        
    id : 1                    
    }                
    );               return 0;
}