Live Events - List Get Stream Events

Get stream events of one live event
Get stream events telemetry of a live event.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/getStreamEvents?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

LiveEventGetStreamEventsResult

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 stream events 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/getStreamEvents?api-version=2022-11-01

Sample response

{
  "value": [
    {
      "eventType": "StreamEvent/BeginIngest",
      "eventTime": "2022-10-19T22:13:59.33Z",
      "eventLevel": "Information",
      "data": {
        "trackName": null,
        "streamId": null,
        "trackId": null,
        "mediaType": null,
        "bitrate": null,
        "mediaTimestamp": null,
        "timescale": null,
        "previousFragmentTimestamp": null,
        "previousFragmentDuration": null,
        "currentFragmentTimestamp": null,
        "fragmentOneTimestamp": null,
        "fragmentOneDuration": null,
        "fragmentTwoTimestamp": null,
        "fragmentTwoDuration": null,
        "fragmentDropReason": null,
        "discontinuityGap": null,
        "streamName": "myStream",
        "resultCode": "S_OK",
        "resultMessage": "{flashVer=Wirecast/FM 1.0 FMLE/3.0 (compatible; FMSc/1.0), cryptProtocol=TLS1.2}",
        "duration": null,
        "resolution": null,
        "minTime": null,
        "minTimeMediaType": null,
        "maxTime": null,
        "maxTimeMediaType": null,
        "timescaleOfMinTime": null,
        "timescaleOfMaxTime": null,
        "remoteIp": "131.107.8.xxx",
        "remotePort": "26919"
      }
    },
    {
      "eventType": "StreamEvent/FirstChunkReceived",
      "eventTime": "2022-10-19T22:14:04.45Z",
      "eventLevel": "Information",
      "data": {
        "trackName": "audio_128000",
        "streamId": null,
        "trackId": null,
        "mediaType": "audio",
        "bitrate": 128000,
        "mediaTimestamp": "1635238395",
        "timescale": "1000",
        "previousFragmentTimestamp": null,
        "previousFragmentDuration": null,
        "currentFragmentTimestamp": null,
        "fragmentOneTimestamp": null,
        "fragmentOneDuration": null,
        "fragmentTwoTimestamp": null,
        "fragmentTwoDuration": null,
        "fragmentDropReason": null,
        "discontinuityGap": null,
        "streamName": null,
        "resultCode": "S_OK",
        "resultMessage": null,
        "duration": "2391",
        "resolution": null,
        "minTime": null,
        "minTimeMediaType": null,
        "maxTime": null,
        "maxTimeMediaType": null,
        "timescaleOfMinTime": null,
        "timescaleOfMaxTime": null,
        "remoteIp": "131.107.8.xxx",
        "remotePort": "26919"
      }
    },
    {
      "eventType": "StreamEvent/FirstChunkReceived",
      "eventTime": "2022-10-19T22:14:04.78Z",
      "eventLevel": "Information",
      "data": {
        "trackName": "video_2025000",
        "streamId": null,
        "trackId": null,
        "mediaType": "video",
        "bitrate": 2025000,
        "mediaTimestamp": "1635238372",
        "timescale": "1000",
        "previousFragmentTimestamp": null,
        "previousFragmentDuration": null,
        "currentFragmentTimestamp": null,
        "fragmentOneTimestamp": null,
        "fragmentOneDuration": null,
        "fragmentTwoTimestamp": null,
        "fragmentTwoDuration": null,
        "fragmentDropReason": null,
        "discontinuityGap": null,
        "streamName": null,
        "resultCode": "S_OK",
        "resultMessage": null,
        "duration": "2400",
        "resolution": "1280x720",
        "minTime": null,
        "minTimeMediaType": null,
        "maxTime": null,
        "maxTimeMediaType": null,
        "timescaleOfMinTime": null,
        "timescaleOfMaxTime": null,
        "remoteIp": "131.107.8.xxx",
        "remotePort": "26919"
      }
    },
    {
      "eventType": "StreamEvent/EndIngest",
      "eventTime": "2022-10-19T22:20:36.45Z",
      "eventLevel": "Information",
      "data": {
        "trackName": null,
        "streamId": null,
        "trackId": null,
        "mediaType": null,
        "bitrate": null,
        "mediaTimestamp": null,
        "timescale": null,
        "previousFragmentTimestamp": null,
        "previousFragmentDuration": null,
        "currentFragmentTimestamp": null,
        "fragmentOneTimestamp": null,
        "fragmentOneDuration": null,
        "fragmentTwoTimestamp": null,
        "fragmentTwoDuration": null,
        "fragmentDropReason": null,
        "discontinuityGap": null,
        "streamName": "myStream",
        "resultCode": "MPE_CLIENT_TERMINATED_SESSION",
        "resultMessage": "{connection=1, receivedBytes=104758568, acknowledgement=103917434}",
        "duration": null,
        "resolution": null,
        "minTime": null,
        "minTimeMediaType": null,
        "maxTime": null,
        "maxTimeMediaType": null,
        "timescaleOfMinTime": null,
        "timescaleOfMaxTime": null,
        "remoteIp": "131.107.8.xxx",
        "remotePort": "26919"
      }
    }
  ]
}
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

