Remote API AoIP

/x-pam/aoip

GET

Returns an array containing the details of all the AoIP sources that the PAM knows about

URI Parameters

• index: optional (integer) returns only the AoIP source with that index
• name: optional (string) returns any AoIP source that has the same name
• tags: optional (string, comma separated list of tags) returns only AoIP sources that have a one or more tags that match those passed.

HTTP Status Code: 200

Body: application/json

[
    {
        "SDP" - string, only shown if the AoIP source has a static SDP. Contains the SDP,
        "index" - integer the unique identifier of the source,
        "name" - string the human readable name of the source,
        "type" - string, either RTSP or SDP,
        "details" - string, only show if the type is RSTP. Shows the url to connect to for RTSP,
        "tags" - [array of strings, user defined tags to help describe the source]
    },...
}

PATCH

Updates the list of AoIP sources. You can "add" a new source, "delete" an existing one or "update" its details

Body: application/json

[
    addObj or updateObj or deleteObj,...
]

addObj is of the form

{
    "action" : "add",
    "name" : string - the name of the source,
    "type" : string, either SDP or RTSP,
    "SDP" : string, the SDP. Only required if type is "SDP",
    "details" : string the RTSP URL. Only required if type is "RTSP",
    "tags" : [optional array of strings]
}

updateObj is of the form

{
    "action" : "update",
    "index" : integer - the unique identifier of the source
    "name" : string - optional, the name of the source,
    "type" : string, optional, either SDP or RTSP,
    "SDP" : string - optional, the SDP. Only required if type is "SDP",
    "details" : string - optional, the RTSP URL. Only required if type is "RTSP",
    "tags" : [optional array of strings]
}

deleteObj is of the form

{
    "action" : "delete",
    "index" : integer - the unique identifier of the source
}