Live Events - List Get Track Ingest Heartbeats

Get track events of one live event
Get track ingest heartbeat events telemetry of a live event.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/getTrackIngestHeartbeats?api-version=2022-11-01

URI Parameters

Name In Required Type Description
accountName
path True

string

The Media Services account name.

liveEventName
path True

string

The name of the live event, maximum length is 32.

Regex pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$

resourceGroupName
path True

string

The name of the resource group within the Azure subscription.

subscriptionId
path True

string

The unique identifier for a Microsoft Azure subscription.

api-version
query True

string

The version of the API to be used with the client request.

Responses

Name Type Description
200 OK

LiveEventGetTrackIngestHeartbeatsResult

OK. The request has succeeded.

202 Accepted

Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations.

Headers

  • Location: string
  • Azure-AsyncOperation: string
Other Status Codes

Not Modified. The eTag in the request header is the same as the eTag in the storage container.

Other Status Codes

ErrorResponse

The streaming error response describing why the operation failed.

Examples

Get track ingest heart beats of a LiveEvent

Sample request

POST https://management.azure.com/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveEvents/myLiveEvent1/getTrackIngestHeartbeats?api-version=2022-11-01

Sample response

{
  "value": [
    {
      "eventType": "TrackEvent/IngestHeartbeat",
      "eventTime": "2022-10-19T22:14:52.33Z",
      "data": {
        "trackName": "audio",
        "trackType": "audio",
        "bitrate": 128000,
        "incomingBitrate": 63496,
        "lastTimestamp": "1635286785",
        "timescale": "1000",
        "overlapCount": 0,
        "discontinuityCount": 0,
        "nonincreasingCount": 0,
        "unexpectedBitrate": true,
        "state": "Running",
        "healthy": null,
        "lastFragmentArrivalTime": "2022-10-19T22:14:51.80Z",
        "ingestDriftValue": "-1",
        "transcriptionState": "",
        "transcriptionLanguage": ""
      }
    },
    {
      "eventType": "TrackEvent/IngestHeartbeat",
      "eventTime": "2022-10-19T22:14:52.11Z",
      "data": {
        "trackName": "video",
        "trackType": "video",
        "bitrate": 2025000,
        "incomingBitrate": 1622016,
        "lastTimestamp": "1635286772",
        "timescale": "1000",
        "overlapCount": 0,
        "discontinuityCount": 0,
        "nonincreasingCount": 0,
        "unexpectedBitrate": null,
        "state": "Running",
        "healthy": true,
        "lastFragmentArrivalTime": "2022-10-19T22:14:51.80Z",
        "ingestDriftValue": "-1",
        "transcriptionState": "",
        "transcriptionLanguage": ""
      }
    },
    {
      "eventType": "TrackEvent/IngestHeartbeat",
      "eventTime": "2022-10-19T22:15:12.90Z",
      "data": {
        "trackName": "audio",
        "trackType": "audio",
        "bitrate": 128000,
        "incomingBitrate": 76705,
        "lastTimestamp": "1635306777",
        "timescale": "1000",
        "overlapCount": 0,
        "discontinuityCount": 0,
        "nonincreasingCount": 0,
        "unexpectedBitrate": null,
        "state": "Running",
        "healthy": true,
        "lastFragmentArrivalTime": "2022-10-19T22:15:11.77Z",
        "ingestDriftValue": "0",
        "transcriptionState": "",
        "transcriptionLanguage": ""
      }
    },
    {
      "eventType": "TrackEvent/IngestHeartbeat",
      "eventTime": "2022-10-19T22:15:12.88Z",
      "data": {
        "trackName": "video",
        "trackType": "video",
        "bitrate": 2025000,
        "incomingBitrate": 1959936,
        "lastTimestamp": "1635306772",
        "timescale": "1000",
        "overlapCount": 0,
        "discontinuityCount": 0,
        "nonincreasingCount": 0,
        "unexpectedBitrate": null,
        "state": "Running",
        "healthy": true,
        "lastFragmentArrivalTime": "2022-10-19T22:15:11.77Z",
        "ingestDriftValue": "0",
        "transcriptionState": "",
        "transcriptionLanguage": ""
      }
    },
    {
      "eventType": "TrackEvent/IngestHeartbeat",
      "eventTime": "2022-10-19T22:15:32.77Z",
      "data": {
        "trackName": "audio",
        "trackType": "audio",
        "bitrate": 128000,
        "incomingBitrate": 76736,
        "lastTimestamp": "1635326793",
        "timescale": "1000",
        "overlapCount": 0,
        "discontinuityCount": 0,
        "nonincreasingCount": 0,
        "unexpectedBitrate": null,
        "state": "Running",
        "healthy": true,
        "lastFragmentArrivalTime": "2022-10-19T22:15:31.76Z",
        "ingestDriftValue": "0",
        "transcriptionState": "",
        "transcriptionLanguage": ""
      }
    }
  ]
}
azure-asyncoperation: https://management.azure.com/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveeventoperations/62e4d893-d233-4005-988e-a428d9f77076?api-version=2022-11-01
location: https://management.azure.com/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1/operationlocations/62e4d893-d233-4005-988e-a428d9f77076?api-version=2022-11-01

