RTPBridge

Api provided by RTFlowManager App

RTFlowManager

RTFlowManager API — Documentation

Overview

This documentation describes the use of RTFlowManager. These APIs can be used exclusively via the RTFlowManager Android app.
In RTFlowManager, a "Flow" represents a unidirectional RTP communication channel.
First, if you need to use RTFlowManager, remember to configure in "Settings" the URL and port of the Bridge you intend to use. After that, you can use the other sections of the app.

Base URL{{"Il tuo IP Bridge in Ascolto"}}
PortHTTPS Port
settings.RTFlow
Replace {{"Il tuo IP Bridge in Ascolto"}} with the actual RTPBridge IP host.
Replace {{"Port"}} with the actual RTPBridge HTTPS number port.

GETFlow List for a session

The "Bridge List by Session" section is useful for reviewing all Flows within a specific session. The session is defined when the Flow is created, and multiple users can use the same session name.
It is also useful for retrieving the Flow ID.

sessionName.RTFlow
Parameter Description
Session NameName identifying a session on the Bridge.

GET Flow detail

Return the list of flow details Flow for your Flow id.

flowDetails.RTFlow
ParameterDescription
Id FlowRTP flow identifier.

POST Create RTP flow

Creates a new RTP flow for the specified session.

flowCreate.RTFlow
ParameterDescription
session nameRTP session name.
IP BridgeYour RTP Bridge IP.
IP Bridge PortYour RTP Bridge Port.
IP TargetYour RTP Target IP for your new flow.
IP Target PortYour RTP Target number Port for your new flow.
SDP content fileOptional: Your RTP SDP file to play your flow content in target.

POST Run monitor

Each RTPBridge node have a monitor to manages and run the flows.

runMonitor.RTFlow
ParameterDescription
work dirMonitor working dir on node.

PUT Update RTP flux

Prepare your flow to going it in run.

flowUpdate.RTFlow
ParameterDescription
Id FlowRTP flow identifier.

DELETE Remove RTP flux

Remove a flow on the RTP Bridge system node.

flowRemove.RTFlow
ParameterDescription
Id FlowRTP flow identifier.

GET Get SDP

You may be see your sdp content rely to yuor flow. And store this on your device.

sdpfile.RTFlow
ParameterDescription
Id FlowRTP flow identifier.