web.streamPlay

Starts playing a media stream.

Example Stream Functions

Syntax

web.streamPlay( {object} );

JavaScript Object

{  
   id:<string>,
   playingDuration:<value>,
   speed: <value>
}
Property Name Description
id The identifier passed to web.streamOpen.
playingDuration The length of time to play in seconds. If not passed, the entire stream is played.
If the play time is longer than the step download timeout in the run-time settings, the step fails.
speed The play speed in multiples of the normal rate (1). The supported multiples are 0.5, 1.0, 1.5, and 2.0. Default = 1

Return Values

Not applicable

Parameterization

Standard parameterization is not available for this function.

General Information

The web.streamPlay starts playing a media stream.

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

Example

This is an example of a web streaming script:

The following examples implement the basic streaming flow skeleton:Play the movie from the beginning (the entire movie duration is XXX).
web.streamPlay( { id : n, playingDuration : XXX } );Pause the movie.
web.streamPause( { id : n, pausingDuration : XXX } );Stop the movie.
web.streamStop( { id : n } ); HTTPfunction 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;