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

web_stream_get_param_int

Return the state of the stream.

C Language

int web_stream_get_param_int( const char *StreamID, const int StateType );

Example Stream Functions

Argument Description
StreamID The identifier passed to web_stream_open.
StateType Either CURRENT_STATE or BYTES_RECEIVED.

Return Values

On failure, returns -1.

If StateType is BYTES_RECEIVED, returns the number of bytes.

If StateType is CURRENT_STATE, returns one of the following:

Status enum Value
STREAM_STATUS_INIT 0
STREAM_STATUS_START 1
STREAM_STATUS_RELOAD 2
STREAM_STATUS_BUFFERING 3
STREAM_STATUS_CLOSE 4
STREAM_STATUS_PLAY 5
STREAM_STATUS_PAUSE 6
STREAM_STATUS_SEEK 7
STREAM_STATUS_STOP 8
STREAM_STATUS_FAIL 9

Parameterization

Standard parameterization is not available for this function.

General Information

The web_stream_get_param_int function returns the state of the open stream.

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

Example

This is an example of a the use of web_stream_get_param_int:

int currentState, bytesRcved;

currentState = web_stream_get_param_int("1",CURRENT_STATE);
bytesRcved   = web_stream_get_param_int("1",BYTES_RECEIVED);