Video Stream Subscriptions
- : Read any data from the organization down
You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.
The unique identifier of the organization
b1a23Record was added after this date/time. In UTC.
2018-08-16T02:10:48A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.
entityId,personIdA comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.
dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]The unique identifier of the fixture
009e9276-5c80-11e8-9c2d-fa7ae01bbebcWhere match start time (in UTC) >= this value
2018-08-16T18:00:00Don't display data fields with null values or empty structures
trueA comma separated list of resource types to include. See Resource Inclusion for more information.
organizations,fixtures,entitiesThe maximum number of records to return. See Pagination for more information.
10Example: 10The offset of the records. See Pagination for more information.
10Do not show data for completed matches and those older than 12 hours
trueThe unique identifier of the season
009e9276-5c80-11e8-9c2d-fa7ae01bbebcWhere match start time (in UTC) <= this value
2018-08-16T18:00:00Record was modified after this date/time. In UTC.
2018-08-16T02:11:48Successful operation
Error
You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.
The unique identifier of the organization
b1a23A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.
entityId,personIdA comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.
dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]Don't display data fields with null values or empty structures
trueA comma separated list of resource types to include. See Resource Inclusion for more information.
organizations,fixtures,entitiesThe unique identifier of the video stream subscription
009e9276-5c80-11e8-9c2d-fa7ae01bbebcCustomer of the subscription
1The unique identifier of the match
009e9276-5c80-11e8-9c2d-fa7ae01bbebcProvider of the input
MANUALThe locale of the video that matches the input
fr-FRPattern: ^[a-z]{2,2}-[A-Z]{2,2}$Unique identifier for the video source. This is unique for the provider/fixtureId/locale combination. Unless the provider is supplying multiple sources per fixture/locale then this is normally 1.
1Example: 1Type of video input
ADDITIONAL_ANGLEAdditional angleLOW_LATENCYLow LatencyPRIMARYPrimary
PRIMARYPossible values: The resolution that you want to receive the video in. This is only valid if outputFormat is RTMP. If outputFormat is not RTMP then the output resolution is the same as the input resolution. If specified the output resolution cannot be higher than the input resolution. You must have specific permission to chose anything other than 720p or 1080p.
10801920x10801080@50fps1920x1080 50fps1080i50@10MSRT 1080i50@10M1080p25@10MSRT 1080p25@10M1080p50@10MSRT 1080p50@10M1280x720@2000k1280x720@2000k1280x720@3000k1280x720@3000k1280x720@3000k25fps1280x720@3000k25fps1920x1080@4000k1920x1080@4000k1920x1080@4000k25fps1920x1080@4000k25fps1920x1080@4500k1920x1080@4500k1920x1080@5000k30fps1920x1080@5000k30fps20002000288512x288640x320@850k640x320@850k7201280x720DESKTOP_384x216@280kDESKTOP_384x216@280kDESKTOP_512x288@500kDESKTOP_512x288@500kDESKTOP_768x432@1000kDESKTOP_768x432@1000kMOBILE_320x180@102kMOBILE_320x180@102kMOBILE_320x180@102k_BUFFEREDMOBILE_320x180@102k_BUFFEREDMOBILE_320x180@232kMOBILE_320x180@232kMOBILE_320x180@232k_BUFFEREDMOBILE_320x180@232k_BUFFEREDMOBILE_480x270@464kMOBILE_480x270@464kMOBILE_480x270@464k_BUFFEREDMOBILE_480x270@464k_BUFFEREDMOBILE_768x432@1000kMOBILE_768x432@1000kMOBILE_768x432@1000k_BUFFEREDMOBILE_768x432@1000k_BUFFERED
1080Possible values: The output format
HLSHLS (HTTP Live Streaming)RTMPRTMP (Real-Time Messaging Protocol)RTMP_PULLRTMP Pull (Real-Time Messaging Protocol - Pull)SRTSRT (Secure Reliable Transport)
RTMPPossible values: The stream name/stream key of the RTMP destination. This is a unique/secret identifier provided by the stream destination platform - not a text description.
^[0-9A-Za-z.:/&_?=\-;@]*$The URL to send the output to. Only valid if outputFormat is 'RTMP' or 'SRT'
rtmp://a.rtmp.youtube.com/live2Pattern: ^[0-9A-Za-z.:/&_?=\-;@]*$Audio
AMBIENCEOnly ambience / crowd noiseBOTHBoth combinedBOTH_SPLIT_LRBoth (Ambience left channel, Commentary right channel)COMMENTARYOnly commentary
BOTHExample: COMMENTARYPossible values: Content of the stream
CLEANOutput signal is the same as the input signalPROGRAMScore overlays and other enhancements have been added to the stream
CLEANPossible values: The muxRate of the stream. Required for SRT outputFormat only.
1200000The name of the subscription
Successful operation
Error
Get a video stream subscription
- : Read any data from the organization down
You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.
The unique identifier of the organization
b1a23The unique identifier of the video stream subscription
009e9276-5c80-11e8-9c2d-fa7ae01bbebcA comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.
entityId,personIdA comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.
dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]Don't display data fields with null values or empty structures
trueA comma separated list of resource types to include. See Resource Inclusion for more information.
organizations,fixtures,entitiesThe maximum number of records to return. See Pagination for more information.
10Example: 10The offset of the records. See Pagination for more information.
10Successful operation
Error
You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.
The unique identifier of the organization
b1a23The unique identifier of the video stream subscription
009e9276-5c80-11e8-9c2d-fa7ae01bbebcA comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.
entityId,personIdA comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.
dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]Force a delete command to run and delete child records as well if there are existing records depending on the record.
trueDon't display data fields with null values or empty structures
trueA comma separated list of resource types to include. See Resource Inclusion for more information.
organizations,fixtures,entitiesCustomer of the subscription
1The unique identifier of the match
009e9276-5c80-11e8-9c2d-fa7ae01bbebcProvider of the input
MANUALThe locale of the video that matches the input
fr-FRPattern: ^[a-z]{2,2}-[A-Z]{2,2}$Unique identifier for the video source. This is unique for the provider/fixtureId/locale combination. Unless the provider is supplying multiple sources per fixture/locale then this is normally 1.
1Example: 1Type of video input
ADDITIONAL_ANGLEAdditional angleLOW_LATENCYLow LatencyPRIMARYPrimary
PRIMARYPossible values: The resolution that you want to receive the video in. This is only valid if outputFormat is RTMP. If outputFormat is not RTMP then the output resolution is the same as the input resolution. If specified the output resolution cannot be higher than the input resolution. You must have specific permission to chose anything other than 720p or 1080p.
10801920x10801080@50fps1920x1080 50fps1080i50@10MSRT 1080i50@10M1080p25@10MSRT 1080p25@10M1080p50@10MSRT 1080p50@10M1280x720@2000k1280x720@2000k1280x720@3000k1280x720@3000k1280x720@3000k25fps1280x720@3000k25fps1920x1080@4000k1920x1080@4000k1920x1080@4000k25fps1920x1080@4000k25fps1920x1080@4500k1920x1080@4500k1920x1080@5000k30fps1920x1080@5000k30fps20002000288512x288640x320@850k640x320@850k7201280x720DESKTOP_384x216@280kDESKTOP_384x216@280kDESKTOP_512x288@500kDESKTOP_512x288@500kDESKTOP_768x432@1000kDESKTOP_768x432@1000kMOBILE_320x180@102kMOBILE_320x180@102kMOBILE_320x180@102k_BUFFEREDMOBILE_320x180@102k_BUFFEREDMOBILE_320x180@232kMOBILE_320x180@232kMOBILE_320x180@232k_BUFFEREDMOBILE_320x180@232k_BUFFEREDMOBILE_480x270@464kMOBILE_480x270@464kMOBILE_480x270@464k_BUFFEREDMOBILE_480x270@464k_BUFFEREDMOBILE_768x432@1000kMOBILE_768x432@1000kMOBILE_768x432@1000k_BUFFEREDMOBILE_768x432@1000k_BUFFERED
1080Possible values: The output format
HLSHLS (HTTP Live Streaming)RTMPRTMP (Real-Time Messaging Protocol)RTMP_PULLRTMP Pull (Real-Time Messaging Protocol - Pull)SRTSRT (Secure Reliable Transport)
RTMPPossible values: The stream name/stream key of the RTMP destination. This is a unique/secret identifier provided by the stream destination platform - not a text description.
^[0-9A-Za-z.:/&_?=\-;@]*$The URL to send the output to. Only valid if outputFormat is 'RTMP' or 'SRT'
rtmp://a.rtmp.youtube.com/live2Pattern: ^[0-9A-Za-z.:/&_?=\-;@]*$Audio
AMBIENCEOnly ambience / crowd noiseBOTHBoth combinedBOTH_SPLIT_LRBoth (Ambience left channel, Commentary right channel)COMMENTARYOnly commentary
BOTHExample: COMMENTARYPossible values: Content of the stream
CLEANOutput signal is the same as the input signalPROGRAMScore overlays and other enhancements have been added to the stream
CLEANPossible values: The muxRate of the stream. Required for SRT outputFormat only.
1200000The name of the subscription
Successful operation
Error
Delete a video stream subscription
You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.
The unique identifier of the organization
b1a23The unique identifier of the video stream subscription
009e9276-5c80-11e8-9c2d-fa7ae01bbebcA comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.
entityId,personIdA comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.
dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]Force a delete command to run and delete child records as well if there are existing records depending on the record.
trueDon't display data fields with null values or empty structures
trueA comma separated list of resource types to include. See Resource Inclusion for more information.
organizations,fixtures,entitiesSuccessful operation
Error
Last updated
Was this helpful?