...
REST-method | Example of REST-query | Example of REST response | Response status | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
/pull/pull |
| 409 - Conflict 500 - Internal error | Pull the WebRTC RTMP stream at the specified URL | ||||||||
/pull/find_all |
| 200 – streams are found 500 - Internal error | Find all pulled WebRTC RTMP streams | ||||||||
/pull/terminate |
| 200 - stream terminated 500 - Internal error | Terminate the pulled WebRTC RTMP stream |
Parameters
Parameter name | Description | Example | ||||
|---|---|---|---|---|---|---|
uri | URL of the WebRTC RTMP stream | wssrtmp://demomyserver.flashphoner.com:8443com/live/myStream | ||||
| record | Is the pulled stream recording | true | ||||
localMediaSessionId | Session identifier | 5a072377-73c1-4caf-abd3 | remoteMediaSessionId | Session identifier on the remote server | 12345678-abcd-dead-beaf | |
localStreamName | Local name assigned to the captured stream. By this name the stream can be requested from the WCS server | testStreamstream1 | ||||
remoteStreamNamestatus | Captured stream name on the remote server | testStream | status | Current stream status | NEWCurrent stream status | PROCESSED_REMOTE |
| hasAudio | Stream has audio track | true | ||||
| hasVideo | Stream has video track | true |
Pulled stream publishing with a given name
Since build 5.2.724 it is possible to set the name to publish stream on server using localStreamName query parameter. If the parameter is not set, the stream name will be set to uri, as done in previous builds.
Configuration
In the /usr/local/FlashphonerWebCallServer/conf directory you can find the SDP description file for the RTMP agent rtmp_agent.sdp:
...