Get Stream Information

Gets information about the specified stream.

Authorizations: Recordings - STREAM

Requests

GET /apis/streams/:streamId

Response

Success

Single Destination

For a single destination, the address and port are preserved (for backwards compatibility):

{ "data": {
    "address": "239.134.32.100",
    "port": 4900,
    "asset": "a907804b-d6d5-4328-9bd6-5aca9abbac8c",
    "username": "haiadmin",
    "id": "2ecc5663-06ee-44be-863a-2b32ef401c4d",
    "destinations": [{
      "trackId": 3,
      "address": "239.134.32.100",
      "port": 4900
    }]
  }
}

Multiple Destinations

For a stream with multiple destinations, address is set to multiple and port to 0.

{ "data": {
    "address": "multiple",
    "port": 0,
    "asset": "a907804b-d6d5-4328-9bd6-5aca9abbac8c",
    "username": "haiadmin",
    "id": "2ecc5663-06ee-44be-863a-2b32ef401c4d",
    "destinations": [{
      "trackId": 3,
      "address": "239.134.32.100",
      "port": 4900
    }, {
      "trackId": 4,
      "address": "239.134.32.101",
      "port": 4900
    }]
  }
}

Error

Code	Payload	Description
404	{"code":"040003", "name":"StreamNotFound", "message":"Stream not found", "httpStatusCode":404}	Stream with UUID `streamId` was not found.