web.streamGetParamString

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

ExampleStream Functions

Syntax

web.streamGetParamString( streamID, stateType, parameterName );

Argument Description
streamIDThe identifier passed to web.streamOpen.
stateType

One of:

  • STREAM_URL (7)
  • PROTOCOL (8)
  • SERVER_IP (9)
parameterNameThe 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}"));