Definitions

Name Description
ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

LiveEventGetTrackIngestHeartbeatsResult

Get live event track ingest heart beats result.

LiveEventTrackEvent

The live event track event.

LiveEventTrackEventData

The live event track ingest heart beat event data.

LiveEventTrackEventTrackType

Type of the track.

LiveEventTrackEventType

The type of the track event.

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.

ErrorDetail

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

ErrorDetail[]

The error details.

message

string

The error message.

target

string

The error target.

ErrorResponse

Error response

Name Type Description
error

ErrorDetail

The error object.

LiveEventGetTrackIngestHeartbeatsResult

Get live event track ingest heart beats result.

Name Type Description
value

LiveEventTrackEvent[]

The result of the get live event track events.

LiveEventTrackEvent

The live event track event.

Name Type Description
data

LiveEventTrackEventData

Event data.

eventTime

string

The time event raised.

eventType

LiveEventTrackEventType

The type of the track event.

LiveEventTrackEventData

The live event track ingest heart beat event data.

Name Type Description
bitrate

integer

Bitrate of the track.

discontinuityCount

integer

Number of discontinuities detected in the last 20 seconds.

healthy

boolean

Indicates whether ingest is healthy.

incomingBitrate

integer

Calculated bitrate based on data chunks coming from encoder.

ingestDriftValue

string

Indicates the speed of delay, in seconds-per-minute, of the incoming audio or video data during the last minute. The value is greater than zero if data is arriving to the live event slower than expected in the last minute; zero if data arrived with no delay; and "n/a" if no audio or video data was received. For example, if you have a contribution encoder sending in live content, and it is slowing down due to processing issues, or network latency, it may be only able to deliver a total of 58 seconds of audio or video in a one-minute period. This would be reported as two seconds-per-minute of drift. If the encoder is able to catch up and send all 60 seconds or more of data every minute, you will see this value reported as 0. If there was a disconnection or discontinuity from the encoder, this value may still display as 0, as it does not account for breaks in the data - only data that is delayed in timestamps.

lastFragmentArrivalTime

string

The last timestamp in UTC that a fragment arrived at the ingest endpoint.

lastTimestamp

string

Latest timestamp received for a track in last 20 seconds.

nonincreasingCount

integer

Number of data chunks with timestamps in the past that were received in last 20 seconds.

overlapCount

integer

Number of data chunks that had overlapped timestamps in last 20 seconds.

state

string

State of the live event.

timescale

string

Timescale in which timestamps are expressed.

trackName

string

Name of the track.

trackType

LiveEventTrackEventTrackType

Type of the track.

transcriptionLanguage

string

The language code (in BCP-47 format) of the transcription language. For example, "de-de" indicates German (Germany). The value is empty for the video track heartbeats, or when live transcription is turned off.

transcriptionState

string

This value is "On" for audio track heartbeats if live transcription is turned on, otherwise you will see an empty string. This state is only applicable to track type of "audio" for Live transcription. All other tracks will have an empty value.

unexpectedBitrate

boolean

If expected and actual bitrates differ by more than allowed limit in last 20 seconds.

LiveEventTrackEventTrackType

Type of the track.

Name Type Description
audio

string

video

string

LiveEventTrackEventType

The type of the track event.

Name Type Description
TrackEvent/IngestHeartbeat

string

Track heartbeat received.