LiveEventGetStreamEventsResult

Get live event stream events result.

LiveEventStreamEvent

The live event stream event.

LiveEventStreamEventData

The live event stream event data.

LiveEventStreamEventLevel

Event level.

LiveEventStreamEventMaxTimeMediaType

The media type of the larger timestamp of two fragments compared.

LiveEventStreamEventMediaType

Type of the track.

LiveEventStreamEventMinTimeMediaType

The media type of the smaller timestamp of two fragments compared.

LiveEventStreamEventType

The type of the stream event. Format: StreamEvent/{eventType}

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.

LiveEventGetStreamEventsResult

Get live event stream events result.

Name Type Description
value

LiveEventStreamEvent[]

The result of the get live event stream events.

LiveEventStreamEvent

The live event stream event.

Name Type Description
data

LiveEventStreamEventData

Event data based on event type.

eventLevel

LiveEventStreamEventLevel

Event level.

eventTime

string

The time event raised.

eventType

LiveEventStreamEventType

The type of the stream event. Format: StreamEvent/{eventType}

LiveEventStreamEventData

The live event stream event data.

Name Type Description
bitrate

integer

Bitrate of the track.

currentFragmentTimestamp

string

Current fragment timestamp in timescale.

discontinuityGap

integer

Length of the discontinuity gap in timescale.

duration

string

Fragment duration.

fragmentDropReason

string

Reason the fragment was dropped.

fragmentOneDuration

string

Duration of first fragment used to make a comparison, in timescale.

fragmentOneTimestamp

string

Timestamp of first fragment used to make a comparison, in timescale.

fragmentTwoDuration

string

Duration of second fragment used to make a comparison, in timescale.

fragmentTwoTimestamp

string

Timestamp of second fragment used to make a comparison, in timescale.

maxTime

string

The larger timestamp of the two fragments compared.

maxTimeMediaType

LiveEventStreamEventMaxTimeMediaType

The media type of the larger timestamp of two fragments compared.

mediaTimestamp

string

Fragment timestamp in timescale.

mediaType

LiveEventStreamEventMediaType

Type of the track.

minTime

string

The smaller timestamp of the two fragments compared.

minTimeMediaType

LiveEventStreamEventMinTimeMediaType

The media type of the smaller timestamp of two fragments compared.

previousFragmentDuration

string

Previous fragment duration in timescale.

previousFragmentTimestamp

string

Previous fragment timestamp in timescale.

remoteIp

string

Truncated IP of the encoder.

remotePort

string

Port of the encoder.

resolution

string

Width x Height for video, null otherwise.

resultCode

string

Result code.

resultMessage

string

Result message.

streamId

string

Stream ID in the format "trackName_bitrate"

streamName

string

Identifier of the stream or connection. Encoder or customer is responsible to add this ID in the ingest URL.

timescale

string

Timescale in which timestamps are expressed.

timescaleOfMaxTime

string

Timescale of the fragment with the larger timestamp.

timescaleOfMinTime

string

Timescale of the fragment with the smaller timestamp.

trackId

integer

Track index.

trackName

string

Name of the track.

LiveEventStreamEventLevel

Event level.

Name Type Description
Critical

string

Error

string

Information

string

Warning

string

LiveEventStreamEventMaxTimeMediaType

The media type of the larger timestamp of two fragments compared.

Name Type Description
Audio

string

Video

string

LiveEventStreamEventMediaType

Type of the track.

Name Type Description
audio

string

video

string

LiveEventStreamEventMinTimeMediaType

The media type of the smaller timestamp of two fragments compared.

Name Type Description
Audio

string

Video

string

LiveEventStreamEventType

The type of the stream event. Format: StreamEvent/{eventType}

Name Type Description
StreamEvent/BeginIngest

string

Ingest session begins.

StreamEvent/ChunkDropped

string

Fragment dropped.

StreamEvent/Discontinuity

string

Timestamp discontinuity detected.

StreamEvent/EndIngest

string

Ingest session ends.

StreamEvent/FirstChunkReceived

string

First fragment received on ingest media track.

StreamEvent/InvalidConnection

string

Ingest session denied.

StreamEvent/UnalignedKeyFrames

string

Unaligned video keyframes detected.

StreamEvent/UnalignedPresentation

string

Unaligned presentation detected, meaning two fragments across two quality levels are not time aligned.