About Pixellot

Events

1. Endpoints

2. CMS synchronization

You still have full control over the event data via API, the “lock” icon simply means that some of the fields are not editable in CMS. 

If you decide to make an edit, API will return the updated data. Use the “copy” button in the “ID” table column to copy event’s ID to clipboard.

Note: CMS uses a separate event identification database, meaning that the event’s ID in API will be different than in the address bar:

1. {"jse_shortmsg":"","jse_info":{},"message":"cant change startDate once the automation had been started","body":{"code":"InvalidContent","message":"cant change startDate once the automation had been started"}}

Example:

You can stop an event about 2-3 minutes before it should've ended by itself.  For example, if the current time is 15:33, and you want to modify an event which is supposed to end at 15:35, the request can fail.

As of API v1.28.11, you can create events with the following game types:

• “game” - 2 teams

• “training” - 1 team

• “other” - no teams

To specify the type, use the “gameType” field.

Example payload - training event:

1. {
       "eventName": "Practice Event",
       "start$date": "{{start_date}}",
       "end$date": "{{end_date}}",
       "venue": {"_id": "{{venue_id}}"},
       "scoreboardData": {"homeTeam": "Home", "enable": true},
       "permission": "club",
       "productionType": "soccer",
       "gameType": "training"
   }

1. {"jse_shortmsg":"","jse_info":{},"message":"publicIp","body":{"code":"InvalidContent","message":"publicIp"},"restCode":"InvalidContent"}

Example payload - RTMP stream:

1. { "streamTargets":{ "hd":[ { "name":"RTMP", // max 50 characters, unique in event scope "streamType":"rtmp", "host":"p.ep522507.i.rtmpstream.net", // where to forward to "port":"1935", "application":"EntryPoint", "destinationStream":"rtmp", "sourceStream":"hd", "userName":"368709", // optional "password":"aE9236" // optional } ] } }

Example payload - Facebook stream:

1. { "streamTargets":{ "hd":[ { "name":"Facebook", "streamType":"rtmp", "host":"live-api-a.facebook.com", "port":"80", "application":"rtmp", "destinationStream":"test", "sourceStream":"hd" } ] } }

Example payload - SRT stream:

1. { "streamTargets":{ "hd":[ { "name":"SRT Push", "streamType":"srt-push", "host":"134.122.79.116", "port":"4200", "application":"live", "destinationStream":"hd", "sourceStream":"hd" } ] } }

Resulting event in CMS by having 3 forwardings for the HD stream:

• Only using the POST /events/:id/streamTargets API - https://app.swaggerhub.com/apis/Pixellot/partner_api/1.28.11#/default/addAdHocStreamTarget

• Example payload:
  

1. "bettingForwardingType": "None",
   "type": "betting"

7. Streaming settings

1. streamsConfig

Note that this setting may conflict with the tenant’s streaming settings, which are still the primary source of what should happen when running an event. For example, "streamsConfig" cannot be used alongside with tenant's "disableLiveStreams" setting.

Current streaming settings can be clarified with your account manager. Example of streaming settings:

In this example, HD stream will exists in both Live & VOD stages of the event, while Pano will not.

8. Graphics

8.1  Scoreboard

To start using the scoreboard APIs, venue needs to have a proper setup done in the VPU, for example:

9. Event types

There are several variations of event lifecycle that are related to how the video stream is behaving

9.1 Betting

Low-latency feed can be achieved by providing the following payload during event creation. To create a Betting event, add "type":"betting" to your event creation payload.

See the Section 6.3 “Betting” in this document for more information.

9.2 Tournament

Tournament event type is an event that can last up to 16 hours.

A Tournament event will stream live (to your chosen streaming service) but will not have cloud recording. In CMS, event will not stream, and you will be able to watch the event only when event is over and local recording was fully uploaded to VOD.

Tournament events require Stream Forwarding to fully work. Stream forwarding allows you to stream events to your own streaming service. Forwarding to multiple streaming services is supported.

To be able to create such an event, you need enable Tournament mode for your Club. If this option is not available in you club, please contact Pixellot support about adding the capability.

To create a Tournament type of event, add "type":"tournament" to your event creation payload:.

Note: StreamTargets can be added after event creation, by editing the event using the POST /events/{eventId}/streamTargets API - https://app.swaggerhub.com/apis/Pixellot/partner_api/1.28.8#/default/addAdHocStreamTarget

9.3 External content

This event type will be automatically assumed when creating an event for the external venue. Such venues are usually matching the following format: External-<number>-<Standard/Prime>, for example:

Follow the regular event creation procedure, set an ID of the external venue inside “venue._id” field:

1. { "eventName": "External Venue Test", "start$date": "{{start_date}}", "end$date": "{{end_date}}", "venue": { "_id": "{{externalVenueId}}" }, "scoreboardData": { "homeTeam": "Home", "awayTeam": "Guest", "enable": true }, "permission": "club", "productionType": "soccer" }

The “type” indication is added automatically, you don’t need to explicitly specify it as for Betting or Tournament events.

“externalStreamUrl” is the external content link that should be streamed to using RTMP protocol. This value can be also obtained from event’s page on CMS:

External content events contain a few fields specific to them in the GET /events or GET /events/:id responses:

1. "type": "externalContent", "externalStreamUrl": "rtmp://pxlt-....pixellot.stream:1935/live/0_hd_2000"