Share this page

# web.streamPause

Pauses playing a media stream.

Example | Stream Functions

## Syntax

    web.streamPause( {object} );

## JavaScript Object

    {
       id:<string>,
       pausingDuration:<value>
    }

Property Name | Description
--- | ---
id | The identifier passed to web.streamOpen.
pausingDuration | How many seconds to pause.

## Return Values

Not applicable

## Parameterization

Standard parameterization is not available for this function.

## General Information

The web.streamPause function pauses playing a media stream. The position is not changed, so the next play starts where the media was when paused.

Downloading the stream continues in the background.

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;
    }

Tips to improve your search results... VuGen Function Reference Version 26.1-26.3 Function Reference 26.1-26.3 All View Local Help Center View Online Help Center Version: