Skip to Content

TwentyThree

TwentyThree™ API

API Method: /api/livevent/stream/list

Get a list of live events video streams.

Parameters

ParameterDescription
liveevent_stream_id Limit to a single live event video stream.
liveevent_id Filter to streams coupled to a single live event.
token List details about an in active or private events or video stream by including a private token.
Note: This token may be either the token matched to liveevent_id or the one matched to liveevent_stream_id. In either case, the relevant parameter must also be included in the request.
featured_p Filter between streams from featured or un-featured live events.
include_inactive_p Include streams marked at in-active in the list. Requires read privileges or a relavant token.
include_invisible_liveevents_p Include streams from private/invisible live events. Requires read privileges or a relevant token.
ordering Sort the returned list of streams.
Default: name
Valid values: sortkey, name, active_p, creation_date
p Page offset for the request. See [pagination](index#pagination) for details.
size Number of objects to include in the response. See [pagination](index#pagination) for details.

Permission level

The minimum required permission level is:

anonymous

To list inactive live streams, to list any stream from an invisible/private live event, or to retrieve publish_server, publish_server, active_p and token the requirement is:

read

Example XML Response

<response status="ok" permission_level="anonymous" p="1" size="20" 
  total_count="1" cached="1" cache_time="1311777832">
  <stream liveevent_stream_id="888331" liveevent_id="888330" 
   name="My stream" recording_p="0" publish_recordings_p="1" 
   live_viewers="0" rtmp_url="/stream/888331/c9cb6643cb91554dc54afd7d247bfc90/rtmp" 
   rtmp_stream="rtmp://server.com/stream.mp4" 
   creation_date="2011-06-27 13:09:47.121217+00" 
   updated_date="2011-06-27 13:09:47.121217+00"/>
</response>

Example JSON Response

{
  "status": "ok", 
  "permission_level":"anonymous",
  "cached":"1",
  "cache_time":"1311777948",
  "streams":[
    {"liveevent_stream_id": "888331", "liveevent_id": "888330", "name": "My stream", 
     "recording_p": 0, "publish_recordings_p": 1, "live_viewers": "0", 
     "rtmp_url": "/stream/888331/c9cb6643cb91554dc54afd7d247bfc90/rtmp", 
     "rtmp_stream": "rtmp://server.com/stream.mp4", 
     "creation_date": "2011-06-27 13:09:47.121217+00", 
     "updated_date": "2011-06-27 13:09:47.121217+00"
    }
  ],
  "p": "1",
  "size": "20",
  "total_count": "1",
  "site": { ... },
  "endpoint": "/api/liveevent/stream/list"
}