1. Packages
  2. Azure Native
  3. API Docs
  4. media
  5. getLiveEventTrackIngestHeartbeats
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi

azure-native.media.getLiveEventTrackIngestHeartbeats

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi

    Get track ingest heartbeat events telemetry of a live event. Azure REST API version: 2022-11-01.

    Using getLiveEventTrackIngestHeartbeats

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getLiveEventTrackIngestHeartbeats(args: GetLiveEventTrackIngestHeartbeatsArgs, opts?: InvokeOptions): Promise<GetLiveEventTrackIngestHeartbeatsResult>
    function getLiveEventTrackIngestHeartbeatsOutput(args: GetLiveEventTrackIngestHeartbeatsOutputArgs, opts?: InvokeOptions): Output<GetLiveEventTrackIngestHeartbeatsResult>
    def get_live_event_track_ingest_heartbeats(account_name: Optional[str] = None,
                                               live_event_name: Optional[str] = None,
                                               resource_group_name: Optional[str] = None,
                                               opts: Optional[InvokeOptions] = None) -> GetLiveEventTrackIngestHeartbeatsResult
    def get_live_event_track_ingest_heartbeats_output(account_name: Optional[pulumi.Input[str]] = None,
                                               live_event_name: Optional[pulumi.Input[str]] = None,
                                               resource_group_name: Optional[pulumi.Input[str]] = None,
                                               opts: Optional[InvokeOptions] = None) -> Output[GetLiveEventTrackIngestHeartbeatsResult]
    func GetLiveEventTrackIngestHeartbeats(ctx *Context, args *GetLiveEventTrackIngestHeartbeatsArgs, opts ...InvokeOption) (*GetLiveEventTrackIngestHeartbeatsResult, error)
    func GetLiveEventTrackIngestHeartbeatsOutput(ctx *Context, args *GetLiveEventTrackIngestHeartbeatsOutputArgs, opts ...InvokeOption) GetLiveEventTrackIngestHeartbeatsResultOutput

    > Note: This function is named GetLiveEventTrackIngestHeartbeats in the Go SDK.

    public static class GetLiveEventTrackIngestHeartbeats 
    {
        public static Task<GetLiveEventTrackIngestHeartbeatsResult> InvokeAsync(GetLiveEventTrackIngestHeartbeatsArgs args, InvokeOptions? opts = null)
        public static Output<GetLiveEventTrackIngestHeartbeatsResult> Invoke(GetLiveEventTrackIngestHeartbeatsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetLiveEventTrackIngestHeartbeatsResult> getLiveEventTrackIngestHeartbeats(GetLiveEventTrackIngestHeartbeatsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:media:getLiveEventTrackIngestHeartbeats
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountName string
    The Media Services account name.
    LiveEventName string
    The name of the live event, maximum length is 32.
    ResourceGroupName string
    The name of the resource group within the Azure subscription.
    AccountName string
    The Media Services account name.
    LiveEventName string
    The name of the live event, maximum length is 32.
    ResourceGroupName string
    The name of the resource group within the Azure subscription.
    accountName String
    The Media Services account name.
    liveEventName String
    The name of the live event, maximum length is 32.
    resourceGroupName String
    The name of the resource group within the Azure subscription.
    accountName string
    The Media Services account name.
    liveEventName string
    The name of the live event, maximum length is 32.
    resourceGroupName string
    The name of the resource group within the Azure subscription.
    account_name str
    The Media Services account name.
    live_event_name str
    The name of the live event, maximum length is 32.
    resource_group_name str
    The name of the resource group within the Azure subscription.
    accountName String
    The Media Services account name.
    liveEventName String
    The name of the live event, maximum length is 32.
    resourceGroupName String
    The name of the resource group within the Azure subscription.

    getLiveEventTrackIngestHeartbeats Result

    The following output properties are available:

    Value []LiveEventTrackEventResponse
    The result of the get live event track events.
    value List<LiveEventTrackEventResponse>
    The result of the get live event track events.
    value LiveEventTrackEventResponse[]
    The result of the get live event track events.
    value Sequence[LiveEventTrackEventResponse]
    The result of the get live event track events.
    value List<Property Map>
    The result of the get live event track events.

    Supporting Types

    LiveEventTrackEventDataResponse

    Bitrate double
    Bitrate of the track.
    DiscontinuityCount double
    Number of discontinuities detected in the last 20 seconds.
    Healthy bool
    Indicates whether ingest is healthy.
    IncomingBitrate double
    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 double
    Number of data chunks with timestamps in the past that were received in last 20 seconds.
    OverlapCount double
    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 string
    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 bool
    If expected and actual bitrates differ by more than allowed limit in last 20 seconds.
    Bitrate float64
    Bitrate of the track.
    DiscontinuityCount float64
    Number of discontinuities detected in the last 20 seconds.
    Healthy bool
    Indicates whether ingest is healthy.
    IncomingBitrate float64
    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 float64
    Number of data chunks with timestamps in the past that were received in last 20 seconds.
    OverlapCount float64
    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 string
    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 bool
    If expected and actual bitrates differ by more than allowed limit in last 20 seconds.
    bitrate Double
    Bitrate of the track.
    discontinuityCount Double
    Number of discontinuities detected in the last 20 seconds.
    healthy Boolean
    Indicates whether ingest is healthy.
    incomingBitrate Double
    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 Double
    Number of data chunks with timestamps in the past that were received in last 20 seconds.
    overlapCount Double
    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 String
    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.
    bitrate number
    Bitrate of the track.
    discontinuityCount number
    Number of discontinuities detected in the last 20 seconds.
    healthy boolean
    Indicates whether ingest is healthy.
    incomingBitrate number
    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 number
    Number of data chunks with timestamps in the past that were received in last 20 seconds.
    overlapCount number
    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 string
    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.
    bitrate float
    Bitrate of the track.
    discontinuity_count float
    Number of discontinuities detected in the last 20 seconds.
    healthy bool
    Indicates whether ingest is healthy.
    incoming_bitrate float
    Calculated bitrate based on data chunks coming from encoder.
    ingest_drift_value str
    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.
    last_fragment_arrival_time str
    The last timestamp in UTC that a fragment arrived at the ingest endpoint.
    last_timestamp str
    Latest timestamp received for a track in last 20 seconds.
    nonincreasing_count float
    Number of data chunks with timestamps in the past that were received in last 20 seconds.
    overlap_count float
    Number of data chunks that had overlapped timestamps in last 20 seconds.
    state str
    State of the live event.
    timescale str
    Timescale in which timestamps are expressed.
    track_name str
    Name of the track.
    track_type str
    Type of the track.
    transcription_language str
    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.
    transcription_state str
    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.
    unexpected_bitrate bool
    If expected and actual bitrates differ by more than allowed limit in last 20 seconds.
    bitrate Number
    Bitrate of the track.
    discontinuityCount Number
    Number of discontinuities detected in the last 20 seconds.
    healthy Boolean
    Indicates whether ingest is healthy.
    incomingBitrate Number
    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 Number
    Number of data chunks with timestamps in the past that were received in last 20 seconds.
    overlapCount Number
    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 String
    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.

    LiveEventTrackEventResponse

    Data Pulumi.AzureNative.Media.Inputs.LiveEventTrackEventDataResponse
    Event data.
    EventTime string
    The time event raised.
    EventType string
    The type of the track event.
    Data LiveEventTrackEventDataResponse
    Event data.
    EventTime string
    The time event raised.
    EventType string
    The type of the track event.
    data LiveEventTrackEventDataResponse
    Event data.
    eventTime String
    The time event raised.
    eventType String
    The type of the track event.
    data LiveEventTrackEventDataResponse
    Event data.
    eventTime string
    The time event raised.
    eventType string
    The type of the track event.
    data LiveEventTrackEventDataResponse
    Event data.
    event_time str
    The time event raised.
    event_type str
    The type of the track event.
    data Property Map
    Event data.
    eventTime String
    The time event raised.
    eventType String
    The type of the track event.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi