web.streamGetParamInt

Returns the state of the stream.

ExampleStream Functions

Syntax

web.streamGetParamInt( streamID, stateType );

Argument Description
streamIDThe identifier passed to web.streamOpen.
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 enumValue
STREAM_STATUS_INIT 0
STREAM_STATUS_START1
STREAM_STATUS_RELOAD2
STREAM_STATUS_BUFFERING3
STREAM_STATUS_CLOSE4
STREAM_STATUS_PLAY5
STREAM_STATUS_PAUSE6
STREAM_STATUS_SEEK7
STREAM_STATUS_STOP8
STREAM_STATUS_FAIL9

Parameterization

Standard parameterization is not available for this function.

General Information

The web.streamGetParamInt 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 use of web.streamGetParamInt:

Copy code
int currentState, bytesRcved;
currentState = web.streamGetParamInt("1",CURRENT_STATE);
bytesRcved   = web.streamGetParamInt("1",BYTES_RECEIVED);