Web Vuser Functions (WEB) > Alphabetical List of Web Vuser Functions > web_stream_open

web_stream_open

Opens a media stream.

C Language

int web_stream_open( "ID=<string>", "URL=<url>", "Protocol=<protocol>" , ["Bandwidth=<n>",] ["StreamBufferingTimeout=<seconds>",] ["EventReportCB =<name of function>,] LAST );

Example Stream Functions

Argument Description
ID The StreamID to be used in other actions on the stream. The ID is created with this function call. An integer greater than 0.
URL The full absolute address of the media.
Protocol The communications protocol. One of HTTP or HLS.
EventReportCB

See Web Stream Event Callback

The name of a user-coded callback function to report events.
Bandwidth The expected bandwidth. If 0, the Runtime Setting is used.
StreamBufferingTimeout

The timeout in seconds from the beginning of the download until it is possible to begin play. If timed out, the web_stream_play call is aborted with a failed status.

This argument overrides the run-time setting Streaming > Time out for video buffering.

DumpPath Path for downloading streaming file.
LAST Required marker for the end of the argument list.

Return Values

This function returns LR_PASS (0) on success, and LR_FAIL (1) on failure.

Parameterization

Standard parameterization is not available for this function.

General Information

The web_stream_open function opens a media stream.

The event report callback is invoked zero or more times when events occur.

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

Example

This is an example of a web streaming script:

Action()

{

      /**

      HTML5 Video

      /*/

      web_stream_open("ID=1", "URL=http://my_server/streaming-test/Video2/Class%20-%206.mp4","StreamBufferingTimeout=38", "Protocol=HTTP", LAST);

      web_stream_set_param_double("1",SPEED, 2.0);

      web_stream_set_param_int("1", BANDWIDTH, 2000000);

      web_stream_set_param_int("1", BUFFERING_TIMEOUT, 60);

 

      web_stream_get_state_string("1", SERVER_IP, "ServerIP");

      lr_output_message("IP:, %s",lr_eval_string("{ServerIP}"));

      lr_output_message("Movie Length : %lf",web_stream_get_param_double("1", Duration));

 

      /***

      Play a video. Seek forward,seek backward, seek from the begining, pause, and stop.

      **/

      //Play for 30 sec

 

      lr_think_time(15);

      lr_start_transaction("HTTP Stream");

 

      web_stream_play("ID=1", "PlayingDuration=30", "Speed=1.5", LAST);

      lr_vuser_status_message("Current time in movie:%lf", web_stream_get_param_double("1", CURRENT_TIME));

 

      web_stream_pause("ID=1","PausingDuration=20", LAST);

      lr_vuser_status_message("Current time in movie:%lf", web_stream_get_param_double("1", CURRENT_TIME));

 

      web_stream_play("ID=1", "PlayingDuration=10", LAST);

      lr_vuser_status_message("Current time in movie:%lf", web_stream_get_param_double("1", CURRENT_TIME));

 

      web_stream_seek("ID=1", "TimeOffset=11", LAST);

      lr_vuser_status_message("Current time in movie:%lf", web_stream_get_param_double("1", CURRENT_TIME));

 

      web_stream_play("ID=1", "PlayingDuration=10", LAST);

      lr_vuser_status_message("Current time in movie:%lf", web_stream_get_param_double("1", CURRENT_TIME));

 

      web_stream_seek("ID=1", "RelativeOffset=90", LAST);

      lr_vuser_status_message("Current time in movie:%lf", web_stream_get_param_double("1", CURRENT_TIME));

 

      web_stream_play("ID=1", "PlayingDuration=10", LAST);

      lr_vuser_status_message("Current time in movie:%lf", web_stream_get_param_double("1", CURRENT_TIME));

 

      web_stream_seek("ID=1", "RelativeOffset=-17", LAST);

      lr_vuser_status_message("Current time in movie:%lf", web_stream_get_param_double("1", CURRENT_TIME));

 

      web_stream_stop("ID=1", LAST);

 

      lr_end_transaction("HTTP Stream", LR_AUTO);

 

      web_stream_close("ID=1", LAST);

 

      return 0;

}