Share this page

# web.streamGetParamString

Gets the state of the stream and saves it in a parameter.

Example | Stream Functions

## Syntax

`web.streamGetParamString( streamID, stateType, parameterName );`

Argument | Description
--- | ---
streamID | The identifier passed to web.streamOpen.
stateType | One of: STREAM_URL (7) PROTOCOL (8) SERVER_IP (9)
parameterName | The parameter to store the state string.

## 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.streamGetParamString 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.streamGetParamString:

Copy code

    web.streamGetParamString("2", STREAM_URL, "StreamURL");
    web.streamGetParamString("2", PROTOCOL, "StreamProtocol");
    web.streamGetParamString("2", SERVER_IP, "ServerIP");
    lr.outputMessage("Url: , %s", lr.evalString("{StreamURL}"));
    lr.outputMessage("Protocol: , %s",lr.evalString("{StreamProtocol}"));
    lr.outputMessage("IP:, %s",lr.evalString("{ServerIP}"));

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: